DtIfVrfObjectCreated Class Reference

class DtIfVrfObjectCreated: More...

Inheritance diagram for DtIfVrfObjectCreated:

Public Member Functions
	DtIfVrfObjectCreated ()
	default constructor
virtual	~DtIfVrfObjectCreated ()
	destructor
	DtIfVrfObjectCreated (const DtIfVrfObjectCreated &orig)
	copy constructor
DtIfVrfObjectCreated &	operator= (const DtIfVrfObjectCreated &orig)
	assignment operator
virtual DtSimInterfaceContent *	clone () const
	Returns a newly created instance of a DtIfVrfObjectCreated.
virtual int	type () const
	Returns the string type of message, DtVrfObjectResponseMessageType (defined in msgTypes.h).
virtual void	setObjectIdentifier (const DtEntityIdentifier &objectIdentifier)
	Set/get the object identifier (site:app:object id) of the vrf object.
virtual const DtEntityIdentifier &	objectIdentifier () const
virtual unsigned long	requestId () const
	Set/get the request Id for the message.
virtual void	setRequestId (unsigned long requestId)
virtual void	setObjectName (const DtString &objectName)
	Set/get the object name of the vrf object.
virtual const DtString &	objectName () const
virtual void	setRequestedCreate (bool)
	Whether or not this is the object that was requested to be created.
virtual bool	requestedCreate () const
virtual void	setObjectType (const DtObjectType &)
	The object type of the object created.
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)

Static Public Member Functions
static DtSimInterfaceContent *	creator ()

Protected Attributes
DtEntityIdentifier	myObjectIdentifier
DtU32	myRequestId
DtString	myObjectName
DtObjectType	myObjectType
bool	myRequestedCreate

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.

virtual int DtIfVrfObjectCreated::type ( ) const

virtual

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

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::setObjectName ( const DtString &  objectName )

virtual

Set/get the object name of the vrf object.

virtual const DtString& DtIfVrfObjectCreated::objectName ( ) 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

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

virtual

virtual bool DtIfVrfObjectCreated::setToNet ( )

virtual

virtual void DtIfVrfObjectCreated::printDataToString ( DtString &  str )

virtual

static DtSimInterfaceContent* DtIfVrfObjectCreated::creator ( )

static

Member Data Documentation

DtEntityIdentifier DtIfVrfObjectCreated::myObjectIdentifier

protected

DtU32 DtIfVrfObjectCreated::myRequestId

protected

DtString DtIfVrfObjectCreated::myObjectName

protected

DtObjectType DtIfVrfObjectCreated::myObjectType

protected

bool DtIfVrfObjectCreated::myRequestedCreate

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmsgs/ifVrfObjectCreated.h