Fawkes API
Fawkes Development Version
|
Position2DTrackInterface Fawkes BlackBoard Interface. More...
#include <>>
Public Member Functions | |
virtual bool | message_valid (const Message *message) const |
Check if message is valid and can be enqueued. More... | |
float * | track_x_positions () const |
Get track_x_positions value. More... | |
float | track_x_positions (unsigned int index) const |
Get track_x_positions value at given index. More... | |
void | set_track_x_positions (unsigned int index, const float new_track_x_positions) |
Set track_x_positions value at given index. More... | |
void | set_track_x_positions (const float *new_track_x_positions) |
Set track_x_positions value. More... | |
size_t | maxlenof_track_x_positions () const |
Get maximum length of track_x_positions value. More... | |
float * | track_y_positions () const |
Get track_y_positions value. More... | |
float | track_y_positions (unsigned int index) const |
Get track_y_positions value at given index. More... | |
void | set_track_y_positions (unsigned int index, const float new_track_y_positions) |
Set track_y_positions value at given index. More... | |
void | set_track_y_positions (const float *new_track_y_positions) |
Set track_y_positions value. More... | |
size_t | maxlenof_track_y_positions () const |
Get maximum length of track_y_positions value. More... | |
int32_t * | track_timestamps () const |
Get track_timestamps value. More... | |
int32_t | track_timestamps (unsigned int index) const |
Get track_timestamps value at given index. More... | |
void | set_track_timestamps (unsigned int index, const int32_t new_track_timestamps) |
Set track_timestamps value at given index. More... | |
void | set_track_timestamps (const int32_t *new_track_timestamps) |
Set track_timestamps value. More... | |
size_t | maxlenof_track_timestamps () const |
Get maximum length of track_timestamps value. More... | |
bool | is_valid () const |
Get valid value. More... | |
void | set_valid (const bool new_valid) |
Set valid value. More... | |
size_t | maxlenof_valid () const |
Get maximum length of valid value. More... | |
uint32_t | length () const |
Get length value. More... | |
void | set_length (const uint32_t new_length) |
Set length value. More... | |
size_t | maxlenof_length () const |
Get maximum length of length value. More... | |
uint32_t | track_id () const |
Get track_id value. More... | |
void | set_track_id (const uint32_t new_track_id) |
Set track_id value. More... | |
size_t | maxlenof_track_id () const |
Get maximum length of track_id value. More... | |
virtual Message * | create_message (const char *type) const |
Create message based on type name. More... | |
virtual void | copy_values (const Interface *other) |
Copy values from other interface. More... | |
virtual const char * | enum_tostring (const char *enumtype, int val) const |
Convert arbitrary enum value to string. More... | |
![]() | |
virtual | ~Interface () |
Destructor. More... | |
bool | oftype (const char *interface_type) const |
Check if interface is of given type. More... | |
const void * | datachunk () const |
Get data chunk. More... | |
unsigned int | datasize () const |
Get data size. More... | |
const char * | type () const |
Get type of interface. More... | |
const char * | id () const |
Get identifier of interface. More... | |
const char * | uid () const |
Get unique identifier of interface. More... | |
unsigned short | serial () const |
Get instance serial of interface. More... | |
unsigned int | mem_serial () const |
Get memory serial of interface. More... | |
bool | operator== (Interface &comp) const |
Check equality of two interfaces. More... | |
const unsigned char * | hash () const |
Get interface hash. More... | |
size_t | hash_size () const |
Get size of interface hash. More... | |
const char * | hash_printable () const |
Get printable interface hash. More... | |
bool | is_writer () const |
Check if this is a writing instance. More... | |
void | set_validity (bool valid) |
Mark this interface invalid. More... | |
bool | is_valid () const |
Check validity of interface. More... | |
const char * | owner () const |
Get owner of interface. More... | |
void | set_from_chunk (void *chunk) |
Set from a raw data chunk. More... | |
void | resize_buffers (unsigned int num_buffers) |
Resize buffer array. More... | |
unsigned int | num_buffers () const |
Get number of buffers. More... | |
void | copy_shared_to_buffer (unsigned int buffer) |
Copy data from private memory to buffer. More... | |
void | copy_private_to_buffer (unsigned int buffer) |
Copy data from private memory to buffer. More... | |
void | read_from_buffer (unsigned int buffer) |
Copy data from buffer to private memory. More... | |
int | compare_buffers (unsigned int buffer) |
Compare buffer to private memory. More... | |
Time | buffer_timestamp (unsigned int buffer) |
Get time of a buffer. More... | |
void | buffer_timestamp (unsigned int buffer, Time *timestamp) |
Get time of a buffer. More... | |
void | read () |
Read from BlackBoard into local copy. More... | |
void | write () |
Write from local copy into BlackBoard memory. More... | |
bool | has_writer () const |
Check if there is a writer for the interface. More... | |
unsigned int | num_readers () const |
Get the number of readers. More... | |
std::string | writer () const |
Get owner name of writing interface instance. More... | |
std::list< std::string > | readers () const |
Get owner names of reading interface instances. More... | |
bool | changed () const |
Check if data has been changed. More... | |
const Time * | timestamp () const |
Get timestamp of last write. More... | |
void | set_auto_timestamping (bool enabled) |
Enable or disable automated timestamping. More... | |
void | set_timestamp (const Time *t=NULL) |
Set timestamp. More... | |
void | set_clock (Clock *clock) |
Set clock to use for timestamping. More... | |
void | mark_data_changed () |
Mark data as changed. More... | |
std::list< const char * > | get_message_types () |
Obtain a list of textual representations of the message types available for this interface. More... | |
unsigned int | msgq_enqueue (Message *message) |
Enqueue message at end of queue. More... | |
unsigned int | msgq_enqueue_copy (Message *message) |
Enqueue copy of message at end of queue. More... | |
void | msgq_remove (Message *message) |
Remove message from queue. More... | |
void | msgq_remove (unsigned int message_id) |
Remove message from queue. More... | |
unsigned int | msgq_size () |
Get size of message queue. More... | |
void | msgq_flush () |
Flush all messages. More... | |
void | msgq_lock () |
Lock message queue. More... | |
bool | msgq_try_lock () |
Try to lock message queue. More... | |
void | msgq_unlock () |
Unlock message queue. More... | |
void | msgq_pop () |
Erase first message from queue. More... | |
Message * | msgq_first () |
Get the first message from the message queue. More... | |
bool | msgq_empty () |
Check if queue is empty. More... | |
void | msgq_append (Message *message) |
Enqueue message. More... | |
template<class MessageType > | |
bool | msgq_first_is () |
Check if first message has desired type. More... | |
template<class MessageType > | |
MessageType * | msgq_first () |
Get first message casted to the desired type. More... | |
template<class MessageType > | |
MessageType * | msgq_first (MessageType *&msg) |
Get first message casted to the desired type. More... | |
template<class MessageType > | |
MessageType * | msgq_first_safe (MessageType *&msg) throw () |
Get first message casted to the desired type without exceptions. More... | |
MessageQueue::MessageIterator | msgq_begin () |
Get start iterator for message queue. More... | |
MessageQueue::MessageIterator | msgq_end () |
Get end iterator for message queue. More... | |
InterfaceFieldIterator | fields () |
Get iterator over all fields of this interface instance. More... | |
InterfaceFieldIterator | fields_end () |
Invalid iterator. More... | |
unsigned int | num_fields () |
Get the number of fields in the interface. More... | |
Additional Inherited Members | |
![]() | |
static void | parse_uid (const char *uid, std::string &type, std::string &id) |
Parse UID to type and ID strings. More... | |
![]() | |
Interface () | |
Constructor. More... | |
void | set_hash (unsigned char *ihash) |
Set hash. More... | |
void | add_fieldinfo (interface_fieldtype_t type, const char *name, size_t length, void *value, const char *enumtype=0, const interface_enum_map_t *enum_map=0) |
Add an entry to the field info list. More... | |
void | add_messageinfo (const char *name) |
Add an entry to the message info list. More... | |
![]() | |
void * | data_ptr |
Pointer to local memory storage. More... | |
unsigned int | data_size |
Minimal data size to hold data storage. More... | |
bool | data_changed |
Indicator if data has changed. More... | |
interface_data_ts_t * | data_ts |
Pointer to data casted to timestamp struct. More... | |
Position2DTrackInterface Fawkes BlackBoard Interface.
This interface provides access to a track of 2D positions.
Definition at line 33 of file Position2DTrackInterface.h.
|
virtual |
Copy values from other interface.
other | other interface to copy values from |
Implements fawkes::Interface.
Definition at line 391 of file Position2DTrackInterface.cpp.
References fawkes::Message::type(), and fawkes::Interface::type().
|
virtual |
Create message based on type name.
This will create a new message of the given type. The type must be given without the InterfaceName:: prefix but just the plain class name of the message.
type | message type |
UnknownTypeException | thrown if this interface cannot create a message of the given type. |
Implements fawkes::Interface.
Definition at line 380 of file Position2DTrackInterface.cpp.
|
virtual |
Convert arbitrary enum value to string.
Given the string representation of the enum type and the value this method returns the string representation of the specific value, or the string UNKNOWN if the value is not defined. An exception is thrown if the enum type is invalid.
enumtype | enum type as string |
val | value to convert |
UnknownTypeException | thrown if enumtype is not specified for interface. |
Implements fawkes::Interface.
Definition at line 402 of file Position2DTrackInterface.cpp.
bool fawkes::Position2DTrackInterface::is_valid | ( | ) | const |
Get valid value.
True, if this track is valid.
Definition at line 290 of file Position2DTrackInterface.cpp.
uint32_t fawkes::Position2DTrackInterface::length | ( | ) | const |
Get length value.
Length of the Tracks (i.e. up to which index there are valid positions).
Definition at line 321 of file Position2DTrackInterface.cpp.
size_t fawkes::Position2DTrackInterface::maxlenof_length | ( | ) | const |
Get maximum length of length value.
Definition at line 331 of file Position2DTrackInterface.cpp.
size_t fawkes::Position2DTrackInterface::maxlenof_track_id | ( | ) | const |
Get maximum length of track_id value.
Definition at line 362 of file Position2DTrackInterface.cpp.
size_t fawkes::Position2DTrackInterface::maxlenof_track_timestamps | ( | ) | const |
Get maximum length of track_timestamps value.
Definition at line 249 of file Position2DTrackInterface.cpp.
size_t fawkes::Position2DTrackInterface::maxlenof_track_x_positions | ( | ) | const |
Get maximum length of track_x_positions value.
Definition at line 105 of file Position2DTrackInterface.cpp.
size_t fawkes::Position2DTrackInterface::maxlenof_track_y_positions | ( | ) | const |
Get maximum length of track_y_positions value.
Definition at line 177 of file Position2DTrackInterface.cpp.
size_t fawkes::Position2DTrackInterface::maxlenof_valid | ( | ) | const |
Get maximum length of valid value.
Definition at line 300 of file Position2DTrackInterface.cpp.
|
virtual |
Check if message is valid and can be enqueued.
message | Message to check |
Implements fawkes::Interface.
Definition at line 413 of file Position2DTrackInterface.cpp.
void fawkes::Position2DTrackInterface::set_length | ( | const uint32_t | new_length | ) |
Set length value.
Length of the Tracks (i.e. up to which index there are valid positions).
new_length | new length value |
Definition at line 341 of file Position2DTrackInterface.cpp.
References fawkes::Interface::data_changed.
void fawkes::Position2DTrackInterface::set_track_id | ( | const uint32_t | new_track_id | ) |
Set track_id value.
The ID of the Track.
new_track_id | new track_id value |
Definition at line 372 of file Position2DTrackInterface.cpp.
References fawkes::Interface::data_changed.
void fawkes::Position2DTrackInterface::set_track_timestamps | ( | unsigned int | index, |
const int32_t | new_track_timestamps | ||
) |
Set track_timestamps value at given index.
Timestamps of the track. The first array-element is the oldest position of the track, the last is the newest.
new_track_timestamps | new track_timestamps value |
index | index for of the value |
Definition at line 277 of file Position2DTrackInterface.cpp.
References fawkes::Interface::data_changed.
void fawkes::Position2DTrackInterface::set_track_timestamps | ( | const int32_t * | new_track_timestamps | ) |
Set track_timestamps value.
Timestamps of the track. The first array-element is the oldest position of the track, the last is the newest.
new_track_timestamps | new track_timestamps value |
Definition at line 262 of file Position2DTrackInterface.cpp.
References fawkes::Interface::data_changed.
void fawkes::Position2DTrackInterface::set_track_x_positions | ( | unsigned int | index, |
const float | new_track_x_positions | ||
) |
Set track_x_positions value at given index.
X-Positions of the track. The first array-element is the oldest position of the track, the last is the newest.
new_track_x_positions | new track_x_positions value |
index | index for of the value |
Definition at line 133 of file Position2DTrackInterface.cpp.
References fawkes::Interface::data_changed.
void fawkes::Position2DTrackInterface::set_track_x_positions | ( | const float * | new_track_x_positions | ) |
Set track_x_positions value.
X-Positions of the track. The first array-element is the oldest position of the track, the last is the newest.
new_track_x_positions | new track_x_positions value |
Definition at line 118 of file Position2DTrackInterface.cpp.
References fawkes::Interface::data_changed.
void fawkes::Position2DTrackInterface::set_track_y_positions | ( | unsigned int | index, |
const float | new_track_y_positions | ||
) |
Set track_y_positions value at given index.
Y-Positions of the track. The first array-element is the oldest position of the track, the last is the newest.
new_track_y_positions | new track_y_positions value |
index | index for of the value |
Definition at line 205 of file Position2DTrackInterface.cpp.
References fawkes::Interface::data_changed.
void fawkes::Position2DTrackInterface::set_track_y_positions | ( | const float * | new_track_y_positions | ) |
Set track_y_positions value.
Y-Positions of the track. The first array-element is the oldest position of the track, the last is the newest.
new_track_y_positions | new track_y_positions value |
Definition at line 190 of file Position2DTrackInterface.cpp.
References fawkes::Interface::data_changed.
void fawkes::Position2DTrackInterface::set_valid | ( | const bool | new_valid | ) |
Set valid value.
True, if this track is valid.
new_valid | new valid value |
Definition at line 310 of file Position2DTrackInterface.cpp.
References fawkes::Interface::data_changed.
uint32_t fawkes::Position2DTrackInterface::track_id | ( | ) | const |
Get track_id value.
The ID of the Track.
Definition at line 352 of file Position2DTrackInterface.cpp.
int32_t * fawkes::Position2DTrackInterface::track_timestamps | ( | ) | const |
Get track_timestamps value.
Timestamps of the track. The first array-element is the oldest position of the track, the last is the newest.
Definition at line 221 of file Position2DTrackInterface.cpp.
int32_t fawkes::Position2DTrackInterface::track_timestamps | ( | unsigned int | index | ) | const |
Get track_timestamps value at given index.
Timestamps of the track. The first array-element is the oldest position of the track, the last is the newest.
index | index of value |
Exception | thrown if index is out of bounds |
Definition at line 236 of file Position2DTrackInterface.cpp.
float * fawkes::Position2DTrackInterface::track_x_positions | ( | ) | const |
Get track_x_positions value.
X-Positions of the track. The first array-element is the oldest position of the track, the last is the newest.
Definition at line 77 of file Position2DTrackInterface.cpp.
float fawkes::Position2DTrackInterface::track_x_positions | ( | unsigned int | index | ) | const |
Get track_x_positions value at given index.
X-Positions of the track. The first array-element is the oldest position of the track, the last is the newest.
index | index of value |
Exception | thrown if index is out of bounds |
Definition at line 92 of file Position2DTrackInterface.cpp.
float * fawkes::Position2DTrackInterface::track_y_positions | ( | ) | const |
Get track_y_positions value.
Y-Positions of the track. The first array-element is the oldest position of the track, the last is the newest.
Definition at line 149 of file Position2DTrackInterface.cpp.
float fawkes::Position2DTrackInterface::track_y_positions | ( | unsigned int | index | ) | const |
Get track_y_positions value at given index.
Y-Positions of the track. The first array-element is the oldest position of the track, the last is the newest.
index | index of value |
Exception | thrown if index is out of bounds |
Definition at line 164 of file Position2DTrackInterface.cpp.