DtIfModifyVrfObject Class Reference

class DtIfModifyVrfObject:

Instances of DtIfModifyVrfObject are the message content for modify vrf object messages. The purpose of this message is to directly modify a DtSimObject. For example, if you want to modify a control object’s label, or add a vertex to its object geometry, you would send this message. Do not send this message to modify the object name of organized entities (objects configured with an Organization Manager). Go through the object’s organization manager instead.

Content-Type: DtModifyVrfObjectMessageType

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

global Id: The DtGlobalObjectDesignator of the object created.

object identifier: The object’s DtUUID

vertices: The DtList of vertices in database coordinates, that make up the object’s geometry.

object name: The object’s unique DtString name.

object label: A DtString label associated with the object (not required to be unique).

force type: The DtForceType of the object (from disEnums.h).

closed figure: A bool flag indicating whether vertices making up the object’s geometry form a closed figure or not.

projection: A bool flag indicating whether the object’s geometry is projected (the z-coordinate is meaningless).

overlay parent: The overlay this object belongs to.

Inheritance diagram for DtIfModifyVrfObject:

Public Member Functions
	DtIfModifyVrfObject ()
virtual	~DtIfModifyVrfObject ()
	DtIfModifyVrfObject (const DtIfModifyVrfObject &orig)
DtIfModifyVrfObject &	operator= (const DtIfModifyVrfObject &orig)
virtual DtSimInterfaceContent *	clone () const
virtual int	type () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	printDataToString (DtString &str)
virtual bool	isNameSpecified () const
virtual bool	isForceTypeSpecified () const
virtual bool	isObjectLabelSpecified () const
virtual bool	isHeadingSpecified () const
virtual bool	isClosedFigureSpecified () const
virtual bool	isProjectionSpecified () const
virtual bool	isObjectGeometrySpecified () const
virtual bool	isAppearanceSpecified () const
virtual bool	isOverlayParentSpecified () const
virtual bool	isExtendedDataSpecified () const
virtual bool	isExtendedLabelsSpecified () const
virtual bool	isUserDataSpecified () const
virtual void	setMarkingText (const DtString &objectName)
virtual void	setObjectType (const DtObjectType &objectType)
virtual void	setForceType (const DtForceType forceType)
virtual void	setObjectLabel (const DtString &objectLabel)
virtual void	setPosition (const DtVector &position)
virtual void	setOverlayParent (const DtString &overlayParent)
virtual void	setHeading (DtReal heading)
virtual void	addVertex (const DtVector &vertex)
virtual void	setProjection (bool projection)
virtual void	setClosedFigure (bool closedFigure)
virtual void	setAppearance (const DtAppearance &appearance)
virtual void	setUserData (const DtString &userData)
virtual void	setExtendedData (const std::map< std::string, std::string > &userData)
virtual void	setExtendedData (const DtString &keyword, const DtString &data)
virtual void	setExtendedLabels (const std::map< int, DtString > &extendedLabels)
virtual void	setMergeExtendedData (bool)
virtual bool	mergeExtendedData () const
void	setStartPosition (const DtVector &position)
void	setEndPosition (const DtVector &position)
Public Member Functions inherited from DtIfCreateVrfObject
	DtIfCreateVrfObject ()
virtual	~DtIfCreateVrfObject ()
	DtIfCreateVrfObject (const DtIfCreateVrfObject &orig)
DtIfCreateVrfObject &	operator= (const DtIfCreateVrfObject &orig)
virtual unsigned long	requestId () const
virtual void	setRequestId (unsigned long requestId)
virtual void	setUUID (const DtUUID &)
virtual const DtUUID &	uuid () const
virtual void	setVrfProcessAddress (const DtSimulationAddress &address)
virtual const DtSimulationAddress &	vrfProcessAddress () const
virtual const DtString &	markingText () const
virtual void	setMarkingTextPrefix (const DtString &objectName)
virtual const DtString &	markingTextPrefix () const
virtual const DtObjectType &	objectType () const
virtual DtForceType	forceType () const
virtual const DtString &	objectLabel () const
virtual const std::map< int, DtString > &	extendedLabels () const
virtual const DtString &	overlayParent () const
virtual DtVector	position () const
virtual DtReal	heading () const
virtual DtReal	pitch () const
virtual void	setPitch (DtReal pitch)
virtual bool	isPitchSpecified () const
virtual void	clearPitchSpecified ()
virtual const std::vector < DtVector > &	vertexList () const
virtual const std::vector < DtVector > &	vertices () const
virtual void	setVertices (const std::vector< DtVector > &vertices)
virtual void	setVertices (const DtList &vertices)
virtual bool	projection () const
virtual bool	closedFigure () const
virtual DtAppearance	appearance () const
virtual bool	createSubObjects () const
virtual void	setCreateSubObjects (bool createSubObjects)
virtual bool	addToOrganization () const
virtual void	setAddToOrganization (bool addToOrg)
virtual bool	clampToGround () const
virtual void	setClampToGround (bool clamp)
virtual DtAggregateState	initialAggregateState () const
virtual void	setInitialAggregateState (DtAggregateState aggregateState)
virtual const std::list < DtAdminContent * > &	initialAdminContent () const
virtual void	setInitialAdminContent (const std::list< DtAdminContent * > &adminContent)
virtual void	addInitialAdminContent (DtAdminContent *adminContent)
virtual const std::list < DtSimInterfaceContent * > &	initialInterfaceContent () const
virtual void	setInitialInterfaceContent (const std::list< DtSimInterfaceContent * > &adminContent)
virtual void	addInitialInterfaceContent (DtSimInterfaceContent *adminContent)
virtual void	setAddToOrbat (bool)
virtual bool	addToOrbat () const
virtual void	setSuperior (const DtUUID &)
virtual const DtUUID &	superior () const
void	setStartPosition (const DtVector &position)
DtVector	startPosition () const
void	setEndPosition (const DtVector &position)
DtVector	endPosition () const
virtual void	setExtendedData (const std::map< DtString, DtString > &)
virtual const std::map < std::string, std::string > &	extendedData () const
virtual DtString	userData () const
virtual bool	isValid () const
virtual DtString	initialFormation () const
virtual void	setInitialFormation (const DtString &formation)
virtual bool	publishObject () const
virtual void	setPublishObject (bool)
virtual bool	connectToRadioNetwork () const
virtual void	setConnectToRadioNetwork (bool)
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 DtIfCreateVrfObject
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	myObjectIdentifier
bool	myNameSpecified
bool	myObjectTypeSpecified
bool	myForceTypeSpecified
bool	myObjectLabelSpecified
bool	myOverlayParentSpecified
bool	myHeadingSpecified
bool	myClosedFigureSpecified
bool	myProjectionSpecified
bool	myObjectGeometrySpecified
bool	myAppearanceSpecified
bool	myUserDataSpecified
bool	myExtendedDataSpecified
bool	myExtendedLabelsSpecified
bool	myMergeExtendedData
Protected Attributes inherited from DtIfCreateVrfObject
DtLocalObjectCreateInformation	myLocalObjectCreateInformation
DtSimulationAddress	myVrfProcessAddress
bool	myPitchSpecified
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

DtIfModifyVrfObject::DtIfModifyVrfObject

(

)

default constructor

virtual DtIfModifyVrfObject::~DtIfModifyVrfObject ( )

virtual

destructor

DtIfModifyVrfObject::DtIfModifyVrfObject

(

const DtIfModifyVrfObject &

orig

)

copy constructor

Member Function Documentation

DtIfModifyVrfObject& DtIfModifyVrfObject::operator=

(

const DtIfModifyVrfObject &

orig

)

assignment operator

virtual DtSimInterfaceContent* DtIfModifyVrfObject::clone ( ) const

virtual

Returns a newly created instance of a DtIfModifyVrfObject.

Reimplemented from DtIfCreateVrfObject.

virtual int DtIfModifyVrfObject::type ( ) const

virtual

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

Reimplemented from DtIfCreateVrfObject.

virtual int DtIfModifyVrfObject::netRepSize ( ) const

virtual

Reimplemented from DtIfCreateVrfObject.

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

virtual

Reimplemented from DtIfCreateVrfObject.

virtual bool DtIfModifyVrfObject::setToNet ( )

virtual

Reimplemented from DtIfCreateVrfObject.

virtual void DtIfModifyVrfObject::printDataToString ( DtString &  str )

virtual

Reimplemented from DtIfCreateVrfObject.

static DtSimInterfaceContent* DtIfModifyVrfObject::creator ( )

static

virtual bool DtIfModifyVrfObject::isNameSpecified ( ) const

virtual

Accessors for the value specified flags.

virtual bool DtIfModifyVrfObject::isForceTypeSpecified ( ) const

virtual

virtual bool DtIfModifyVrfObject::isObjectLabelSpecified ( ) const

virtual

virtual bool DtIfModifyVrfObject::isHeadingSpecified ( ) const

virtual

virtual bool DtIfModifyVrfObject::isClosedFigureSpecified ( ) const

virtual

virtual bool DtIfModifyVrfObject::isProjectionSpecified ( ) const

virtual

virtual bool DtIfModifyVrfObject::isObjectGeometrySpecified ( ) const

virtual

virtual bool DtIfModifyVrfObject::isAppearanceSpecified ( ) const

virtual

virtual bool DtIfModifyVrfObject::isOverlayParentSpecified ( ) const

virtual

virtual bool DtIfModifyVrfObject::isExtendedDataSpecified ( ) const

virtual

virtual bool DtIfModifyVrfObject::isExtendedLabelsSpecified ( ) const

virtual

virtual bool DtIfModifyVrfObject::isUserDataSpecified ( ) const

virtual

virtual void DtIfModifyVrfObject::setMarkingText ( const DtString &  objectName )

virtual

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

Set the object name of the vrf object to create.

Reimplemented from DtIfCreateVrfObject.

virtual void DtIfModifyVrfObject::setObjectType ( const DtObjectType &  objectType )

virtual

Set the object type of the vrf object to create.

Reimplemented from DtIfCreateVrfObject.

virtual void DtIfModifyVrfObject::setForceType ( const DtForceType  forceType )

virtual

Set the force type of the vrf object to create.

Reimplemented from DtIfCreateVrfObject.

virtual void DtIfModifyVrfObject::setObjectLabel ( const DtString &  objectLabel )

virtual

Set the object label of the vrf object to create.

Reimplemented from DtIfCreateVrfObject.

virtual void DtIfModifyVrfObject::setPosition ( const DtVector &  position )

virtual

In local (database) coordinates.

Reimplemented from DtIfCreateVrfObject.

virtual void DtIfModifyVrfObject::setOverlayParent ( const DtString &  overlayParent )

virtual

Sets the overlay parent of this object.

Reimplemented from DtIfCreateVrfObject.

virtual void DtIfModifyVrfObject::setHeading ( DtReal  heading )

virtual

0 is north, clockwise, in radians.

Reimplemented from DtIfCreateVrfObject.

virtual void DtIfModifyVrfObject::addVertex ( const DtVector &  vertex )

virtual

This is where the actually object geometry goes position() is just an alias for the first vertex.

Reimplemented from DtIfCreateVrfObject.

virtual void DtIfModifyVrfObject::setProjection ( bool  projection )

virtual

Do the Z elements of the vectors in the vertex list have meaning?

Reimplemented from DtIfCreateVrfObject.

virtual void DtIfModifyVrfObject::setClosedFigure ( bool  closedFigure )

virtual

Does the last vertex connect back to the first? Obviously, this is undefined for a single vertex (but I suppose an argument could be made for that being a closed figure...)

Reimplemented from DtIfCreateVrfObject.

virtual void DtIfModifyVrfObject::setAppearance ( const DtAppearance &  appearance )

virtual

Appearance.

Reimplemented from DtIfCreateVrfObject.

virtual void DtIfModifyVrfObject::setUserData ( const DtString &  userData )

virtual

Reimplemented from DtIfCreateVrfObject.

virtual void DtIfModifyVrfObject::setExtendedData ( const std::map< std::string, std::string > &  userData )

virtual

Reimplemented from DtIfCreateVrfObject.

virtual void DtIfModifyVrfObject::setExtendedData ( const DtString &  keyword, const DtString &  data  )

virtual

Reimplemented from DtIfCreateVrfObject.

virtual void DtIfModifyVrfObject::setExtendedLabels ( const std::map< int, DtString > &  extendedLabels )

virtual

Set/get the object label of the vrf object to create.

Reimplemented from DtIfCreateVrfObject.

virtual void DtIfModifyVrfObject::setMergeExtendedData ( bool  )

virtual

Sets whether or not extended data is to be merged with existing data or simply replace existing extended data. Default is to merge.

virtual bool DtIfModifyVrfObject::mergeExtendedData ( ) const

virtual

void DtIfModifyVrfObject::setStartPosition

(

const DtVector &

position

)

These are here for back compatibility and should be removed after the next release.

void DtIfModifyVrfObject::setEndPosition

(

const DtVector &

position

)

Member Data Documentation

DtUUID DtIfModifyVrfObject::myObjectIdentifier

protected

bool DtIfModifyVrfObject::myNameSpecified

protected

bool DtIfModifyVrfObject::myObjectTypeSpecified

protected

bool DtIfModifyVrfObject::myForceTypeSpecified

protected

bool DtIfModifyVrfObject::myObjectLabelSpecified

protected

bool DtIfModifyVrfObject::myOverlayParentSpecified

protected

bool DtIfModifyVrfObject::myHeadingSpecified

protected

bool DtIfModifyVrfObject::myClosedFigureSpecified

protected

bool DtIfModifyVrfObject::myProjectionSpecified

protected

bool DtIfModifyVrfObject::myObjectGeometrySpecified

protected

bool DtIfModifyVrfObject::myAppearanceSpecified

protected

bool DtIfModifyVrfObject::myUserDataSpecified

protected

bool DtIfModifyVrfObject::myExtendedDataSpecified

protected

bool DtIfModifyVrfObject::myExtendedLabelsSpecified

protected

bool DtIfModifyVrfObject::myMergeExtendedData

protected

---

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

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