DtIfDeliverVrfObjectMessage Class Reference

This interface content holds a DtVrfObjectMessage subclass for delivery of the object message over the network. This allows a DtVrfObjectMessage to be packaged inside an interface message, and then transmitted via the standard interface message mechanism.

Inheritance diagram for DtIfDeliverVrfObjectMessage:

Public Member Functions
	DtIfDeliverVrfObjectMessage ()
	DtIfDeliverVrfObjectMessage (const DtIfDeliverVrfObjectMessage &orig)
const DtIfDeliverVrfObjectMessage &	operator= (const DtIfDeliverVrfObjectMessage &orig)
virtual	~DtIfDeliverVrfObjectMessage ()
virtual int	type () const
virtual DtSimInterfaceContent *	clone () const
virtual DtVrfObjectMessage *	radioMessage () const
virtual void	setRadioMessage (DtVrfObjectMessage *message)
virtual void	printDataToString (DtString &str)
virtual DtVrfObjectMessage *	vrfObjectMessage () const
virtual void	setVrfObjectMessage (DtVrfObjectMessage *message)
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
Public Member Functions inherited from DtSimInterfaceContent
virtual	~DtSimInterfaceContent ()
virtual bool	update (const DtSimInterfaceContent *data)
virtual char *	netRep ()
virtual void	printContentType (DtString &str)
virtual void	setUseSessionId (bool yesNo)
virtual bool	useSessionId () const

Static Public Member Functions
static DtSimInterfaceContent *	creator ()
Static Public Member Functions inherited from DtSimInterfaceContent
static DtSimInterfaceContent *	createInterfaceContent (int type)
static void	addInterfaceContentCreatorFcn (int type, DtInterfaceContentCreatorFcn fcn)
static void	setFactory (DtInterfaceContentFactory *factory)
static DtInterfaceContentFactory *	factory ()
static void	registerContentTypePrinter (DtSimInterfaceContentTypePrinterFcn printFcn)

Protected Attributes
DtVrfObjectMessage *	myVrfObjectMessage
bool	myOwnVrfObjectMessage
Protected Attributes inherited from DtSimInterfaceContent
char *	myNetRep
bool	myUseSessionId

Additional Inherited Members
Protected Member Functions inherited from DtSimInterfaceContent
	DtSimInterfaceContent ()
	DtSimInterfaceContent (const DtSimInterfaceContent &orig)
const DtSimInterfaceContent &	operator= (const DtSimInterfaceContent &orig)
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactory *	myFactory
static DtSimInterfaceContentTypePrinterFcn	theContentTypePrinterFcn

Constructor & Destructor Documentation

DtIfDeliverVrfObjectMessage::DtIfDeliverVrfObjectMessage

(

)

default constructor

DtIfDeliverVrfObjectMessage::DtIfDeliverVrfObjectMessage

(

const DtIfDeliverVrfObjectMessage &

orig

)

copy constructor

Note

Creates a copy of the contained DtVrfObjectMessage.

virtual DtIfDeliverVrfObjectMessage::~DtIfDeliverVrfObjectMessage ( )

virtual

Member Function Documentation

const DtIfDeliverVrfObjectMessage& DtIfDeliverVrfObjectMessage::operator=

(

const DtIfDeliverVrfObjectMessage &

orig

)

assignment operator

Note

Creates a copy of the contained DtVrfObjectMessage.

virtual int DtIfDeliverVrfObjectMessage::type ( ) const

virtual

Returns the type of Interface Content; DtDeliverVrfObjectMessageType.

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfDeliverVrfObjectMessage::clone ( ) const

virtual

Returns

A new copy of this interface content.

Note

Creates a copy of the contained DtVrfObjectMessage.

Implements DtSimInterfaceContent.

virtual DtVrfObjectMessage* DtIfDeliverVrfObjectMessage::radioMessage ( ) const

virtual

Same as vrfObjectMessage().

Deprecated:

For API compatibility only.

virtual void DtIfDeliverVrfObjectMessage::setRadioMessage ( DtVrfObjectMessage *  message )

virtual

Same as setVrfObjectMessage().

Deprecated:

For API compatibility only.

virtual DtVrfObjectMessage* DtIfDeliverVrfObjectMessage::vrfObjectMessage ( ) const

virtual

The DtVrfObjectMessage contained by this interface message.

Note

Does not clone the object message, but only holds a pointer to it. The caller must ensure that the message exists for the existence of this interface content. Since the clone operator also clones the contained messages, the caller only needs to worry about this instance of the interface content and not any clones or copies.

virtual void DtIfDeliverVrfObjectMessage::setVrfObjectMessage ( DtVrfObjectMessage *  message )

virtual

The DtVrfObjectMessage contained by this interface message.

Note

Does not clone the object message, but only holds a pointer to it. The caller must ensure that the message exists for the existence of this interface content. Since the clone operator also clones the contained messages, the caller only needs to worry about this instance of the interface content and not any clones or copies.

virtual int DtIfDeliverVrfObjectMessage::netRepSize ( ) const

virtual

For network serialization.

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfDeliverVrfObjectMessage::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

virtual

For network serialization.

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfDeliverVrfObjectMessage::setToNet ( )

virtual

For network serialization.

Reimplemented from DtSimInterfaceContent.

virtual void DtIfDeliverVrfObjectMessage::printDataToString ( DtString &  str )

virtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfDeliverVrfObjectMessage::creator ( )

static

Member Data Documentation

DtVrfObjectMessage* DtIfDeliverVrfObjectMessage::myVrfObjectMessage

protected

bool DtIfDeliverVrfObjectMessage::myOwnVrfObjectMessage

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfmsgs/ifDeliverVrfObjectMessage.h