#include <debugMetaRegister.h>

Inheritance diagram for makVre::DebugMetaRegisterMessage:

Classes
struct	DebugMetaRegisterData

struct	KeyValuePair

Public Types
enum	Action { Action_REGISTER , Action_UNREGISTER }

enum	Process { Process_VRE_APP , Process_VRF_APP , Process_VRE_SIM , Process_VRF_SIM }

Public Member Functions
virtual const std::string &	type () const override

virtual const makVre::DtVreMessageId &	messageId () const override

virtual	~DebugMetaRegisterMessage () override

virtual const DtSimulationAddress &	getSimulationAddress () const

virtual void	setSimulationAddress (const DtSimulationAddress &val)

virtual const std::string &	getDisplayName () const

virtual void	setDisplayName (const std::string &val)

virtual const std::string &	getDebugType () const

virtual void	setDebugType (const std::string &val)

virtual const std::string &	getDebugMenuSection () const

virtual void	setDebugMenuSection (const std::string &val)

virtual bool	getShowInTable () const

virtual void	setShowInTable (bool val)

virtual Action	getAction () const

virtual void	setAction (Action val)

virtual bool	getEnabled () const

virtual void	setEnabled (bool val)

virtual Process	getProcess () const

virtual void	setProcess (Process val)

virtual const std::vector< KeyValuePair > &	getExtraData () const

virtual void	setExtraData (const std::vector< KeyValuePair > &val)

virtual int	messageSize () const override

DebugMetaRegisterData	getData ()

DebugMetaRegisterData	getData () const

bool	operator== (const DebugMetaRegisterMessage &rhs) const

Public Member Functions inherited from makVre::DtVreMessage
	DtVreMessage ()

virtual	~DtVreMessage ()

virtual char *	encode ()

virtual void	encode (char *buffer, int bufferSize)

virtual const UInt64	originatingApplicationId () const

virtual void	setOriginatingApplicationId (UInt64 appId)

virtual void	setDelay (double delay)

virtual bool	isDelayed ()

virtual void	reduceDelay (double dt)

virtual const UInt64	versionNumber () const

Static Public Member Functions
static DebugMetaRegisterMessage *	create ()

static DebugMetaRegisterMessage *	createFrom (DebugMetaRegisterMessage *)

static DebugMetaRegisterMessage *	createFromData (const DebugMetaRegisterData)

static const std::string &	theType ()

static const makVre::DtVreMessageId &	theId ()

static UInt64	theVersionNumber ()

static makVre::DtVreMessage *	decode (char *buffer, int length)

static DebugMetaRegisterMessage *	createRegisterMessage (DtSimulationAddress addr, std::string displayName, std::string debugType, std::string debugMenuSection, bool enabled, DebugMetaRegisterMessage::Process proc)

static DebugMetaRegisterMessage *	createUnregisterMessage (DtSimulationAddress addr, std::string debugType)

Protected Member Functions
	DebugMetaRegisterMessage ()

virtual void	serialize (DtStreamWriter &writer) const override

virtual void	deserialize (DtStreamReader &reader) override

Protected Attributes
DebugMetaRegisterData	myData

Protected Attributes inherited from makVre::DtVreMessage
double	myDelay

UInt64	myApplicationId

UInt64	myVersion

Static Protected Attributes
static makVre::DtVreMessageId	theMessageId

static UInt64	theVersion

Member Enumeration Documentation

◆ Action

enum makVre::DebugMetaRegisterMessage::Action

Enumerator
Action_REGISTER
Action_UNREGISTER

◆ Process

enum makVre::DebugMetaRegisterMessage::Process

Enumerator
Process_VRE_APP
Process_VRF_APP
Process_VRE_SIM
Process_VRF_SIM

Constructor & Destructor Documentation

◆ ~DebugMetaRegisterMessage()

virtual makVre::DebugMetaRegisterMessage::~DebugMetaRegisterMessage ( )

overridevirtual

◆ DebugMetaRegisterMessage()

makVre::DebugMetaRegisterMessage::DebugMetaRegisterMessage ( )

protected

Referenced by create(), createFrom(), createFromData(), createRegisterMessage(), createUnregisterMessage(), and operator==().

Member Function Documentation

◆ create()

static DebugMetaRegisterMessage * makVre::DebugMetaRegisterMessage::create ( )

static

References DebugMetaRegisterMessage().

◆ createFrom()

static DebugMetaRegisterMessage * makVre::DebugMetaRegisterMessage::createFrom ( DebugMetaRegisterMessage * )

static

References DebugMetaRegisterMessage().

◆ createFromData()

static DebugMetaRegisterMessage * makVre::DebugMetaRegisterMessage::createFromData ( const DebugMetaRegisterData )

static

References DebugMetaRegisterMessage().

◆ theType()

static const std::string & makVre::DebugMetaRegisterMessage::theType ( )

static

static message identity functions

◆ theId()

static const makVre::DtVreMessageId & makVre::DebugMetaRegisterMessage::theId ( )

static

◆ theVersionNumber()

static UInt64 makVre::DebugMetaRegisterMessage::theVersionNumber ( )

static

◆ type()

virtual const std::string & makVre::DebugMetaRegisterMessage::type ( ) const

overridevirtual

Get the name of the message type.

Implements makVre::DtVreMessage.

◆ messageId()

virtual const makVre::DtVreMessageId & makVre::DebugMetaRegisterMessage::messageId ( ) const

overridevirtual

Gets the message ID object.

Returns: Reference to the message ID object

This pure virtual method must be implemented by derived classes to return a unique identifier object for the message. The message ID contains both the type name and a hash value for efficient routing.

Implements makVre::DtVreMessage.

◆ getSimulationAddress()

virtual const DtSimulationAddress & makVre::DebugMetaRegisterMessage::getSimulationAddress ( ) const

virtual

◆ setSimulationAddress()

virtual void makVre::DebugMetaRegisterMessage::setSimulationAddress ( const DtSimulationAddress & val )

virtual

◆ getDisplayName()

virtual const std::string & makVre::DebugMetaRegisterMessage::getDisplayName ( ) const

virtual

◆ setDisplayName()

virtual void makVre::DebugMetaRegisterMessage::setDisplayName ( const std::string & val )

virtual

◆ getDebugType()

virtual const std::string & makVre::DebugMetaRegisterMessage::getDebugType ( ) const

virtual

◆ setDebugType()

virtual void makVre::DebugMetaRegisterMessage::setDebugType ( const std::string & val )

virtual

◆ getDebugMenuSection()

virtual const std::string & makVre::DebugMetaRegisterMessage::getDebugMenuSection ( ) const

virtual

◆ setDebugMenuSection()

virtual void makVre::DebugMetaRegisterMessage::setDebugMenuSection ( const std::string & val )

virtual

◆ getShowInTable()

virtual bool makVre::DebugMetaRegisterMessage::getShowInTable ( ) const

virtual

◆ setShowInTable()

virtual void makVre::DebugMetaRegisterMessage::setShowInTable ( bool val )

virtual

◆ getAction()

virtual Action makVre::DebugMetaRegisterMessage::getAction ( ) const

virtual

◆ setAction()

virtual void makVre::DebugMetaRegisterMessage::setAction ( Action val )

virtual

◆ getEnabled()

virtual bool makVre::DebugMetaRegisterMessage::getEnabled ( ) const

virtual

◆ setEnabled()

virtual void makVre::DebugMetaRegisterMessage::setEnabled ( bool val )

virtual

◆ getProcess()

virtual Process makVre::DebugMetaRegisterMessage::getProcess ( ) const

virtual

◆ setProcess()

virtual void makVre::DebugMetaRegisterMessage::setProcess ( Process val )

virtual

◆ getExtraData()

virtual const std::vector< KeyValuePair > & makVre::DebugMetaRegisterMessage::getExtraData ( ) const

virtual

◆ setExtraData()

virtual void makVre::DebugMetaRegisterMessage::setExtraData ( const std::vector< KeyValuePair > & val )

virtual

◆ messageSize()

virtual int makVre::DebugMetaRegisterMessage::messageSize ( ) const

overridevirtual

Static decode function pattern for derived classes.

Note: Each derived class must implement a static decode function with the signature:
static DtVreMessage* decode(unsigned char* buffer, int length);

makVre::DebugMetaRegisterMessage::decode
static makVre::DtVreMessage * decode(char *buffer, int length)

makVre::DtVreMessage::DtVreMessage
DtVreMessage()
Default constructor.

This function is used by the message factory to create messages from raw data.

Gets the total size of the serialized message in bytes

Returns: Size of the message in bytes

This method calculates the total size of the message when serialized, including the base message header (message size, type hash, application ID, version, and delay) and any data added by derived classes.

Derived classes should override this method to include their own data size while calling the base class implementation.

Reimplemented from makVre::DtVreMessage.

◆ decode()

static makVre::DtVreMessage * makVre::DebugMetaRegisterMessage::decode	(	char *	buffer,
		int	length )

static

◆ getData() [1/2]

DebugMetaRegisterData makVre::DebugMetaRegisterMessage::getData ( )

◆ getData() [2/2]

DebugMetaRegisterData makVre::DebugMetaRegisterMessage::getData ( ) const

◆ operator==()

bool makVre::DebugMetaRegisterMessage::operator== ( const DebugMetaRegisterMessage & rhs ) const

References DebugMetaRegisterMessage().

◆ createRegisterMessage()

static DebugMetaRegisterMessage * makVre::DebugMetaRegisterMessage::createRegisterMessage	(	DtSimulationAddress	addr,
		std::string	displayName,
		std::string	debugType,
		std::string	debugMenuSection,
		bool	enabled,
		DebugMetaRegisterMessage::Process	proc )

static

References DebugMetaRegisterMessage().

◆ createUnregisterMessage()

static DebugMetaRegisterMessage * makVre::DebugMetaRegisterMessage::createUnregisterMessage	(	DtSimulationAddress	addr,
		std::string	debugType )

static

References DebugMetaRegisterMessage().

◆ serialize()

virtual void makVre::DebugMetaRegisterMessage::serialize ( DtStreamWriter & writer ) const

overrideprotectedvirtual

Serializes the message to a stream writer.

Parameters

writer Reference to the stream writer

This method writes the message header fields to the stream writer. Derived classes should override this method to add their own fields while calling the base class implementation.

Reimplemented from makVre::DtVreMessage.

◆ deserialize()

virtual void makVre::DebugMetaRegisterMessage::deserialize ( DtStreamReader & reader )

overrideprotectedvirtual

Deserializes the message from a stream reader.

Parameters

reader Reference to the stream reader

This method reads the message header fields from the stream reader. Derived classes should override this method to read their own fields while calling the base class implementation.

Reimplemented from makVre::DtVreMessage.

Member Data Documentation

◆ theMessageId

makVre::DtVreMessageId makVre::DebugMetaRegisterMessage::theMessageId

staticprotected

◆ theVersion

UInt64 makVre::DebugMetaRegisterMessage::theVersion

staticprotected

◆ myData

DebugMetaRegisterData makVre::DebugMetaRegisterMessage::myData

protected

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

include/utilities/vreDebugManager/debugMetaRegister.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Member Enumeration Documentation

◆ Action

◆ Process

Constructor & Destructor Documentation

◆ ~DebugMetaRegisterMessage()

◆ DebugMetaRegisterMessage()

Member Function Documentation

◆ create()

◆ createFrom()

◆ createFromData()

◆ theType()

◆ theId()

◆ theVersionNumber()

◆ type()

◆ messageId()

◆ getSimulationAddress()

◆ setSimulationAddress()

◆ getDisplayName()

◆ setDisplayName()

◆ getDebugType()

◆ setDebugType()

◆ getDebugMenuSection()

◆ setDebugMenuSection()

◆ getShowInTable()

◆ setShowInTable()

◆ getAction()

◆ setAction()

◆ getEnabled()

◆ setEnabled()

◆ getProcess()

◆ setProcess()

◆ getExtraData()

◆ setExtraData()

◆ messageSize()

◆ decode()

◆ getData() [1/2]

◆ getData() [2/2]

◆ operator==()

◆ createRegisterMessage()

◆ createUnregisterMessage()

◆ serialize()

◆ deserialize()

Member Data Documentation

◆ theMessageId

◆ theVersion

◆ myData