DtSetAimingPointRequest Class Reference

DtSetAimingPointRequest is used to set the location at which an entity should aim its weapon.

It inherits read/writableness from DtSetDataRequest, and includes the location in geocentric coordinates.

set-data-request-type: DtSetAimingPointRequestType

parameters: aimingPoint - The new location the entity should aim at, in geocentric (meters).

Inheritance diagram for DtSetAimingPointRequest:

Public Types
enum	AimingType { AimAtPoint, AimAtObject, AimAtAngle, CeaseAiming }
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()

Public Member Functions
	DtSetAimingPointRequest ()
	DtSetAimingPointRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtSetAimingPointRequest (const DtString &writeName, const DtSetAimingPointRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtSetAimingPointRequest &	operator= (const DtSetAimingPointRequest &orig)
virtual	~DtSetAimingPointRequest () override
virtual const DtSetMessageType &	type () const override
virtual DtSetDataRequest *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const override
virtual DtString	stringRep () const override
virtual const DtVector &	aimingPoint () const
virtual void	setAimingPoint (const DtVector &location)
virtual const DtUUID &	target () const
virtual void	setTarget (const DtUUID &)
virtual double	aimingAzimuth () const
virtual void	setAimingAzimuth (double az)
virtual double	aimingElevation () const
virtual void	setAimingElevation (double el)
virtual AimingType	aimingType () const
virtual void	setAimingType (AimingType stop)
virtual int	netRepSize () const override
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize) override
virtual bool	setToNet () override
virtual const DtString &	weapon () const
virtual const DtString &	weaponId () const
virtual void	setWeaponId (const DtString &weaponId)
Public Member Functions inherited from DtSetDataRequest
virtual	~DtSetDataRequest () override
virtual bool	init ()
virtual void	putData (std::string &fp, int indentLevel=0) override
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
virtual char *	netRep ()
virtual bool	isOneClick () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs) const
virtual	~DtReaderWriter ()
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	postGetSelf ()
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual void	reset ()
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtSetDataRequest *	creator ()
Static Public Member Functions inherited from DtSetDataRequest
static DtSetDataRequest *	createSetDataRequest (DtlObjPtr mtlStream)
static DtSetDataRequest *	createSetDataRequest (DtSetMessageType requestType)
static void	addSetDataRequestCreatorFcn (const DtSetMessageType &setDataName, DtSetDataRequestCreatorFcn fcn)
static void	setFactory (DtSetDataRequestFactory *factory)
static DtSetDataRequestFactory *	factory ()
static bool	isTypeRegistered (DtSetMessageType setDataType)
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static void	setOutputStream (DtOutputStream *stream)
static DtOutputStream &	outputStream ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Attributes
DtRwVector	myAimingPoint
DtRwUUID	myTarget
DtRwReal	myAimingAzimuth
DtRwReal	myAimingElevation
DtRwInt	myAimingType
DtRwString	myWeapon
DtRwString	myWeaponId
Protected Attributes inherited from DtSetDataRequest
char *	myNetRep
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
bool	myInvalid
bool	myChangedFlag

Additional Inherited Members
Protected Member Functions inherited from DtSetDataRequest
	DtSetDataRequest ()
	DtSetDataRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtSetDataRequest (const DtString &writeName, const DtSetDataRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtSetDataRequest &	operator= (const DtSetDataRequest &orig)
virtual char *	createNetworkBuffer ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
Static Protected Attributes inherited from DtSetDataRequest
static DtSetDataRequestFactory *	myFactory
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn
static bool	thePutIndent
static DtOutputStream *	theOutputStream

Member Enumeration Documentation

enum DtSetAimingPointRequest::AimingType

Enumerator
AimAtPoint
AimAtObject
AimAtAngle
CeaseAiming

Constructor & Destructor Documentation

DtSetAimingPointRequest::DtSetAimingPointRequest

(

)

default constructor

DtSetAimingPointRequest::DtSetAimingPointRequest	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor If you have a request 'put' itself, the writeName will preface it.

DtSetAimingPointRequest::DtSetAimingPointRequest	(	const DtString &	writeName,
		const DtSetAimingPointRequest &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtSetAimingPointRequest::~DtSetAimingPointRequest ( )

overridevirtual

Member Function Documentation

const DtSetAimingPointRequest& DtSetAimingPointRequest::operator=

(

const DtSetAimingPointRequest &

orig

)

assignment operator

virtual const DtSetMessageType& DtSetAimingPointRequest::type ( ) const

overridevirtual

Returns DtSetAimingPointRequestType.

Implements DtSetDataRequest.

virtual DtSetDataRequest* DtSetAimingPointRequest::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = 0  ) const

overridevirtual

Creates a copy of the request.

Implements DtSetDataRequest.

virtual DtString DtSetAimingPointRequest::stringRep ( ) const

overridevirtual

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual const DtVector& DtSetAimingPointRequest::aimingPoint ( ) const

virtual

New aiming point, specified in geocentric coordinates.

virtual void DtSetAimingPointRequest::setAimingPoint ( const DtVector &  location )

virtual

virtual const DtUUID& DtSetAimingPointRequest::target ( ) const

virtual

New target to aim at. Was: targetObject.

virtual void DtSetAimingPointRequest::setTarget ( const DtUUID &  )

virtual

Was: setTargetObject.

virtual double DtSetAimingPointRequest::aimingAzimuth ( ) const

virtual

New aiming azimuth, specified in radians from entity's heading.

virtual void DtSetAimingPointRequest::setAimingAzimuth ( double  az )

virtual

virtual double DtSetAimingPointRequest::aimingElevation ( ) const

virtual

New aiming elevation, specified in radians from level.

virtual void DtSetAimingPointRequest::setAimingElevation ( double  el )

virtual

virtual AimingType DtSetAimingPointRequest::aimingType ( ) const

virtual

Indicates the type of aiming to perform.

virtual void DtSetAimingPointRequest::setAimingType ( AimingType  stop )

virtual

virtual const DtString& DtSetAimingPointRequest::weapon ( ) const

virtual

Used for pre VRF-5.1 scenarios - should be deprecated The setter function is removed. Indicates the weapon to be aimed.

virtual const DtString& DtSetAimingPointRequest::weaponId ( ) const

virtual

Indicates the weaponID of the weapon to be used in the case that there are multiple weapons on the object.

virtual void DtSetAimingPointRequest::setWeaponId ( const DtString &  weaponId )

virtual

Indicates the weaponID of the weapon to be used in the case that there are multiple weapons on the object.

virtual int DtSetAimingPointRequest::netRepSize ( ) const

overridevirtual

Returns the size of the full network representation padded to an 8-byte boundary.

Reimplemented from DtSetDataRequest.

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

overridevirtual

Fills in the task from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSetAimingPointRequest::setToNet ( )

overridevirtual

Fills in the network buffer (created by base class simTask) with the task contents.

Reimplemented from DtSetDataRequest.

static DtSetDataRequest* DtSetAimingPointRequest::creator ( )

static

Member Data Documentation

DtRwVector DtSetAimingPointRequest::myAimingPoint

protected

DtRwUUID DtSetAimingPointRequest::myTarget

protected

DtRwReal DtSetAimingPointRequest::myAimingAzimuth

protected

DtRwReal DtSetAimingPointRequest::myAimingElevation

protected

DtRwInt DtSetAimingPointRequest::myAimingType

protected

DtRwString DtSetAimingPointRequest::myWeapon

protected

Used for pre VRF-5.1 scenarios - should be deprecated. The setter functions removed.

DtRwString DtSetAimingPointRequest::myWeaponId

protected

Weapon ID string for the weapon that should be used.

---

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

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