EII Message Bus C Reference
Public Member Functions | Public Attributes | List of all members
eii::msgbus::MsgEnvelopeList Class Reference

#include <msg_envelope.hpp>

Public Member Functions

 MsgEnvelopeList ()
 
void put_integer (int64_t value)
 
void put_float (double value)
 
void put_string (const std::string value)
 
void put_bool (bool value)
 
void put_object (MsgEnvelopeObject *value)
 
void remove_at (int64_t index)
 
int64_t get_int (int64_t index)
 
double get_float (int64_t index)
 
const char * get_string (int64_t index)
 
bool get_bool (int64_t index)
 
MsgEnvelopeObjectget_msg_envelope_object (int64_t index)
 
MsgEnvelopeElementget_msg_envelope_element (int64_t index)
 
msg_envelope_elem_body_tget_msg_envelope_array ()
 
 ~MsgEnvelopeList ()
 

Public Attributes

friend MsgEnvelope
 

Detailed Description

MsgEnvelopeList class

Constructor & Destructor Documentation

◆ MsgEnvelopeList()

eii::msgbus::MsgEnvelopeList::MsgEnvelopeList ( )

Constructor

Exceptions

◆ ~MsgEnvelopeList()

eii::msgbus::MsgEnvelopeList::~MsgEnvelopeList ( )

Destructor

Member Function Documentation

◆ get_bool()

bool eii::msgbus::MsgEnvelopeList::get_bool ( int64_t  index)

To fetch a boolean value associated with the key provided

Exceptions

◆ get_float()

double eii::msgbus::MsgEnvelopeList::get_float ( int64_t  index)

To fetch a float value associated with the key provided

Exceptions

◆ get_int()

int64_t eii::msgbus::MsgEnvelopeList::get_int ( int64_t  index)

To fetch an integer value associated with the key provided

Exceptions

◆ get_msg_envelope_array()

msg_envelope_elem_body_t* eii::msgbus::MsgEnvelopeList::get_msg_envelope_array ( )

Getter to retrieve the underlying msg_envelope_elem_body_t structure

Returns
msg_envelope_elem_body_t - returns the msg_envelope_elem_body_t struct

◆ get_msg_envelope_element()

MsgEnvelopeElement* eii::msgbus::MsgEnvelopeList::get_msg_envelope_element ( int64_t  index)

To fetch a MsgEnvelopeElement value associated with the index provided

Exceptions

◆ get_msg_envelope_object()

MsgEnvelopeObject* eii::msgbus::MsgEnvelopeList::get_msg_envelope_object ( int64_t  index)

To fetch a MsgEnvelopeObject value associated with the key provided

Exceptions

◆ get_string()

const char* eii::msgbus::MsgEnvelopeList::get_string ( int64_t  index)

To fetch a string associated with the key provided

Exceptions

◆ put_bool()

void eii::msgbus::MsgEnvelopeList::put_bool ( bool  value)

Add a new boolean value to the MsgEnvelopeList object.

Exceptions

◆ put_float()

void eii::msgbus::MsgEnvelopeList::put_float ( double  value)

Add a new float value to the MsgEnvelopeList object.

Exceptions

◆ put_integer()

void eii::msgbus::MsgEnvelopeList::put_integer ( int64_t  value)

Add a new integer value to the MsgEnvelopeList object.

Exceptions

◆ put_object()

void eii::msgbus::MsgEnvelopeList::put_object ( MsgEnvelopeObject value)

Add a new nested MsgEnvelopeObject to the MsgEnvelope object.

Exceptions

◆ put_string()

void eii::msgbus::MsgEnvelopeList::put_string ( const std::string  value)

Add a new string value to the MsgEnvelopeList object.

Exceptions

◆ remove_at()

void eii::msgbus::MsgEnvelopeList::remove_at ( int64_t  index)

To remove value associated with the key provided

Exceptions

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