Fawkes API  Fawkes Development Version
InterfaceMessage Class Reference

Interface generator internal representation of a message as parsed from the XML template file. More...

#include <interfaces/generator/message.h>

Public Member Functions

 InterfaceMessage (const std::string &name, const std::string &comment)
 Constructor. More...
 
std::string getName ()
 Get name of message. More...
 
std::string getComment ()
 Get comment of message. More...
 
void setFields (const std::vector< InterfaceField > &fields)
 Set fields of message. More...
 
std::vector< InterfaceFieldgetFields ()
 Get fields of message. More...
 

Detailed Description

Interface generator internal representation of a message as parsed from the XML template file.

Definition at line 31 of file message.h.

Constructor & Destructor Documentation

◆ InterfaceMessage()

InterfaceMessage::InterfaceMessage ( const std::string &  name,
const std::string &  comment 
)

Constructor.

Parameters
namename of message
commentcomment of message

Definition at line 35 of file message.cpp.

Member Function Documentation

◆ getComment()

std::string InterfaceMessage::getComment ( )

Get comment of message.

Returns
comment of message.

Definition at line 61 of file message.cpp.

◆ getFields()

std::vector< InterfaceField > InterfaceMessage::getFields ( )

Get fields of message.

Returns
fields of message.

Definition at line 81 of file message.cpp.

◆ getName()

std::string InterfaceMessage::getName ( void  )

Get name of message.

Returns
name of message.

Definition at line 51 of file message.cpp.

◆ setFields()

void InterfaceMessage::setFields ( const std::vector< InterfaceField > &  fields)

Set fields of message.

Parameters
fieldsfields of message.

Definition at line 71 of file message.cpp.


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