DtIfVrfObjectCreated Class Reference

class DtIfVrfObjectCreated: More...

Inheritance diagram for DtIfVrfObjectCreated:

Public Member Functions
	DtIfVrfObjectCreated ()
	default constructor More...
virtual	~DtIfVrfObjectCreated ()
	destructor More...
	DtIfVrfObjectCreated (const DtIfVrfObjectCreated &orig)
	copy constructor More...
DtIfVrfObjectCreated &	operator= (const DtIfVrfObjectCreated &orig)
	assignment operator More...
virtual DtSimInterfaceContent *	clone () const
	Returns a newly created instance of a DtIfVrfObjectCreated. More...
virtual int	type () const
	Returns the string type of message, DtVrfObjectResponseMessageType (defined in msgTypes.h). More...
virtual void	setObjectIdentifier (const DtEntityIdentifier &objectIdentifier)
	Set/get the object identifier (site:app:object id) of the vrf object. More...
virtual const DtEntityIdentifier &	objectIdentifier () const
virtual unsigned long	requestId () const
	Set/get the request Id for the message. More...
virtual void	setRequestId (unsigned long requestId)
virtual void	setMarkingText (const DtString &)
	Set/get the marking text of the vrf object. More...
virtual const DtString &	markingText () const
virtual void	setUUID (const DtUUID &)
	Set/get the object UUID of the vrf object. More...
virtual const DtUUID &	uuid () const
virtual void	setRequestedCreate (bool)
	Whether or not this is the object that was requested to be created. More...
virtual bool	requestedCreate () const
virtual void	setObjectType (const DtObjectType &)
	The object type of the object created. More...
virtual const DtObjectType &	objectType () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	printDataToString (DtString &str)
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
DtEntityIdentifier	myObjectIdentifier
DtU32	myRequestId
DtString	myMarkingText
DtUUID	myUUID
DtObjectType	myObjectType
bool	myRequestedCreate
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

Detailed Description

class DtIfVrfObjectCreated:

Instances of DtIfVrfObjectCreated are the message content for vrf object response messages. The purpose of this message is to let developers know when a VRF object is creaed

Content-Type: DtVrfObjectCreatedV2MessageType

Parameters: object type: The DtObjectType of the object created.

object identifier: The object’s DtEntityIdentifer (site id: app id: object num).

object name: The object’s unique DtString name.

Constructor & Destructor Documentation

DtIfVrfObjectCreated::DtIfVrfObjectCreated

(

)

default constructor

virtual DtIfVrfObjectCreated::~DtIfVrfObjectCreated ( )

virtual

destructor

DtIfVrfObjectCreated::DtIfVrfObjectCreated

(

const DtIfVrfObjectCreated &

orig

)

copy constructor

Member Function Documentation

DtIfVrfObjectCreated& DtIfVrfObjectCreated::operator=

(

const DtIfVrfObjectCreated &

orig

)

assignment operator

virtual DtSimInterfaceContent* DtIfVrfObjectCreated::clone ( ) const

virtual

Returns a newly created instance of a DtIfVrfObjectCreated.

Implements DtSimInterfaceContent.

virtual int DtIfVrfObjectCreated::type ( ) const

virtual

Returns the string type of message, DtVrfObjectResponseMessageType (defined in msgTypes.h).

Implements DtSimInterfaceContent.

virtual void DtIfVrfObjectCreated::setObjectIdentifier ( const DtEntityIdentifier &  objectIdentifier )

virtual

Set/get the object identifier (site:app:object id) of the vrf object.

Corresponds to entity identifier for individual entities, aggregate Id for aggregates, and object identifier for environmental process objects.

virtual const DtEntityIdentifier& DtIfVrfObjectCreated::objectIdentifier ( ) const

virtual

virtual unsigned long DtIfVrfObjectCreated::requestId ( ) const

virtual

Set/get the request Id for the message.

Request Id is used to associate this message with the DtIfCreateVrfObject message.

virtual void DtIfVrfObjectCreated::setRequestId ( unsigned long  requestId )

virtual

virtual void DtIfVrfObjectCreated::setMarkingText ( const DtString &  )

virtual

Set/get the marking text of the vrf object.

virtual const DtString& DtIfVrfObjectCreated::markingText ( ) const

virtual

virtual void DtIfVrfObjectCreated::setUUID ( const DtUUID &  )

virtual

Set/get the object UUID of the vrf object.

virtual const DtUUID& DtIfVrfObjectCreated::uuid ( ) const

virtual

virtual void DtIfVrfObjectCreated::setRequestedCreate ( bool  )

virtual

Whether or not this is the object that was requested to be created.

This will be false if the object being created is the subordinate of a requested aggregate to be created

virtual bool DtIfVrfObjectCreated::requestedCreate ( ) const

virtual

virtual void DtIfVrfObjectCreated::setObjectType ( const DtObjectType &  )

virtual

The object type of the object created.

virtual const DtObjectType& DtIfVrfObjectCreated::objectType ( ) const

virtual

virtual int DtIfVrfObjectCreated::netRepSize ( ) const

virtual

Reimplemented from DtSimInterfaceContent.

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

virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfVrfObjectCreated::setToNet ( )

virtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfVrfObjectCreated::printDataToString ( DtString &  str )

virtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfVrfObjectCreated::creator ( )

static

Member Data Documentation

DtEntityIdentifier DtIfVrfObjectCreated::myObjectIdentifier

protected

DtU32 DtIfVrfObjectCreated::myRequestId

protected

DtString DtIfVrfObjectCreated::myMarkingText

protected

DtUUID DtIfVrfObjectCreated::myUUID

protected

DtObjectType DtIfVrfObjectCreated::myObjectType

protected

bool DtIfVrfObjectCreated::myRequestedCreate

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfmsgs/ifVrfObjectCreated.h