DUNE::IMC::LogBookEntry Class Reference

Detailed Description

Log Book Entry.

Public Types
enum	TypeEnum {   LBET_INFO, LBET_WARNING, LBET_ERROR, LBET_CRITICAL,   LBET_DEBUG }

Public Member Functions
	LogBookEntry (void)
Message *	clone (void) const
void	clear (void)
bool	fieldsEqual (const Message &msg__) const
int	validate (void) const
uint8_t *	serializeFields (uint8_t *bfr__) const
uint16_t	deserializeFields (const uint8_t *bfr__, uint16_t size__)
uint16_t	reverseDeserializeFields (const uint8_t *bfr__, uint16_t size__)
uint16_t	getId (void) const
const char *	getName (void) const
unsigned	getFixedSerializationSize (void) const
unsigned	getVariableSerializationSize (void) const
void	fieldsToJSON (std::ostream &os__, unsigned nindent__) const
Public Member Functions inherited from DUNE::IMC::Message
	Message (void)
virtual	~Message (void)
double	setTimeStamp (double ts)
double	setTimeStamp (void)
double	getTimeStamp (void) const
uint16_t	getSource (void) const
void	setSource (uint16_t src)
uint8_t	getSourceEntity (void) const
void	setSourceEntity (uint8_t src_ent)
uint16_t	getDestination (void) const
void	setDestination (uint16_t dst)
uint8_t	getDestinationEntity (void) const
void	setDestinationEntity (uint8_t dst_ent)
virtual uint16_t	getSubId (void) const
virtual void	setSubId (uint16_t subid)
virtual fp64_t	getValueFP (void) const
virtual void	setValueFP (fp64_t val)
unsigned	getSerializationSize (void) const
unsigned	getPayloadSerializationSize (void) const
void	toJSON (std::ostream &os) const
void	toText (std::ostream &os) const
bool	operator== (const Message &other) const
bool	operator!= (const Message &other) const

Static Public Member Functions
static uint16_t	getIdStatic (void)

Public Attributes
uint8_t	type
fp64_t	htime
std::string	context
std::string	text

Additional Inherited Members
Protected Member Functions inherited from DUNE::IMC::Message
virtual void	setTimeStampNested (double value)
virtual void	setSourceNested (uint16_t value)
virtual void	setSourceEntityNested (uint8_t value)
virtual void	setDestinationNested (uint16_t value)
virtual void	setDestinationEntityNested (uint8_t value)
Protected Attributes inherited from DUNE::IMC::Message
Header	m_header

Member Enumeration Documentation

enum DUNE::IMC::LogBookEntry::TypeEnum

Type.

Enumerator
LBET_INFO	Information.
LBET_WARNING	Warning.
LBET_ERROR	Error.
LBET_CRITICAL	Critical.
LBET_DEBUG	Debug.

Constructor & Destructor Documentation

DUNE::IMC::LogBookEntry::LogBookEntry

(

void

)

References clear(), DUNE::IMC::Message::m_header, and DUNE::IMC::Header::mgid.

Referenced by clone().

Member Function Documentation

void DUNE::IMC::LogBookEntry::clear ( void  )

virtual

Reset message's fields.

Implements DUNE::IMC::Message.

References context, htime, text, and type.

Referenced by LogBookEntry().

Message* DUNE::IMC::LogBookEntry::clone ( void  ) const

inlinevirtual

Retrieve a copy of the message.

Returns

message copy.

Implements DUNE::IMC::Message.

References LogBookEntry().

uint16_t DUNE::IMC::LogBookEntry::deserializeFields ( const uint8_t *  bfr, uint16_t  len  )

virtual

Deserialize message fields from a packet.

Parameters

bfr	stream of bytes (packet)
len	length of the byte stream.

Returns

number of bytes processed.

Implements DUNE::IMC::Message.

References context, DUNE::IMC::deserialize(), htime, text, and type.

bool DUNE::IMC::LogBookEntry::fieldsEqual ( const Message &  other ) const

virtual

Compare fields for equality.

Parameters

[in]

other

message to compare.

Returns

true if fields are equal, false otherwise.

Reimplemented from DUNE::IMC::Message.

References context, htime, text, and type.

void DUNE::IMC::LogBookEntry::fieldsToJSON ( std::ostream &  os, unsigned  indent_level  ) const

virtual

Output the message fields (excluding header) in JSON format.

Parameters

os	output stream.
indent_level	number of indentation spaces.

Reimplemented from DUNE::IMC::Message.

References context, htime, text, DUNE::IMC::toJSON(), and type.

unsigned DUNE::IMC::LogBookEntry::getFixedSerializationSize ( void  ) const

inlinevirtual

Get the fixed amount of bytes required to properly serialize this message (variable length fields are not included).

Returns

amount of variable bytes required to serialize the message.

Reimplemented from DUNE::IMC::Message.

uint16_t DUNE::IMC::LogBookEntry::getId ( void  ) const

inlinevirtual

Retrieve message's identification number.

Returns

message's identification number.

Implements DUNE::IMC::Message.

References getIdStatic().

static uint16_t DUNE::IMC::LogBookEntry::getIdStatic ( void  )

inlinestatic

Referenced by getId().

const char* DUNE::IMC::LogBookEntry::getName ( void  ) const

inlinevirtual

Retrieve message's name.

Returns

message's name.

Implements DUNE::IMC::Message.

unsigned DUNE::IMC::LogBookEntry::getVariableSerializationSize ( void  ) const

inlinevirtual

Get the variable amount of bytes required to properly serialize this message (only the variable fields are included).

Returns

amount of variable bytes required to serialize the message.

Reimplemented from DUNE::IMC::Message.

References context, DUNE::IMC::getSerializationSize(), and text.

uint16_t DUNE::IMC::LogBookEntry::reverseDeserializeFields ( const uint8_t *  bfr, uint16_t  len  )

virtual

Deserialize message fields from a packet, swapping the byte order.

Parameters

bfr	stream of bytes (packet)
len	length of the byte stream.

Returns

number of bytes processed.

Implements DUNE::IMC::Message.

References context, DUNE::IMC::deserialize(), htime, DUNE::IMC::reverseDeserialize(), text, and type.

uint8_t * DUNE::IMC::LogBookEntry::serializeFields ( uint8_t *  bfr__ ) const

virtual

Implements DUNE::IMC::Message.

References context, htime, DUNE::IMC::serialize(), text, and type.

int DUNE::IMC::LogBookEntry::validate ( void  ) const

virtual

Validate the message's contents.

Returns

negative value in case of a valid message or a positive value indicating the position of the invalid message field.

Implements DUNE::IMC::Message.

Member Data Documentation

std::string DUNE::IMC::LogBookEntry::context

Context.

Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), getVariableSerializationSize(), reverseDeserializeFields(), and serializeFields().

fp64_t DUNE::IMC::LogBookEntry::htime

Timestamp.

Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

std::string DUNE::IMC::LogBookEntry::text

Text.

Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), getVariableSerializationSize(), reverseDeserializeFields(), and serializeFields().

uint8_t DUNE::IMC::LogBookEntry::type

Type.

Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

Collaboration diagram for DUNE::IMC::LogBookEntry: