Fawkes API  Fawkes Development Version
fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage Class Reference

CreateNewBoxFilterMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage:

Public Member Functions

 CreateNewBoxFilterMessage (const double *ini_p1, const double *ini_p2, const double *ini_p3, const double *ini_p4)
 Constructor with initial values. More...
 
 CreateNewBoxFilterMessage ()
 Constructor. More...
 
 ~CreateNewBoxFilterMessage ()
 Destructor. More...
 
 CreateNewBoxFilterMessage (const CreateNewBoxFilterMessage *m)
 Copy constructor. More...
 
double * p1 () const
 Get p1 value. More...
 
double p1 (unsigned int index) const
 Get p1 value at given index. More...
 
void set_p1 (unsigned int index, const double new_p1)
 Set p1 value at given index. More...
 
void set_p1 (const double *new_p1)
 Set p1 value. More...
 
size_t maxlenof_p1 () const
 Get maximum length of p1 value. More...
 
double * p2 () const
 Get p2 value. More...
 
double p2 (unsigned int index) const
 Get p2 value at given index. More...
 
void set_p2 (unsigned int index, const double new_p2)
 Set p2 value at given index. More...
 
void set_p2 (const double *new_p2)
 Set p2 value. More...
 
size_t maxlenof_p2 () const
 Get maximum length of p2 value. More...
 
double * p3 () const
 Get p3 value. More...
 
double p3 (unsigned int index) const
 Get p3 value at given index. More...
 
void set_p3 (unsigned int index, const double new_p3)
 Set p3 value at given index. More...
 
void set_p3 (const double *new_p3)
 Set p3 value. More...
 
size_t maxlenof_p3 () const
 Get maximum length of p3 value. More...
 
double * p4 () const
 Get p4 value. More...
 
double p4 (unsigned int index) const
 Get p4 value at given index. More...
 
void set_p4 (unsigned int index, const double new_p4)
 Set p4 value at given index. More...
 
void set_p4 (const double *new_p4)
 Set p4 value. More...
 
size_t maxlenof_p4 () const
 Get maximum length of p4 value. More...
 
virtual Messageclone () const
 Clone this message. More...
 
- Public Member Functions inherited from fawkes::Message
 Message (const char *type)
 Constructor. More...
 
 Message (const Message *mesg)
 Copy constructor. More...
 
 Message (const Message &mesg)
 Copy constructor. More...
 
virtual ~Message ()
 Destructor. More...
 
Messageoperator= (const Message &m)
 Assign this message to given message. More...
 
unsigned int id () const
 Get message ID. More...
 
void set_id (unsigned int message_id)
 Set message ID. More...
 
void mark_enqueued ()
 Mark message as being enqueued. More...
 
bool enqueued () const
 Check is message has been enqueued. More...
 
const Timetime_enqueued () const
 Get time when message was enqueued. More...
 
Uuid sender_id () const
 Get ID of the immediate sender, not necessarily the creator of the message. More...
 
Uuid source_id () const
 Get ID of the original source of the message. More...
 
void set_sender_id (const Uuid &id)
 Set sender ID. More...
 
void set_source_id (const Uuid &id)
 Set source ID. More...
 
const char * sender_thread_name () const
 Get sender of message. More...
 
Interfaceinterface () const
 Get transmitting interface. More...
 
const char * type () const
 Get message type. More...
 
InterfaceFieldIterator fields ()
 Get iterator over all fields of this interface instance. More...
 
InterfaceFieldIterator fields_end ()
 Invalid iterator. More...
 
unsigned int num_fields () const
 Get the number of fields in the message. More...
 
const void * datachunk () const
 Get pointer to data. More...
 
unsigned int datasize () const
 Get size of data. More...
 
unsigned int hops () const
 Get number of hops. More...
 
void set_hops (unsigned int hops)
 Set number of hops. More...
 
void set_from_chunk (const void *chunk)
 Set from raw data chunk. More...
 
unsigned int recipient () const
 Get recipient memory serial. More...
 
template<class MessageType >
bool is_of_type ()
 Check if message has desired type. More...
 
template<class MessageType >
MessageType * as_type ()
 Cast message to given type if possible. More...
 
- Public Member Functions inherited from fawkes::RefCount
 RefCount ()
 Constructor. More...
 
virtual ~RefCount ()
 Destructor. More...
 
void ref ()
 Increment reference count. More...
 
void unref ()
 Decrement reference count and conditionally delete this instance. More...
 
unsigned int refcount ()
 Get reference count for this instance. More...
 

Additional Inherited Members

- Protected Member Functions inherited from fawkes::Message
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 info list. More...
 
template<class FieldT , class DataT >
void set_field (FieldT &field, DataT &data)
 Set a field. More...
 
template<class FieldT , class DataT >
void set_field (FieldT &field, unsigned int index, DataT &data)
 Set an array field at a given index. More...
 
- Protected Attributes inherited from fawkes::Message
void * data_ptr
 Pointer to memory that contains local data. More...
 
unsigned int data_size
 Size of memory needed to hold all data. More...
 
message_data_ts_tdata_ts
 data timestamp aliasing pointer More...
 

Detailed Description

Constructor & Destructor Documentation

◆ CreateNewBoxFilterMessage() [1/3]

fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::CreateNewBoxFilterMessage ( const double *  ini_p1,
const double *  ini_p2,
const double *  ini_p3,
const double *  ini_p4 
)

Constructor with initial values.

Parameters
ini_p1initial value for p1
ini_p2initial value for p2
ini_p3initial value for p3
ini_p4initial value for p4

Definition at line 142 of file LaserBoxFilterInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, and fawkes::IFT_DOUBLE.

◆ CreateNewBoxFilterMessage() [2/3]

fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::CreateNewBoxFilterMessage ( )

◆ ~CreateNewBoxFilterMessage()

fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::~CreateNewBoxFilterMessage ( )

Destructor.

Definition at line 173 of file LaserBoxFilterInterface.cpp.

References fawkes::Interface::data_ptr.

◆ CreateNewBoxFilterMessage() [3/3]

fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::CreateNewBoxFilterMessage ( const CreateNewBoxFilterMessage m)
explicit

Copy constructor.

Parameters
mmessage to copy from

Definition at line 181 of file LaserBoxFilterInterface.cpp.

References fawkes::Message::data_ptr, fawkes::Message::data_size, and fawkes::Message::data_ts.

Member Function Documentation

◆ clone()

Message * fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::clone ( ) const
virtual

Clone this message.

Produces a message of the same type as this message and copies the data to the new message.

Returns
clone of this message

Reimplemented from fawkes::Message.

Definition at line 417 of file LaserBoxFilterInterface.cpp.

◆ maxlenof_p1()

size_t fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::maxlenof_p1 ( ) const

Get maximum length of p1 value.

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

Definition at line 221 of file LaserBoxFilterInterface.cpp.

◆ maxlenof_p2()

size_t fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::maxlenof_p2 ( ) const

Get maximum length of p2 value.

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

Definition at line 276 of file LaserBoxFilterInterface.cpp.

◆ maxlenof_p3()

size_t fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::maxlenof_p3 ( ) const

Get maximum length of p3 value.

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

Definition at line 331 of file LaserBoxFilterInterface.cpp.

◆ maxlenof_p4()

size_t fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::maxlenof_p4 ( ) const

Get maximum length of p4 value.

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

Definition at line 386 of file LaserBoxFilterInterface.cpp.

◆ p1() [1/2]

double * fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::p1 ( ) const

Get p1 value.

x,y coordinates of first vector

Returns
p1 value

Definition at line 196 of file LaserBoxFilterInterface.cpp.

Referenced by LaserBoxFilterDataFilter::filter().

◆ p1() [2/2]

double fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::p1 ( unsigned int  index) const

Get p1 value at given index.

x,y coordinates of first vector

Parameters
indexindex of value
Returns
p1 value
Exceptions
Exceptionthrown if index is out of bounds

Definition at line 208 of file LaserBoxFilterInterface.cpp.

◆ p2() [1/2]

double * fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::p2 ( ) const

Get p2 value.

x,y coordinates of second vector

Returns
p2 value

Definition at line 251 of file LaserBoxFilterInterface.cpp.

Referenced by LaserBoxFilterDataFilter::filter().

◆ p2() [2/2]

double fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::p2 ( unsigned int  index) const

Get p2 value at given index.

x,y coordinates of second vector

Parameters
indexindex of value
Returns
p2 value
Exceptions
Exceptionthrown if index is out of bounds

Definition at line 263 of file LaserBoxFilterInterface.cpp.

◆ p3() [1/2]

double * fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::p3 ( ) const

Get p3 value.

x,y coordinates of third vector

Returns
p3 value

Definition at line 306 of file LaserBoxFilterInterface.cpp.

Referenced by LaserBoxFilterDataFilter::filter().

◆ p3() [2/2]

double fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::p3 ( unsigned int  index) const

Get p3 value at given index.

x,y coordinates of third vector

Parameters
indexindex of value
Returns
p3 value
Exceptions
Exceptionthrown if index is out of bounds

Definition at line 318 of file LaserBoxFilterInterface.cpp.

◆ p4() [1/2]

double * fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::p4 ( ) const

Get p4 value.

x,y coordinates of fourth vector

Returns
p4 value

Definition at line 361 of file LaserBoxFilterInterface.cpp.

Referenced by LaserBoxFilterDataFilter::filter().

◆ p4() [2/2]

double fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::p4 ( unsigned int  index) const

Get p4 value at given index.

x,y coordinates of fourth vector

Parameters
indexindex of value
Returns
p4 value
Exceptions
Exceptionthrown if index is out of bounds

Definition at line 373 of file LaserBoxFilterInterface.cpp.

◆ set_p1() [1/2]

void fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::set_p1 ( const double *  new_p1)

Set p1 value.

x,y coordinates of first vector

Parameters
new_p1new p1 value

Definition at line 231 of file LaserBoxFilterInterface.cpp.

References fawkes::Interface::set_field().

◆ set_p1() [2/2]

void fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::set_p1 ( unsigned int  index,
const double  new_p1 
)

Set p1 value at given index.

x,y coordinates of first vector

Parameters
new_p1new p1 value
indexindex for of the value

Definition at line 242 of file LaserBoxFilterInterface.cpp.

References fawkes::Interface::set_field().

◆ set_p2() [1/2]

void fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::set_p2 ( const double *  new_p2)

Set p2 value.

x,y coordinates of second vector

Parameters
new_p2new p2 value

Definition at line 286 of file LaserBoxFilterInterface.cpp.

References fawkes::Interface::set_field().

◆ set_p2() [2/2]

void fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::set_p2 ( unsigned int  index,
const double  new_p2 
)

Set p2 value at given index.

x,y coordinates of second vector

Parameters
new_p2new p2 value
indexindex for of the value

Definition at line 297 of file LaserBoxFilterInterface.cpp.

References fawkes::Interface::set_field().

◆ set_p3() [1/2]

void fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::set_p3 ( const double *  new_p3)

Set p3 value.

x,y coordinates of third vector

Parameters
new_p3new p3 value

Definition at line 341 of file LaserBoxFilterInterface.cpp.

References fawkes::Interface::set_field().

◆ set_p3() [2/2]

void fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::set_p3 ( unsigned int  index,
const double  new_p3 
)

Set p3 value at given index.

x,y coordinates of third vector

Parameters
new_p3new p3 value
indexindex for of the value

Definition at line 352 of file LaserBoxFilterInterface.cpp.

References fawkes::Interface::set_field().

◆ set_p4() [1/2]

void fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::set_p4 ( const double *  new_p4)

Set p4 value.

x,y coordinates of fourth vector

Parameters
new_p4new p4 value

Definition at line 396 of file LaserBoxFilterInterface.cpp.

References fawkes::Interface::set_field().

◆ set_p4() [2/2]

void fawkes::LaserBoxFilterInterface::CreateNewBoxFilterMessage::set_p4 ( unsigned int  index,
const double  new_p4 
)

Set p4 value at given index.

x,y coordinates of fourth vector

Parameters
new_p4new p4 value
indexindex for of the value

Definition at line 407 of file LaserBoxFilterInterface.cpp.

References fawkes::Interface::set_field().


The documentation for this class was generated from the following files: