fawkes::Position2DTrackInterface Class Reference
[Fawkes Interfaces]

Position2DTrackInterface Fawkes BlackBoard Interface. More...

#include <interfaces/Position2DTrackInterface.h>

Inheritance diagram for fawkes::Position2DTrackInterface:

[legend]
List of all members.

Public Member Functions

virtual bool message_valid (const Message *message) const
 Check if message is valid and can be enqueued.
float * track_x_positions () const
 Get track_x_positions value.
float track_x_positions (unsigned int index) const
 Get track_x_positions value at given index.
void set_track_x_positions (unsigned int index, const float new_track_x_positions)
 Set track_x_positions value at given index.
void set_track_x_positions (const float *new_track_x_positions)
 Set track_x_positions value.
size_t maxlenof_track_x_positions () const
 Get maximum length of track_x_positions value.
float * track_y_positions () const
 Get track_y_positions value.
float track_y_positions (unsigned int index) const
 Get track_y_positions value at given index.
void set_track_y_positions (unsigned int index, const float new_track_y_positions)
 Set track_y_positions value at given index.
void set_track_y_positions (const float *new_track_y_positions)
 Set track_y_positions value.
size_t maxlenof_track_y_positions () const
 Get maximum length of track_y_positions value.
int32_t * track_timestamps () const
 Get track_timestamps value.
int32_t track_timestamps (unsigned int index) const
 Get track_timestamps value at given index.
void set_track_timestamps (unsigned int index, const int32_t new_track_timestamps)
 Set track_timestamps value at given index.
void set_track_timestamps (const int32_t *new_track_timestamps)
 Set track_timestamps value.
size_t maxlenof_track_timestamps () const
 Get maximum length of track_timestamps value.
bool is_valid () const
 Get valid value.
void set_valid (const bool new_valid)
 Set valid value.
size_t maxlenof_valid () const
 Get maximum length of valid value.
uint32_t length () const
 Get length value.
void set_length (const uint32_t new_length)
 Set length value.
size_t maxlenof_length () const
 Get maximum length of length value.
uint32_t track_id () const
 Get track_id value.
void set_track_id (const uint32_t new_track_id)
 Set track_id value.
size_t maxlenof_track_id () const
 Get maximum length of track_id value.
virtual Messagecreate_message (const char *type) const
 Create message based on type name.
virtual void copy_values (const Interface *other)
 Copy values from other interface.
virtual const char * enum_tostring (const char *enumtype, int val) const
 Convert arbitrary enum value to string.

Classes

struct  Position2DTrackInterface_data_t
 Internal data storage, do NOT modify!

Detailed Description

Position2DTrackInterface Fawkes BlackBoard Interface.

This interface provides access to a track of 2D positions.

Definition at line 33 of file Position2DTrackInterface.h.


Member Function Documentation

void fawkes::Position2DTrackInterface::copy_values ( const Interface other  )  [virtual]

Copy values from other interface.

Parameters:
other other interface to copy values from

Implements fawkes::Interface.

Definition at line 386 of file Position2DTrackInterface.cpp.

References data, and fawkes::Interface::type().

Message * fawkes::Position2DTrackInterface::create_message ( const char *  type  )  const [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.

Parameters:
type message type
Returns:
message of the given type, empty
Exceptions:
UnknownTypeException thrown if this interface cannot create a message of the given type.

Implements fawkes::Interface.

Definition at line 375 of file Position2DTrackInterface.cpp.

const char * fawkes::Position2DTrackInterface::enum_tostring ( const char *  enumtype,
int  val 
) const [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.

Parameters:
enumtype enum type as string
val value to convert
Returns:
string representation of value
Exceptions:
UnknownTypeException thrown if enumtype is not specified for interface.

Implements fawkes::Interface.

Definition at line 397 of file Position2DTrackInterface.cpp.

bool fawkes::Position2DTrackInterface::is_valid (  )  const

Get valid value.

True, if this track is valid.

Returns:
valid value

Reimplemented from fawkes::Interface.

Definition at line 285 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).

Returns:
length value

Definition at line 316 of file Position2DTrackInterface.cpp.

size_t fawkes::Position2DTrackInterface::maxlenof_length (  )  const

Get maximum length of length value.

Returns:
length of length value, can be length of the array or number of maximum number of characters for a string

Definition at line 326 of file Position2DTrackInterface.cpp.

size_t fawkes::Position2DTrackInterface::maxlenof_track_id (  )  const

Get maximum length of track_id value.

Returns:
length of track_id value, can be length of the array or number of maximum number of characters for a string

Definition at line 357 of file Position2DTrackInterface.cpp.

size_t fawkes::Position2DTrackInterface::maxlenof_track_timestamps (  )  const

Get maximum length of track_timestamps value.

Returns:
length of track_timestamps value, can be length of the array or number of maximum number of characters for a string

Definition at line 245 of file Position2DTrackInterface.cpp.

size_t fawkes::Position2DTrackInterface::maxlenof_track_x_positions (  )  const

Get maximum length of track_x_positions value.

Returns:
length of track_x_positions value, can be length of the array or number of maximum number of characters for a string

Definition at line 103 of file Position2DTrackInterface.cpp.

size_t fawkes::Position2DTrackInterface::maxlenof_track_y_positions (  )  const

Get maximum length of track_y_positions value.

Returns:
length of track_y_positions value, can be length of the array or number of maximum number of characters for a string

Definition at line 174 of file Position2DTrackInterface.cpp.

size_t fawkes::Position2DTrackInterface::maxlenof_valid (  )  const

Get maximum length of valid value.

Returns:
length of valid value, can be length of the array or number of maximum number of characters for a string

Definition at line 295 of file Position2DTrackInterface.cpp.

bool fawkes::Position2DTrackInterface::message_valid ( const Message message  )  const [virtual]

Check if message is valid and can be enqueued.

Parameters:
message Message to check
Returns:
true if the message is valid, false otherwise.

Implements fawkes::Interface.

Definition at line 408 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).

Parameters:
new_length new length value

Definition at line 336 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.

Parameters:
new_track_id new track_id value

Definition at line 367 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.

Parameters:
new_track_timestamps new track_timestamps value

Definition at line 258 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.

Parameters:
new_track_timestamps new track_timestamps value
index index for of the value

Definition at line 273 of file Position2DTrackInterface.cpp.

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.

Parameters:
new_track_x_positions new track_x_positions value

Definition at line 116 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.

Parameters:
new_track_x_positions new track_x_positions value
index index for of the value

Definition at line 131 of file Position2DTrackInterface.cpp.

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.

Parameters:
new_track_y_positions new track_y_positions value

Definition at line 187 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.

Parameters:
new_track_y_positions new track_y_positions value
index index for of the value

Definition at line 202 of file Position2DTrackInterface.cpp.

void fawkes::Position2DTrackInterface::set_valid ( const bool  new_valid  ) 

Set valid value.

True, if this track is valid.

Parameters:
new_valid new valid value

Definition at line 305 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.

Returns:
track_id value

Definition at line 347 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.

Parameters:
index index of value
Returns:
track_timestamps value
Exceptions:
Exception thrown if index is out of bounds

Definition at line 232 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.

Returns:
track_timestamps value

Definition at line 217 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.

Parameters:
index index of value
Returns:
track_x_positions value
Exceptions:
Exception thrown if index is out of bounds

Definition at line 90 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.

Returns:
track_x_positions value

Definition at line 75 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.

Parameters:
index index of value
Returns:
track_y_positions value
Exceptions:
Exception thrown if index is out of bounds

Definition at line 161 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.

Returns:
track_y_positions value

Definition at line 146 of file Position2DTrackInterface.cpp.


The documentation for this class was generated from the following files:
Generated on Tue Feb 22 13:31:36 2011 for Fawkes API by  doxygen 1.4.7