Inheritance diagram for DtIfModifyVrfObject:

Public Member Functions
	DtIfModifyVrfObject ()
	default constructor
virtual	~DtIfModifyVrfObject ()
	destructor
	DtIfModifyVrfObject (const DtIfModifyVrfObject &orig)
	copy constructor
DtIfModifyVrfObject &	operator= (const DtIfModifyVrfObject &orig)
	assignment operator
virtual DtSimInterfaceContent *	clone () const
	Returns a newly created instance of a DtIfModifyVrfObject.
virtual int	type () const
	Returns the string type of message, DtModifyVrfObjectMessageType (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	printDataToString (DtString &str)
virtual bool	isNameSpecified ()
	Accessors for the value specified flags.
virtual bool	isObjectTypeSpecified ()
virtual bool	isForceTypeSpecified ()
virtual bool	isObjectLabelSpecified ()
virtual bool	isHeadingSpecified ()
virtual bool	isClosedFigureSpecified ()
virtual bool	isProjectionSpecified ()
virtual bool	isObjectGeometrySpecified ()
virtual bool	isAppearanceSpecified ()
virtual bool	isOverlayParentSpecified ()
virtual bool	isUserDataSpecified ()
virtual void	setObjectName (const DtString &objectName)
	All the mutators from DtIfCreateVrfObject are overridden here so that the value specified flags can be set.
virtual void	setObjectType (const DtObjectType &objectType)
	Set the object type of the vrf object to create.
virtual void	setForceType (const DtForceType forceType)
	Set the force type of the vrf object to create.
virtual void	setObjectLabel (const DtString &objectLabel)
	Set the object label of the vrf object to create.
virtual void	setPosition (const DtVector &position)
	In local (database) coordinates.
virtual void	setOverlayParent (const DtString &overlayParent)
	Sets the overlay parent of this object.
virtual const DtString &	overlayParent () const
virtual void	setHeading (DtReal heading)
	0 is north, clockwise, in radians.
virtual void	addVertex (const DtVector &vertex)
	This is where the actually object geometry goes position() is just an alias for the first vertex.
virtual void	setProjection (bool projection)
	Do the Z elements of the vectors in the vertex list have meaning?
virtual void	setClosedFigure (bool closedFigure)
	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...)
virtual void	setAppearance (const DtAppearance &appearance)
	Appearance.
virtual void	setUserData (const DtString &userData)
void	setStartPosition (const DtVector &position)
	These are here for back compatibility and should be removed after the next release.
void	setEndPosition (const DtVector &position)
void	setName (const DtString &name)
Static Public Member Functions
static DtSimInterfaceContent *	creator ()
Protected Attributes
DtEntityIdentifier	myObjectIdentifier
bool	myNameSpecified
bool	myObjectTypeSpecified
bool	myForceTypeSpecified
bool	myObjectLabelSpecified
bool	myOverlayParentSpecified
bool	myHeadingSpecified
bool	myClosedFigureSpecified
bool	myProjectionSpecified
bool	myObjectGeometrySpecified
bool	myAppearanceSpecified
bool	myUserDataSpecified
DtString	myOverlayParent

Detailed Description

class DtIfModifyVrfObject:

Instances of DtIfModifyVrfObject are the message content for modify vrf object messages. The purpose of this message is to directly modify a DtVrfObject. 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 DtEntityIdentifer (site id: app id: object num).

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.

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 void DtIfModifyVrfObject::setObjectIdentifier ( const DtEntityIdentifier & objectIdentifier ) [virtual]

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

virtual const DtEntityIdentifier& DtIfModifyVrfObject::objectIdentifier ( ) const [virtual]

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]

Reimplemented from DtIfCreateVrfObject.

virtual bool DtIfModifyVrfObject::isNameSpecified ( ) [virtual]

Accessors for the value specified flags.

virtual bool DtIfModifyVrfObject::isObjectTypeSpecified ( ) [virtual]

virtual bool DtIfModifyVrfObject::isForceTypeSpecified ( ) [virtual]

virtual bool DtIfModifyVrfObject::isObjectLabelSpecified ( ) [virtual]

virtual bool DtIfModifyVrfObject::isHeadingSpecified ( ) [virtual]

virtual bool DtIfModifyVrfObject::isClosedFigureSpecified ( ) [virtual]

virtual bool DtIfModifyVrfObject::isProjectionSpecified ( ) [virtual]

virtual bool DtIfModifyVrfObject::isObjectGeometrySpecified ( ) [virtual]

virtual bool DtIfModifyVrfObject::isAppearanceSpecified ( ) [virtual]

virtual bool DtIfModifyVrfObject::isOverlayParentSpecified ( ) [virtual]

virtual bool DtIfModifyVrfObject::isUserDataSpecified ( ) [virtual]

virtual void DtIfModifyVrfObject::setObjectName ( 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.

virtual const DtString& DtIfModifyVrfObject::overlayParent ( ) const [virtual]

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.

void DtIfModifyVrfObject::setStartPosition ( const DtVector & position )

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

Reimplemented from DtIfCreateVrfObject.

void DtIfModifyVrfObject::setEndPosition ( const DtVector & position )

Reimplemented from DtIfCreateVrfObject.

void DtIfModifyVrfObject::setName ( const DtString & name )