class DtIfCreateVrfObject:

Instances of DtIfCreateVrfObject are the message content for create vrf object messages sent from one VR-Forces process to another. The purpose of the message is to request that a particular VR-Forces process instantiate and become responsible for locally simulating a new vrf object.

Content-Type: DtCreateVrfObjectMessageType

Parameters: vrf process address - A DtSimulationAddress identifying the particular VR-Forces back-end to create the object.

object name - A DtString used to uniquely identify the object. This string must be unique for all objects in the exercise.

object type - The DtObjectType of the new entity. DtObjectType is an extension of the DIS/RPR enumerated DtEntityType (from objTypeEnums.h).

force type - The DtForceType value for the new entity (from disE- nums.h).

object label - A DtString associated with the new object. This string provides an additional means to identify an object without the strict uniqueness requirement of object name.

extended labels - A key/value pair that will assign a label to a label index. Index 0 is reserved, so, that will be ignored if used

position - A DtVector that is the starting location of the object in geocentric coordinates. Set the position for those objects that have a single vertex (e.g. waypoints, entities).

heading - A DtReal value that is the initial heading of the object in radians. A value of 0.0 is north and positive values are clockwise.

vertices - A DtList of the DtVectors that make up the object's geom- etry (i.e. the vertices that make up the points along a route). Note that position is just an alias for the first vertex. Do not call setPosi- tion() if you have an object with multiple vertices (call addVertex() to set up the object's geometry instead). Vertices must be specified in geocentric coordinates.

projection - A bool flag indicating whether or not the Z elements in the object's vertex list have meaning. For example, phase lines do not have meaningful Z elements.

closed figure - A bool flag indicating whether the object's vertices make up a closed figure (i.e. does the last vertex connect with the first?). A control area is an example of an object that is a closed figure.

appearance - A DtAppearance indicating the initial appearance of the object (e.g. damage state, frozen status, concealed).

create subobjects - A bool flag indicating whether or not you wish to have sub-object created. The parameter file may contain a list of subobjects. When building from the bottom up (for example, using AggregateAs or explicitly calling addSubordinate) then the subobjects in the parameter list should be ignored.

Inheritance diagram for DtIfCreateVrfObject:

[legend]

Public Member Functions
	DtIfCreateVrfObject ()

virtual	~DtIfCreateVrfObject ()

	DtIfCreateVrfObject (const DtIfCreateVrfObject &orig)

DtIfCreateVrfObject &	operator= (const DtIfCreateVrfObject &orig)

virtual DtSimInterfaceContent *	clone () const

virtual int	type () const

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 void	setMarkingText (const DtString &objectName)

virtual const DtString &	markingText () const

virtual void	setMarkingTextPrefix (const DtString &objectName)

virtual const DtString &	markingTextPrefix () const

virtual void	setObjectType (const DtObjectType &objectType)

virtual const DtObjectType &	objectType () const

virtual void	setForceType (const DtForceType forceType)

virtual DtForceType	forceType () const

virtual void	setObjectLabel (const DtString &objectLabel)

virtual const DtString &	objectLabel () const

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

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

virtual void	setOverlayParent (const DtString &overlayParent)

virtual const DtString &	overlayParent () const

virtual DtVector	position () const

virtual void	setPosition (const DtVector &position)

virtual DtReal	heading () const

virtual void	setHeading (DtReal heading)

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 void	addVertex (const DtVector &vertex)

virtual bool	projection () const

virtual void	setProjection (bool projection)

virtual bool	closedFigure () const

virtual void	setClosedFigure (bool closedFigure)

virtual DtAppearance	appearance () const

virtual void	setAppearance (const DtAppearance &appearance)

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< std::string, std::string > &)

virtual void	setExtendedData (const std::map< DtString, DtString > &)

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

virtual const std::map < std::string, std::string > &	extendedData () const

virtual void	setUserData (const DtString &userData)

virtual DtString	userData () const

virtual int	netRepSize () const

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

virtual bool	setToNet ()

virtual void	printDataToString (DtString &str)

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

DtIfCreateVrfObject::DtIfCreateVrfObject ( )

default constructor

virtual DtIfCreateVrfObject::~DtIfCreateVrfObject ( )

virtual

destructor

DtIfCreateVrfObject::DtIfCreateVrfObject ( const DtIfCreateVrfObject & orig )

copy constructor

Member Function Documentation

DtIfCreateVrfObject& DtIfCreateVrfObject::operator= ( const DtIfCreateVrfObject & orig )

assignment operator

virtual DtSimInterfaceContent* DtIfCreateVrfObject::clone ( ) const

virtual

Returns a newly created instance of a DtIfCreateVrfObject.

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation