DtLaserGuidedLauncherControllerDescriptor Class Reference

Parameters for the DtLaserGuidedLauncherController. Determines what type of cruise missile munition will be used, and how it will be launched.

Inheritance diagram for DtLaserGuidedLauncherControllerDescriptor:

Public Member Functions
	DtLaserGuidedLauncherControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtLaserGuidedLauncherControllerDescriptor (const DtLaserGuidedLauncherControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
DtLaserGuidedLauncherControllerDescriptor &	operator= (const DtLaserGuidedLauncherControllerDescriptor &orig)
virtual	~DtLaserGuidedLauncherControllerDescriptor ()
virtual DtString	type () const
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtObjectType	munitionType () const
virtual void	setMunitionType (const DtObjectType &objType)
virtual DtString	munitionName () const
virtual void	setMunitionName (const DtString &name)
virtual DtVector	launchOffset () const
virtual void	setLaunchOffset (const DtVector &offset)
virtual DtReal	minTimeBetweenLaunch () const
virtual void	setMinTimeBetweenLaunch (DtReal time)
virtual DtReal	maxAzimuthAngleOffBoresight () const
virtual void	setMaxAzimuthAngleOffBoresight (DtReal maxAngle)
virtual DtReal	maxElevationAngleOffBoresight () const
virtual void	setMaxElevationAngleOffBoresight (DtReal maxAngle)
virtual int	designatorCode () const
virtual void	setDesignatorCode (int value)
virtual const DtString &	rangeName () const
virtual void	setRangeName (const DtString &rangeName)
virtual int	rangeId () const
virtual void	setRangeId (int rangeId)
virtual bool	rangeIdIsSpecified () const
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
virtual	~DtComponentDescriptor ()
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual bool	init ()
virtual const DtString &	stateAndParameterDataPrefix () const
bool	operator== (const DtComponentDescriptor &) const
	DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
virtual void	setComponentType (const DtString &componentType)
virtual const DtString &	componentType () const
virtual void	setMinTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTickPeriod () const
virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)
virtual DtReal	minTickPeriodVariance () const
virtual void	setPeriodicTickWhilePaused (bool value)
virtual bool	periodicTickWhilePaused () const
virtual const DtString &	processStateRepositoryName () const
virtual void	setProcessStateRepositoryName (const DtString &name)
virtual const DtString &	processStateRepositoryType () const
virtual void	setProcessStateRepositoryType (const DtString &type)
virtual void	setIsEnabled (bool yesNo)
virtual bool	isEnabled () const
virtual void	setIsEnabledForClutterEntities (bool yesNo)
virtual bool	isEnabledForClutterEntities () const
virtual void	setDebugActive (bool active)
virtual bool	debugActive () const
virtual void	setMinTaskVisualizationTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTaskVisualizationTickPeriod () const
virtual void	setTaskVisualizationsEnabled (bool enabled)
virtual bool	taskVisualizationsEnabled () const
virtual void	setCreateComponent (bool yesNo)
virtual bool	createComponent () const
virtual void	setCreateOnRemoteObject (bool yesNo)
virtual bool	createOnRemoteObject () const
virtual const DtRwNLengthStringVector &	scriptIds () const
virtual DtRwNLengthStringVector &	scriptIds ()
virtual const DtRwScriptVariablesList &	scriptVariables () const
virtual DtRwScriptVariablesList &	scriptVariables ()
virtual const DtRwProperties &	parameterData () const
virtual DtRwProperties &	parameterData ()
virtual const DtRwProperties &	stateData () const
virtual DtRwProperties &	stateData ()
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)
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 DtComponentDescriptor *	creator ()
Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
static DtComponentDescriptor *	creator ()
static DtComponentDescriptorFactory *	factory ()
static void	setFactory (DtComponentDescriptorFactory *factory)
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
parameters
These parameters are available for setting in the OPD files.
DtRwObjectType	myMunitionType
DtRwString	myMunitionName
DtRwOffsetVector	myLaunchOffset
DtRwReal	myMinTimeBetweenLaunch
DtRwReal	myMaxAzimuthAngleOffBoresight
DtRwReal	myMaxElevationAngleOffBoresight
DtRwReal	myMaxAngleOffBoresight
DtRwInt	myDesignatorCode
DtRwString	myRangeName
DtRwInt	myRangeId
Protected Attributes inherited from DtComponentDescriptor
bool	myPrefixAppliedToStateAndParamData
DtRwString	myComponentType
DtRwReal	myMinTickPeriod
DtRwReal	myMinTickPeriodVariance
DtRwBoolean	myPeriodicTickWhilePaused
DtRwString	myProcessStateRepositoryName
DtRwString	myProcessStateRepositoryType
DtRwBoolean	myIsEnabled
DtRwBoolean	myIsEnabledForClutterEntities
DtRwBoolean	myDebug
DtRwReal	myMinTaskVisualizationTickPeriod
DtRwBoolean	myTaskVisualizationsEnabled
DtRwBoolean	myCreateComponent
DtRwBoolean	myCreateOnRemoteObject
DtRwProperties	myParameterData
DtRwProperties	myStateData
DtRwString	myStateAndParameterDataPrefix
DtRwNLengthStringVector	myScriptIds
DtRwScriptVariablesList	myScriptVariables
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

Private Member Functions
	DtLaserGuidedLauncherControllerDescriptor ()

Additional Inherited Members
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 )()
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
void	addPrefixToStateAndParameterData ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	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

Constructor & Destructor Documentation

DtLaserGuidedLauncherControllerDescriptor::DtLaserGuidedLauncherControllerDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtLaserGuidedLauncherControllerDescriptor::DtLaserGuidedLauncherControllerDescriptor	(	const DtLaserGuidedLauncherControllerDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtLaserGuidedLauncherControllerDescriptor::~DtLaserGuidedLauncherControllerDescriptor ( )

virtual

destructor

DtLaserGuidedLauncherControllerDescriptor::DtLaserGuidedLauncherControllerDescriptor ( )

private

default constructor – not implemented.

Member Function Documentation

DtLaserGuidedLauncherControllerDescriptor& DtLaserGuidedLauncherControllerDescriptor::operator=

(

const DtLaserGuidedLauncherControllerDescriptor &

orig

)

assignment

virtual DtString DtLaserGuidedLauncherControllerDescriptor::type ( ) const

virtual

Returns the type of component this descriptor describes. Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns

DtLaserGuidedLauncherControllerDescriptorType

Reimplemented from DtComponentDescriptor.

Reimplemented in DtIntegratedLaserGuidedLauncherDescriptor.

virtual DtObjectType DtLaserGuidedLauncherControllerDescriptor::munitionType ( ) const

virtual

Accessor/mutator for myMunitionType.

virtual void DtLaserGuidedLauncherControllerDescriptor::setMunitionType ( const DtObjectType &  objType )

virtual

Accessor/mutator for myMunitionType.

virtual DtString DtLaserGuidedLauncherControllerDescriptor::munitionName ( ) const

virtual

Accessor/mutator for myMunitionName.

virtual void DtLaserGuidedLauncherControllerDescriptor::setMunitionName ( const DtString &  name )

virtual

Accessor/mutator for myMunitionName.

virtual DtVector DtLaserGuidedLauncherControllerDescriptor::launchOffset ( ) const

virtual

Accessor/mutator for myLaunchOffset.

virtual void DtLaserGuidedLauncherControllerDescriptor::setLaunchOffset ( const DtVector &  offset )

virtual

Accessor/mutator for myLaunchOffset.

virtual DtReal DtLaserGuidedLauncherControllerDescriptor::minTimeBetweenLaunch ( ) const

virtual

Accessor/mutator for myMinTimeBetweenLaunch.

virtual void DtLaserGuidedLauncherControllerDescriptor::setMinTimeBetweenLaunch ( DtReal  time )

virtual

Accessor/mutator for myMinTimeBetweenLaunch.

virtual DtReal DtLaserGuidedLauncherControllerDescriptor::maxAzimuthAngleOffBoresight ( ) const

virtual

Accessor/mutator for myMaxAzimuthAngleOffBoresight.

virtual void DtLaserGuidedLauncherControllerDescriptor::setMaxAzimuthAngleOffBoresight ( DtReal  maxAngle )

virtual

Accessor/mutator for myMaxAzimuthAngleOffBoresight.

virtual DtReal DtLaserGuidedLauncherControllerDescriptor::maxElevationAngleOffBoresight ( ) const

virtual

Accessor/mutator for myMaxElevationAngleOffBoresight.

virtual void DtLaserGuidedLauncherControllerDescriptor::setMaxElevationAngleOffBoresight ( DtReal  maxAngle )

virtual

Accessor/mutator for myMaxElevationAngleOffBoresight.

virtual int DtLaserGuidedLauncherControllerDescriptor::designatorCode ( ) const

virtual

See Also

myDesignatorCode

virtual void DtLaserGuidedLauncherControllerDescriptor::setDesignatorCode ( int  value )

virtual

See Also

myDesignatorCode

virtual const DtString& DtLaserGuidedLauncherControllerDescriptor::rangeName ( ) const

virtual

Accessor/mutator for myRangeName. Deprecated.

virtual void DtLaserGuidedLauncherControllerDescriptor::setRangeName ( const DtString &  rangeName )

virtual

Accessor/mutator for myRangeName. Deprecated.

virtual int DtLaserGuidedLauncherControllerDescriptor::rangeId ( ) const

virtual

Accessor/mutator for myRangeId.

virtual void DtLaserGuidedLauncherControllerDescriptor::setRangeId ( int  rangeId )

virtual

Accessor/mutator for myRangeId.

virtual bool DtLaserGuidedLauncherControllerDescriptor::rangeIdIsSpecified ( ) const

virtual

Accessor/mutator for myRangeId.

virtual DtComponentDescriptor* DtLaserGuidedLauncherControllerDescriptor::clone ( DtReaderWriterRegistry *  parentRegistry = 0 ) const

virtual

Reimplemented from DtComponentDescriptor.

Reimplemented in DtIntegratedLaserGuidedLauncherDescriptor.

static DtComponentDescriptor* DtLaserGuidedLauncherControllerDescriptor::creator ( )

static

Returns

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Member Data Documentation

DtRwObjectType DtLaserGuidedLauncherControllerDescriptor::myMunitionType

protected

Parameter Name: munition-type
Parameter Description: Object type used to create the missile when it is fired.
Parameter Default Value: (0 0 0 0 0 0 0)

DtRwString DtLaserGuidedLauncherControllerDescriptor::myMunitionName

protected

Parameter Name: munition-name
Parameter Description: Name of munition used to check for quantity in the entity's resource list. This is the name that will be looked up in the entity's resources and decremented.
Parameter Default Value: "".

DtRwOffsetVector DtLaserGuidedLauncherControllerDescriptor::myLaunchOffset

protected

Parameter Name: launch-offset
Offset from origin of launch vehicle where the missile will be created. Parameter Description: Offset from origin of launch vehicle where the missile will be created, in body coordinates of the launch vehicle.
Parameter Default Value: (0.0 0.0 0.0) (x, y, z)
Parameter Units: meters.

DtRwReal DtLaserGuidedLauncherControllerDescriptor::myMinTimeBetweenLaunch

protected

Parameter Name: min-time-between-launch
Parameter Description: Minimum time between cruise missile launches.
Parameter Default Value: 0.0
Parameter Units: seconds.

DtRwReal DtLaserGuidedLauncherControllerDescriptor::myMaxAzimuthAngleOffBoresight

protected

Parameter Name: max-azimuth-angle-off-boresight
Parameter Description: The maximum azimuth angle between the launcher orientation and the angle to the target where the launcher will still fire the missile.
Parameter Default Value: 0.35 (20 degrees)
Parameter Units: radians.

DtRwReal DtLaserGuidedLauncherControllerDescriptor::myMaxElevationAngleOffBoresight

protected

Parameter Name: max-elevation-angle-off-boresight
Parameter Description: The maximum elevation angle between the launcher orientation and the angle to the target where the launcher will still fire the missile.
Parameter Default Value: 0.35 (20 degrees)
Parameter Units: radians.

DtRwReal DtLaserGuidedLauncherControllerDescriptor::myMaxAngleOffBoresight

protected

Parameter Name: max-angle-off-boresight
Parameter Description: NOTE: This parameter is deprecated. It is retained for backwards compatibility, but will be ignored in favor of max-azimuth-angle-off-boresight and max-elevation-angle-off-boresight if they are set.
The maximum angle between the launcher orientation and the angle to the target where the launcher will still fire the missile.
Parameter Default Value: 0.35 (20 degrees)
Parameter Units: radians.

DtRwInt DtLaserGuidedLauncherControllerDescriptor::myDesignatorCode

protected

Parameter Name: designator-code
Parameter Description: The default laser designator code that will be used by this launcher. The launcher will only be able to fire on targets designated by a laser with this code. It can be changed at runtime. If -1 is specified, each entity will be assigned a pseudo-random laser code at creation.
Parameter Default Value: -1
.

DtRwString DtLaserGuidedLauncherControllerDescriptor::myRangeName

protected

Parameter Name: range-name Parameter Description: Deprecated Name given to any range item associated with this descriptor. Parameter Default Value:
.

DtRwInt DtLaserGuidedLauncherControllerDescriptor::myRangeId

protected

Parameter Name: range-id
Parameter Description: The identifying value for this range ring. Can be converted to a string based on configured enumeration values.
Parameter Default Value: 0
.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjparam/laserGuidedLauncherControllerDescriptor.h