fawkes::FacerInterface::SetOpmodeMessage Class Reference

SetOpmodeMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/FacerInterface.h>

Inheritance diagram for fawkes::FacerInterface::SetOpmodeMessage:
Inheritance graph
[legend]

List of all members.

Classes

struct  SetOpmodeMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 SetOpmodeMessage (const if_facer_opmode_t ini_opmode)
 Constructor with initial values.
 SetOpmodeMessage ()
 Constructor.
 ~SetOpmodeMessage ()
 Destructor.
 SetOpmodeMessage (const SetOpmodeMessage *m)
 Copy constructor.
if_facer_opmode_t opmode () const
 Get opmode value.
void set_opmode (const if_facer_opmode_t new_opmode)
 Set opmode value.
size_t maxlenof_opmode () const
 Get maximum length of opmode value.
virtual Messageclone () const
 Clone this message.

Detailed Description

SetOpmodeMessage Fawkes BlackBoard Interface Message.

Definition at line 143 of file FacerInterface.h.


Constructor & Destructor Documentation

fawkes::FacerInterface::SetOpmodeMessage::SetOpmodeMessage ( const if_facer_opmode_t  ini_opmode  ) 

Constructor with initial values.

Parameters:
ini_opmode initial value for opmode

Definition at line 812 of file FacerInterface.cpp.

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

fawkes::FacerInterface::SetOpmodeMessage::SetOpmodeMessage (  ) 
fawkes::FacerInterface::SetOpmodeMessage::~SetOpmodeMessage (  ) 

Destructor.

Definition at line 834 of file FacerInterface.cpp.

References fawkes::Message::data_ptr.

fawkes::FacerInterface::SetOpmodeMessage::SetOpmodeMessage ( const SetOpmodeMessage m  ) 

Copy constructor.

Parameters:
m message to copy from

Definition at line 842 of file FacerInterface.cpp.

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


Member Function Documentation

Message * fawkes::FacerInterface::SetOpmodeMessage::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 892 of file FacerInterface.cpp.

References SetOpmodeMessage().

size_t fawkes::FacerInterface::SetOpmodeMessage::maxlenof_opmode (  )  const

Get maximum length of opmode value.

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

Definition at line 869 of file FacerInterface.cpp.

FacerInterface::if_facer_opmode_t fawkes::FacerInterface::SetOpmodeMessage::opmode (  )  const

Get opmode value.

Current opmode.

Returns:
opmode value

Definition at line 859 of file FacerInterface.cpp.

void fawkes::FacerInterface::SetOpmodeMessage::set_opmode ( const if_facer_opmode_t  new_opmode  ) 

Set opmode value.

Current opmode.

Parameters:
new_opmode new opmode value

Definition at line 881 of file FacerInterface.cpp.


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

Generated on 1 Mar 2011 for Fawkes API by  doxygen 1.6.1