DtIfModifyVrfOverlay Class Reference

class DtIfModifyVrfOverlay

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

Content-Type: DtModifyVrfOverlayMessageType

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

global Id: The DtGlobalObjectDesignator of the object created.

object identifier: The object’s DtUUID

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

Inheritance diagram for DtIfModifyVrfOverlay:

Public Member Functions
	DtIfModifyVrfOverlay ()
virtual	~DtIfModifyVrfOverlay () override
	DtIfModifyVrfOverlay (const DtIfModifyVrfOverlay &orig)
DtIfModifyVrfOverlay &	operator= (const DtIfModifyVrfOverlay &orig)
virtual DtSimInterfaceContent *	clone () const override
virtual int	type () const override
virtual void	setObjectToModify (const DtUUID &)
virtual const DtUUID &	objectToModify () const
virtual int	netRepSize () const override
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize) override
virtual bool	setToNet () override
virtual void	setUserData (char *userData, int iLen)
virtual const char *	userData () const
virtual int	userDataLen () const
virtual char	modificationFlags () const
bool	modifyColor () const
bool	modifyOverlay () const
bool	modifyUserData () const
bool	modifyAttachedTo () const
virtual void	printDataToString (DtString &str) override
virtual void	setOverlay (const DtString &overlay)
virtual const DtString &	overlay () const
virtual void	setAttachmentInfo (const DtUUID &attachment, bool keepExisting)
virtual const DtUUID &	attachment () const
virtual bool	keepExistingAttachment () const
virtual void	setColor (int color)
virtual int	color () const
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
DtUUID	myObjectToModify
DtString	myOverlay
DtUUID	myAttachment
bool	myKeepExistingAttachment
int	myColor
char *	myUserData
int	myUserDataLen
int	myModificationFlags
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

DtIfModifyVrfOverlay::DtIfModifyVrfOverlay

(

)

default DtIfModifyVrfOverlay

virtual DtIfModifyVrfOverlay::~DtIfModifyVrfOverlay ( )

overridevirtual

destructor

DtIfModifyVrfOverlay::DtIfModifyVrfOverlay

(

const DtIfModifyVrfOverlay &

orig

)

copy constructor

Member Function Documentation

DtIfModifyVrfOverlay& DtIfModifyVrfOverlay::operator=

(

const DtIfModifyVrfOverlay &

orig

)

assignment operator

virtual DtSimInterfaceContent* DtIfModifyVrfOverlay::clone ( ) const

overridevirtual

Returns a newly created instance of a DtIfModifyVrfOverlay.

Implements DtSimInterfaceContent.

virtual int DtIfModifyVrfOverlay::type ( ) const

overridevirtual

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

Implements DtSimInterfaceContent.

virtual void DtIfModifyVrfOverlay::setObjectToModify ( const DtUUID &  )

virtual

Set/get object identifier of the vrf object to modify. Was: setObjectIdentifier.

virtual const DtUUID& DtIfModifyVrfOverlay::objectToModify ( ) const

virtual

Was: objectIdentifier.

virtual int DtIfModifyVrfOverlay::netRepSize ( ) const

overridevirtual

Reimplemented from DtSimInterfaceContent.

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

overridevirtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfModifyVrfOverlay::setToNet ( )

overridevirtual

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

inlinevirtual

References myModificationFlags.

bool DtIfModifyVrfOverlay::modifyColor ( ) const

inline

References DtModifyOverlayAll, DtModifyOverlayColor, and myModificationFlags.

bool DtIfModifyVrfOverlay::modifyOverlay ( ) 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 )

overridevirtual

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfModifyVrfOverlay::creator ( )

static

virtual void DtIfModifyVrfOverlay::setOverlay ( const DtString &  overlay )

virtual

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

Set the parent overlay of this overlay object Was: setParentName

virtual const DtString& DtIfModifyVrfOverlay::overlay ( ) const

virtual

Was: parentName.

virtual void DtIfModifyVrfOverlay::setAttachmentInfo ( const DtUUID &  attachment, bool  keepExisting  )

virtual

Set the attachment object of this overlay object.

virtual const DtUUID& DtIfModifyVrfOverlay::attachment ( ) const

virtual

Was: attachmentName.

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

DtUUID DtIfModifyVrfOverlay::myObjectToModify

protected

DtString DtIfModifyVrfOverlay::myOverlay

protected

DtUUID DtIfModifyVrfOverlay::myAttachment

protected

bool DtIfModifyVrfOverlay::myKeepExistingAttachment

protected

int DtIfModifyVrfOverlay::myColor

protected

char* DtIfModifyVrfOverlay::myUserData

protected

int DtIfModifyVrfOverlay::myUserDataLen

protected

int DtIfModifyVrfOverlay::myModificationFlags

protected

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

---

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

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