DtLocalObjectCreateInformation Class Reference

The DtLocalObjectCreateInformation class is a subset of the information used in the DtIfCreateVrfObject call and will be used as the main class for creating DtLocalObject.

Inheritance diagram for DtLocalObjectCreateInformation:

Public Member Functions
	DtLocalObjectCreateInformation (const DtUUID &uuid)
	DtLocalObjectCreateInformation ()
	DtLocalObjectCreateInformation (const DtIfCreateVrfObject &)
	DtLocalObjectCreateInformation (const DtLocalObjectCreateInformation &)
DtLocalObjectCreateInformation &	operator= (const DtLocalObjectCreateInformation &)
virtual	~DtLocalObjectCreateInformation ()
void	setUUID (const DtUUID &)
const DtUUID &	uuid () const
void	setOverlay (const DtString &)
const DtString &	overlay () const
void	setObjectType (const DtObjectType &)
const DtObjectType &	objectType () const
void	setPublishFlag (int)
void	setPublishObject (bool)
bool	publishObject () const
int	publishFlag () const
void	setEntityIdentifier (const DtEntityIdentifier &)
const DtEntityIdentifier &	entityIdentifier () const
void	setLabel (const DtString &)
const DtString &	label () const
void	setExtendedLabels (const std::map< int, DtString > &)
const std::map< int, DtString > &	extendedLabels () const
void	setPosition (const DtVector &geocLocation)
DtVector	position () const
DtVector	endPosition () const
const std::vector< DtVector > &	vertices () const
std::vector< DtVector > &	vertices ()
void	setVertices (const DtList &)
void	setVertices (const std::vector< DtVector > &)
void	addVertex (const DtVector &)
const DtTaitBryan &	orientation () const
void	setOrientation (const DtTaitBryan &)
void	setAmClampedToGround (bool)
bool	amClampedToGround () const
void	setHeading (double rad)
double	heading () const
void	setPitch (double rad)
double	pitch () const
void	setRoll (double rad)
double	roll () const
void	setObjectName (const DtString &)
const DtString &	objectName () const
void	setObjectNamePrefix (const DtString &)
const DtString &	objectNamePrefix () const
void	setForceType (DtForceType)
DtForceType	forceType () const
void	setClampToGround (bool)
bool	clampToGround () const
void	setProjected (bool)
bool	projected () const
void	setClosedFigure (bool)
bool	closedFigure () const
void	setAppearance (unsigned int)
unsigned int	appearance () const
void	setConnectToRadioNetwork (bool b)
bool	connectToRadioNetwork () const
void	setAddToOrbat (bool)
bool	addToOrbat () const
void	setCreateSubObjects (bool b)
bool	createSubObjects () const
void	setOrganized (bool)
bool	organized () const
void	setUserCallback (DtVrfObjectUserInitFcn, void *)
DtVrfObjectUserInitFcn	callbackFunction () const
void *	callbackData () const
void	setRequestId (unsigned long)
unsigned long	requestId () const
const std::map< std::string, std::string > &	extendedData () const
std::map< std::string, std::string > &	extenedData ()
void	setExtendedData (const std::map< std::string, std::string > &)
void	setExtendedData (const std::map< DtString, DtString > &)
void	setExtendedData (const DtString &keyword, const DtString &data)
const DtString &	userData () const
void	setUserData (const DtString &)
void	setSuperior (const DtUUID &)
const DtUUID &	superior () const
const std::list < DtAdminContent * > &	initialAdminContent () const
std::list< DtAdminContent * > &	initialAdminContent ()
void	setInitialAdminContent (const std::list< DtAdminContent * > &adminContent)
void	addInitialAdminContent (DtAdminContent *adminContent)
void	clearInitialAdminContent ()
const std::list < DtSimInterfaceContent * > &	initialInterfaceContent () const
std::list < DtSimInterfaceContent * > &	initialInterfaceContent ()
void	setInitialInterfaceContent (const std::list< DtSimInterfaceContent * > &adminContent)
void	addInitialInterfaceContent (DtSimInterfaceContent *adminContent)
void	clearInitialInterfaceContent ()
void	addSubordinates (const std::vector< DtUUID > &)
void	addSubordinate (const DtUUID &)
void	renmoveSubordinate (const DtUUID &)
void	clearSubordinates ()
const std::vector< DtUUID > &	subordinates () const
virtual bool	isValid () const
void	setColor (int)
int	color () const
bool	colorSet () const
void	clearColor ()
void	setWorldVelocity (const DtVector &)
const DtVector &	worldVelocity () const
bool	worldVelocitySet () const
void	clearWorldVelocity ()
void	setWorldOrientation (const DtTaitBryan &)
const DtTaitBryan &	worldOrientation () const
bool	worldOrientationSet () const
void	clearWorldOrientation ()
void	setStartingFormation (const DtString &)
const DtString &	startingFormation () const
void	setAggregateCreationMode (int)
int	aggregateCreationMode () const

Protected Member Functions
void	validateUUID ()

Protected Attributes
DtUUID	myUUID
DtObjectType	myObjectType
DtString	myLabel
DtString	myObjectName
DtString	myObjectNamePrefix
DtString	myOverlay
std::map< int, DtString >	myExtendedLabels
bool	myAddToOrbat
bool	myCreateSubObjects
bool	myOrganized
DtString	myUserData
bool	myClampToGround
DtString	myStartingFormation
int	myAggregateCreationMode
DtVrfObjectUserInitFcn	myUserInitFunction
void *	myUserInitData
DtTaitBryan	myOrientation
std::vector< DtVector >	myVertices
int	myPublishFlag
DtForceType	myForceType
DtEntityIdentifier	myEntityIdentifier
bool	myProjected
bool	myClosedFigure
unsigned int	myAppearance
bool	myConnectToRadioNetwork
unsigned long	myRequestId
std::map< std::string, std::string >	myExtendedData
std::list< DtAdminContent * >	myAdminContent
std::list < DtSimInterfaceContent * >	myInterfaceContent
DtUUID	mySuperior
DtVector	myWorldVelocity
bool	myWorldVelocitySet
DtTaitBryan	myWorldOrientation
bool	myWorldOrientationSet
std::vector< DtUUID >	mySubordinates
int	myColor
bool	myColorSet

Constructor & Destructor Documentation

DtLocalObjectCreateInformation::DtLocalObjectCreateInformation

(

const DtUUID &

uuid

)

CTOR with UUID.

DtLocalObjectCreateInformation::DtLocalObjectCreateInformation

(

)

CTOR. Assumes UUID will be set at a later time.

DtLocalObjectCreateInformation::DtLocalObjectCreateInformation

(

const DtIfCreateVrfObject &

)

CTOR from create message.

DtLocalObjectCreateInformation::DtLocalObjectCreateInformation

(

const DtLocalObjectCreateInformation &

)

Copy constructor.

virtual DtLocalObjectCreateInformation::~DtLocalObjectCreateInformation ( )

virtual

DTOR.

Member Function Documentation

DtLocalObjectCreateInformation& DtLocalObjectCreateInformation::operator=

(

const DtLocalObjectCreateInformation &

)

void DtLocalObjectCreateInformation::setUUID

(

const DtUUID &

)

const DtUUID& DtLocalObjectCreateInformation::uuid

(

)

const

void DtLocalObjectCreateInformation::setOverlay

(

const DtString &

)

const DtString& DtLocalObjectCreateInformation::overlay

(

)

const

void DtLocalObjectCreateInformation::setObjectType

(

const DtObjectType &

)

const DtObjectType& DtLocalObjectCreateInformation::objectType

(

)

const

void DtLocalObjectCreateInformation::setPublishFlag

(

int

)

See DtStateData::PublishFlag for publish flag types. Default is PublishAll.

void DtLocalObjectCreateInformation::setPublishObject

(

bool

)

bool DtLocalObjectCreateInformation::publishObject

(

)

const

Set to either DoNotPublish (false) or PublishAll (true)

int DtLocalObjectCreateInformation::publishFlag

(

)

const

Return true if flag is anything but DoNotPublish.

void DtLocalObjectCreateInformation::setEntityIdentifier

(

const DtEntityIdentifier &

)

const DtEntityIdentifier& DtLocalObjectCreateInformation::entityIdentifier

(

)

const

void DtLocalObjectCreateInformation::setLabel

(

const DtString &

)

const DtString& DtLocalObjectCreateInformation::label

(

)

const

void DtLocalObjectCreateInformation::setExtendedLabels

(

const std::map< int, DtString > &

)

const std::map<int, DtString>& DtLocalObjectCreateInformation::extendedLabels

(

)

const

void DtLocalObjectCreateInformation::setPosition

(

const DtVector &

geocLocation

)

Sets the first vertex to this position, and clears remainder of vertices, if present.

DtVector DtLocalObjectCreateInformation::position

(

)

const

If there are vertices, the first vertex.

DtVector DtLocalObjectCreateInformation::endPosition

(

)

const

const std::vector<DtVector>& DtLocalObjectCreateInformation::vertices

(

)

const

std::vector<DtVector>& DtLocalObjectCreateInformation::vertices

(

)

void DtLocalObjectCreateInformation::setVertices

(

const DtList &

)

Assumes DtList is a list of DtVector.

void DtLocalObjectCreateInformation::setVertices

(

const std::vector< DtVector > &

)

void DtLocalObjectCreateInformation::addVertex

(

const DtVector &

)

const DtTaitBryan& DtLocalObjectCreateInformation::orientation

(

)

const

void DtLocalObjectCreateInformation::setOrientation

(

const DtTaitBryan &

)

void DtLocalObjectCreateInformation::setColor

(

int

)

If tactical graphic that supports, set color (rgba)

int DtLocalObjectCreateInformation::color

(

)

const

If tactical graphic that supports, set color (rgba)

bool DtLocalObjectCreateInformation::colorSet

(

)

const

If tactical graphic that supports, set color (rgba)

void DtLocalObjectCreateInformation::clearColor

(

)

If tactical graphic that supports, set color (rgba)

void DtLocalObjectCreateInformation::setWorldVelocity

(

const DtVector &

)

Initial movement information.

const DtVector& DtLocalObjectCreateInformation::worldVelocity

(

)

const

Initial movement information.

bool DtLocalObjectCreateInformation::worldVelocitySet

(

)

const

Initial movement information.

void DtLocalObjectCreateInformation::clearWorldVelocity

(

)

Initial movement information.

void DtLocalObjectCreateInformation::setWorldOrientation

(

const DtTaitBryan &

)

Initial movement information.

const DtTaitBryan& DtLocalObjectCreateInformation::worldOrientation

(

)

const

Initial movement information.

bool DtLocalObjectCreateInformation::worldOrientationSet

(

)

const

Initial movement information.

void DtLocalObjectCreateInformation::clearWorldOrientation

(

)

Initial movement information.

void DtLocalObjectCreateInformation::setAmClampedToGround

(

bool

)

bool DtLocalObjectCreateInformation::amClampedToGround

(

)

const

void DtLocalObjectCreateInformation::setHeading

(

double

rad

)

Sets the psi member of orientation() in topographic radians.

double DtLocalObjectCreateInformation::heading

(

)

const

void DtLocalObjectCreateInformation::setPitch

(

double

rad

)

Sets the theta member of orientation() in topographic radians.

double DtLocalObjectCreateInformation::pitch

(

)

const

void DtLocalObjectCreateInformation::setRoll

(

double

rad

)

Sets the phi member of orientation() in topographic radians.

double DtLocalObjectCreateInformation::roll

(

)

const

void DtLocalObjectCreateInformation::setObjectName

(

const DtString &

)

const DtString& DtLocalObjectCreateInformation::objectName

(

)

const

void DtLocalObjectCreateInformation::setObjectNamePrefix

(

const DtString &

)

If objectName is empty string, use this prefix (if defined) when generating a unique name.

const DtString& DtLocalObjectCreateInformation::objectNamePrefix

(

)

const

void DtLocalObjectCreateInformation::setForceType

(

DtForceType

)

DtForceType DtLocalObjectCreateInformation::forceType

(

)

const

void DtLocalObjectCreateInformation::setClampToGround

(

bool

)

When placing, whether or not to clamp the object to the ground (valid for only platform single point objects). Default is true.

bool DtLocalObjectCreateInformation::clampToGround

(

)

const

void DtLocalObjectCreateInformation::setProjected

(

bool

)

Whether or not this item is projected. A projected item is 2D only.

bool DtLocalObjectCreateInformation::projected

(

)

const

void DtLocalObjectCreateInformation::setClosedFigure

(

bool

)

Whether or not this item is a closed figure (like an area)

bool DtLocalObjectCreateInformation::closedFigure

(

)

const

void DtLocalObjectCreateInformation::setAppearance

(

unsigned

int

)

Appearance bits for object.

unsigned int DtLocalObjectCreateInformation::appearance

(

)

const

void DtLocalObjectCreateInformation::setConnectToRadioNetwork

(

bool

b

)

Whether or not to connect this object to the local radio network. Default is true.

bool DtLocalObjectCreateInformation::connectToRadioNetwork

(

)

const

void DtLocalObjectCreateInformation::setAddToOrbat

(

bool

)

Whether or not to also add this item to the order of battle file (orbat) that is saved to keep hierarchy of potential objects. Default is false.

bool DtLocalObjectCreateInformation::addToOrbat

(

)

const

void DtLocalObjectCreateInformation::setCreateSubObjects

(

bool

b

)

If this object also has subordinates, create those. Default is true.

bool DtLocalObjectCreateInformation::createSubObjects

(

)

const

void DtLocalObjectCreateInformation::setOrganized

(

bool

)

If this object can be organized, whether or not to add it to the force level organization. Default is true.

bool DtLocalObjectCreateInformation::organized

(

)

const

void DtLocalObjectCreateInformation::setUserCallback	(	DtVrfObjectUserInitFcn	,
		void *
	)

During creation, invoke this callback after the object is created but before added. Return false to not add this object into the system from the callback.

DtVrfObjectUserInitFcn DtLocalObjectCreateInformation::callbackFunction

(

)

const

void* DtLocalObjectCreateInformation::callbackData

(

)

const

void DtLocalObjectCreateInformation::setRequestId

(

unsigned

long

)

Only used if this is in response to being created from an object create message. Cannot be set. Default is 0.

unsigned long DtLocalObjectCreateInformation::requestId

(

)

const

void DtLocalObjectCreateInformation::setStartingFormation

(

const DtString &

)

Aggregate specific information. See createObjectServicesInterface.h for aggregate creation mode.

const DtString& DtLocalObjectCreateInformation::startingFormation

(

)

const

Aggregate specific information. See createObjectServicesInterface.h for aggregate creation mode.

void DtLocalObjectCreateInformation::setAggregateCreationMode

(

int

)

Aggregate specific information. See createObjectServicesInterface.h for aggregate creation mode.

int DtLocalObjectCreateInformation::aggregateCreationMode

(

)

const

Aggregate specific information. See createObjectServicesInterface.h for aggregate creation mode.

const std::map<std::string, std::string>& DtLocalObjectCreateInformation::extendedData

(

)

const

Initial extened data.

std::map<std::string, std::string>& DtLocalObjectCreateInformation::extenedData

(

)

void DtLocalObjectCreateInformation::setExtendedData

(

const std::map< std::string, std::string > &

)

void DtLocalObjectCreateInformation::setExtendedData

(

const std::map< DtString, DtString > &

)

void DtLocalObjectCreateInformation::setExtendedData	(	const DtString &	keyword,
		const DtString &	data
	)

const DtString& DtLocalObjectCreateInformation::userData

(

)

const

User data. For tactical graphics only. Should use extended data instead, but, this is here for backwards compatability.

void DtLocalObjectCreateInformation::setUserData

(

const DtString &

)

void DtLocalObjectCreateInformation::setSuperior

(

const DtUUID &

)

If this object should immediately be attached to a superior, the superior it should be attached to after creation.

const DtUUID& DtLocalObjectCreateInformation::superior

(

)

const

const std::list<DtAdminContent*>& DtLocalObjectCreateInformation::initialAdminContent

(

)

const

Initial admin content to apply to the object. This class owns the memory.

std::list<DtAdminContent*>& DtLocalObjectCreateInformation::initialAdminContent

(

)

Use this call to pass ownership of content to this class.

void DtLocalObjectCreateInformation::setInitialAdminContent

(

const std::list< DtAdminContent * > &

adminContent

)

void DtLocalObjectCreateInformation::addInitialAdminContent

(

DtAdminContent *

adminContent

)

void DtLocalObjectCreateInformation::clearInitialAdminContent

(

)

const std::list<DtSimInterfaceContent*>& DtLocalObjectCreateInformation::initialInterfaceContent

(

)

const

Initial interface content to apply to the object. This class owns the memory.

std::list<DtSimInterfaceContent*>& DtLocalObjectCreateInformation::initialInterfaceContent

(

)

Use this call to pass ownership of content to this class.

void DtLocalObjectCreateInformation::setInitialInterfaceContent

(

const std::list< DtSimInterfaceContent * > &

adminContent

)

void DtLocalObjectCreateInformation::addInitialInterfaceContent

(

DtSimInterfaceContent *

adminContent

)

void DtLocalObjectCreateInformation::clearInitialInterfaceContent

(

)

void DtLocalObjectCreateInformation::addSubordinates

(

const std::vector< DtUUID > &

)

Takes the UUIDs supplied, and, if the subordinates exist, adds them to the newly created object Adds to whatever might be there.

void DtLocalObjectCreateInformation::addSubordinate

(

const DtUUID &

)

void DtLocalObjectCreateInformation::renmoveSubordinate

(

const DtUUID &

)

void DtLocalObjectCreateInformation::clearSubordinates

(

)

const std::vector<DtUUID>& DtLocalObjectCreateInformation::subordinates

(

)

const

virtual bool DtLocalObjectCreateInformation::isValid ( ) const

virtual

Returns true if this is a valid creation object. Will check if there is a non-zero location.

void DtLocalObjectCreateInformation::validateUUID ( )

protected

Set a UUID into the uuid if the uuid is not valid.

Member Data Documentation

DtUUID DtLocalObjectCreateInformation::myUUID

protected

DtObjectType DtLocalObjectCreateInformation::myObjectType

protected

DtString DtLocalObjectCreateInformation::myLabel

protected

DtString DtLocalObjectCreateInformation::myObjectName

protected

DtString DtLocalObjectCreateInformation::myObjectNamePrefix

protected

DtString DtLocalObjectCreateInformation::myOverlay

protected

std::map<int, DtString> DtLocalObjectCreateInformation::myExtendedLabels

protected

bool DtLocalObjectCreateInformation::myAddToOrbat

protected

bool DtLocalObjectCreateInformation::myCreateSubObjects

protected

bool DtLocalObjectCreateInformation::myOrganized

protected

DtString DtLocalObjectCreateInformation::myUserData

protected

bool DtLocalObjectCreateInformation::myClampToGround

protected

DtString DtLocalObjectCreateInformation::myStartingFormation

protected

int DtLocalObjectCreateInformation::myAggregateCreationMode

protected

DtVrfObjectUserInitFcn DtLocalObjectCreateInformation::myUserInitFunction

protected

void* DtLocalObjectCreateInformation::myUserInitData

protected

DtTaitBryan DtLocalObjectCreateInformation::myOrientation

protected

The topographic orientation to set for this object.

std::vector<DtVector> DtLocalObjectCreateInformation::myVertices

protected

The vertices (geocentric) used to create this object.

int DtLocalObjectCreateInformation::myPublishFlag

protected

Whether or not to publish this item on the network. Default is true.

DtForceType DtLocalObjectCreateInformation::myForceType

protected

Default is DtForceOther.

DtEntityIdentifier DtLocalObjectCreateInformation::myEntityIdentifier

protected

VR-Link specific – the entity identifier to use as a seed.

bool DtLocalObjectCreateInformation::myProjected

protected

Default is true.

bool DtLocalObjectCreateInformation::myClosedFigure

protected

Default is false.

unsigned int DtLocalObjectCreateInformation::myAppearance

protected

bool DtLocalObjectCreateInformation::myConnectToRadioNetwork

protected

unsigned long DtLocalObjectCreateInformation::myRequestId

protected

std::map<std::string, std::string> DtLocalObjectCreateInformation::myExtendedData

protected

std::list<DtAdminContent*> DtLocalObjectCreateInformation::myAdminContent

protected

std::list<DtSimInterfaceContent*> DtLocalObjectCreateInformation::myInterfaceContent

protected

DtUUID DtLocalObjectCreateInformation::mySuperior

protected

DtVector DtLocalObjectCreateInformation::myWorldVelocity

protected

World velocity to be set in the local object (only used if set)

bool DtLocalObjectCreateInformation::myWorldVelocitySet

protected

DtTaitBryan DtLocalObjectCreateInformation::myWorldOrientation

protected

If this is specified, use this instead of the supplied orientation.

bool DtLocalObjectCreateInformation::myWorldOrientationSet

protected

std::vector<DtUUID> DtLocalObjectCreateInformation::mySubordinates

protected

Takes the UUIDs supplied, and, if the subordinates exist, adds them to the newly created object.

int DtLocalObjectCreateInformation::myColor

protected

bool DtLocalObjectCreateInformation::myColorSet

protected

---

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

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