DtIfModifyVrfOverlay Class Reference

class DtIfModifyVrfOverlay More...

Inheritance diagram for DtIfModifyVrfOverlay:

List of all members.

Public Member Functions
	DtIfModifyVrfOverlay ()
	default DtIfModifyVrfOverlay
virtual	~DtIfModifyVrfOverlay ()
	destructor
	DtIfModifyVrfOverlay (const DtIfModifyVrfOverlay &orig)
	copy constructor
DtIfModifyVrfOverlay &	operator= (const DtIfModifyVrfOverlay &orig)
	assignment operator
virtual DtSimInterfaceContent *	clone () const
	Returns a newly created instance of a DtIfModifyVrfOverlay.
virtual int	type () const
	Returns the string type of message, DtModifyVrfOverlayMessageType (defined in msgTypes.h).
virtual void	setObjectIdentifier (const DtEntityIdentifier &objectIdentifier)
	Set/get object identifier of the vrf object to modify.
virtual const DtEntityIdentifier &	objectIdentifier () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	setUserData (char *userData, int iLen)
virtual const char *	userData () const
virtual int	userDataLen () const
virtual char	modificationFlags () const
bool	modifyColor () const
bool	modifyParent () const
bool	modifyUserData () const
bool	modifyAttachedTo () const
virtual void	printDataToString (DtString &str)
virtual void	setParentName (const DtString &parentName)
	All the mutators from DtIfCreateVrfObject are overridden here so that the value specified flags can be set.
virtual const DtString &	parentName () const
virtual void	setAttachmentInfo (const DtString &attachName, bool keepExisting)
	Set the attachment name of this overlay object.
virtual const DtString &	attachmentName () const
virtual bool	keepExistingAttachment () const
virtual void	setColor (int color)
	Set the color of the object.
virtual int	color () const
Static Public Member Functions
static DtSimInterfaceContent *	creator ()
Protected Attributes
DtEntityIdentifier	myObjectIdentifier
DtString	myParentName
DtString	myAttachmentName
bool	myKeepExistingAttachment
int	myColor
char *	myUserData
int	myUserDataLen
char	myModificationFlags

---

Detailed Description

class DtIfModifyVrfOverlay

Instances of DtIfModifyVrfOverlay are the message content for modify overlau object messages. The purpose of this message is to directly modify a DtVrfObject that has an overlay object state repository.

Content-Type: DtModifyVrfOverlayMessageType

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

global Id: The DtGlobalObjectDesignator of the object created.

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

color: The objects color (rgb) value

myParentName: The overlay layer that this object belongs to

myUserData: Blob of data associated with any user defined content

---

Constructor & Destructor Documentation

DtIfModifyVrfOverlay::DtIfModifyVrfOverlay

(

)

default DtIfModifyVrfOverlay

virtual DtIfModifyVrfOverlay::~DtIfModifyVrfOverlay

(

)

[virtual]

destructor

DtIfModifyVrfOverlay::DtIfModifyVrfOverlay

(

const DtIfModifyVrfOverlay &

orig

)

copy constructor

---

Member Function Documentation

DtIfModifyVrfOverlay& DtIfModifyVrfOverlay::operator=

(

const DtIfModifyVrfOverlay &

orig

)

assignment operator

virtual DtSimInterfaceContent* DtIfModifyVrfOverlay::clone

(

)

const [virtual]

Returns a newly created instance of a DtIfModifyVrfOverlay.

Implements DtSimInterfaceContent.

virtual int DtIfModifyVrfOverlay::type

(

)

const [virtual]

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

Implements DtSimInterfaceContent.

virtual void DtIfModifyVrfOverlay::setObjectIdentifier

(

const DtEntityIdentifier &

objectIdentifier

)

[virtual]

Set/get object identifier of the vrf object to modify.

virtual const DtEntityIdentifier& DtIfModifyVrfOverlay::objectIdentifier

(

)

const [virtual]

virtual int DtIfModifyVrfOverlay::netRepSize

(

)

const [virtual]

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfModifyVrfOverlay::setFromNet	(	const char *	contentBuffer,
		unsigned	contentSize
	)		[virtual]

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfModifyVrfOverlay::setToNet

(

)

[virtual]

Reimplemented from DtSimInterfaceContent.

virtual void DtIfModifyVrfOverlay::setUserData	(	char *	userData,
		int	iLen
	)		[virtual]

virtual const char* DtIfModifyVrfOverlay::userData

(

)

const [virtual]

virtual int DtIfModifyVrfOverlay::userDataLen

(

)

const [virtual]

char DtIfModifyVrfOverlay::modificationFlags

(

)

const [inline, virtual]

References myModificationFlags.

bool DtIfModifyVrfOverlay::modifyColor

(

)

const [inline]

References DtModifyOverlayAll, DtModifyOverlayColor, and myModificationFlags.

bool DtIfModifyVrfOverlay::modifyParent

(

)

const [inline]

References DtModifyOverlayAll, DtModifyOverlayParent, and myModificationFlags.

bool DtIfModifyVrfOverlay::modifyUserData

(

)

const [inline]

References DtModifyOverlayAll, DtModifyOverlayUserData, and myModificationFlags.

bool DtIfModifyVrfOverlay::modifyAttachedTo

(

)

const [inline]

References DtModifyOverlayAll, DtModifyOverlayAttachedTo, and myModificationFlags.

virtual void DtIfModifyVrfOverlay::printDataToString

(

DtString &

str

)

[virtual]

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfModifyVrfOverlay::creator

(

)

[static]

virtual void DtIfModifyVrfOverlay::setParentName

(

const DtString &

parentName

)

[virtual]

All the mutators from DtIfCreateVrfObject are overridden here so that the value specified flags can be set.

Set the parent name of this overlay object

virtual const DtString& DtIfModifyVrfOverlay::parentName

(

)

const [virtual]

virtual void DtIfModifyVrfOverlay::setAttachmentInfo	(	const DtString &	attachName,
		bool	keepExisting
	)		[virtual]

Set the attachment name of this overlay object.

virtual const DtString& DtIfModifyVrfOverlay::attachmentName

(

)

const [virtual]

virtual bool DtIfModifyVrfOverlay::keepExistingAttachment

(

)

const [virtual]

virtual void DtIfModifyVrfOverlay::setColor

(

int

color

)

[virtual]

Set the color of the object.

virtual int DtIfModifyVrfOverlay::color

(

)

const [virtual]

---

Member Data Documentation

DtEntityIdentifier DtIfModifyVrfOverlay::myObjectIdentifier [protected]

DtString DtIfModifyVrfOverlay::myParentName [protected]

DtString DtIfModifyVrfOverlay::myAttachmentName [protected]

bool DtIfModifyVrfOverlay::myKeepExistingAttachment [protected]

int DtIfModifyVrfOverlay::myColor [protected]

char* DtIfModifyVrfOverlay::myUserData [protected]

int DtIfModifyVrfOverlay::myUserDataLen [protected]

char DtIfModifyVrfOverlay::myModificationFlags [protected]

Referenced by modificationFlags(), modifyAttachedTo(), modifyColor(), modifyParent(), and modifyUserData().

---

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

• include/vrfmsgs/ifModVrfOvl.h