fawkes::TestInterface::SetTestStringMessage Class Reference

SetTestStringMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/TestInterface.h>

Inheritance diagram for fawkes::TestInterface::SetTestStringMessage:

Inheritance graph
[legend]

List of all members.


Classes

struct  SetTestStringMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 SetTestStringMessage (const char *ini_test_string)
 Constructor with initial values.
 SetTestStringMessage ()
 Constructor.
 ~SetTestStringMessage ()
 Destructor.
 SetTestStringMessage (const SetTestStringMessage *m)
 Copy constructor.
char * test_string () const
 Get test_string value.
void set_test_string (const char *new_test_string)
 Set test_string value.
size_t maxlenof_test_string () const
 Get maximum length of test_string value.
virtual Message * clone () const
 Clone this message.

Detailed Description

SetTestStringMessage Fawkes BlackBoard Interface Message.

Definition at line 89 of file TestInterface.h.

Constructor & Destructor Documentation

fawkes::TestInterface::SetTestStringMessage::SetTestStringMessage ( const char *  ini_test_string  ) 

Constructor with initial values.

Parameters:
ini_test_string initial value for test_string

Definition at line 443 of file TestInterface.cpp.

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

fawkes::TestInterface::SetTestStringMessage::SetTestStringMessage (  ) 

Constructor.

Definition at line 453 of file TestInterface.cpp.

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

Referenced by clone().

fawkes::TestInterface::SetTestStringMessage::~SetTestStringMessage (  ) 

Destructor.

Definition at line 463 of file TestInterface.cpp.

References fawkes::Message::data_ptr.

fawkes::TestInterface::SetTestStringMessage::SetTestStringMessage ( const SetTestStringMessage *  m  ) 

Copy constructor.

Parameters:
m message to copy from

Definition at line 471 of file TestInterface.cpp.

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

Member Function Documentation

Message * fawkes::TestInterface::SetTestStringMessage::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 516 of file TestInterface.cpp.

References SetTestStringMessage().

size_t fawkes::TestInterface::SetTestStringMessage::maxlenof_test_string (  )  const

Get maximum length of test_string value.

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

Definition at line 495 of file TestInterface.cpp.

void fawkes::TestInterface::SetTestStringMessage::set_test_string ( const char *  new_test_string  ) 

Set test_string value.

A test sring

Parameters:
new_test_string new test_string value

Definition at line 505 of file TestInterface.cpp.

char * fawkes::TestInterface::SetTestStringMessage::test_string (  )  const

Get test_string value.

A test sring

Returns:
test_string value

Definition at line 485 of file TestInterface.cpp.

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