VR-Forces 4.2 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes
DtIfVrfObjectCreated Class Reference

Total: 16 bytes. More...

Inheritance diagram for DtIfVrfObjectCreated:
Inheritance graph
[legend]

Public Member Functions

 DtIfVrfObjectCreated ()
 default constructor
virtual ~DtIfVrfObjectCreated ()
 destructor
 DtIfVrfObjectCreated (const DtIfVrfObjectCreated &orig)
 copy constructor
DtIfVrfObjectCreatedoperator= (const DtIfVrfObjectCreated &orig)
 assignment operator
virtual DtSimInterfaceContentclone () 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 DtStringobjectName () 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 DtSimInterfaceContentcreator ()

Protected Attributes

DtEntityIdentifier myObjectIdentifier
DtU32 myRequestId
DtString myObjectName

Detailed Description

Total: 16 bytes.

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 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

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

Document ID: Generated on Sun Nov 24 19:49:21 EST 2013 from SVN revision 133924
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)