DtCruiseMissileLaunchControllerDescriptor Class Reference

DtCruiseMissileLaunchControllerDescriptor; descriptor for the DtCruiseMissileLaunchController component.

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

Inheritance diagram for DtCruiseMissileLaunchControllerDescriptor:

Public Member Functions
	DtCruiseMissileLaunchControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtCruiseMissileLaunchControllerDescriptor (const DtCruiseMissileLaunchControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
DtCruiseMissileLaunchControllerDescriptor &	operator= (const DtCruiseMissileLaunchControllerDescriptor &orig)
virtual	~DtCruiseMissileLaunchControllerDescriptor () override
virtual DtString	type () const override
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const override
virtual void	postGetSelf () override
virtual DtEntityType	munitionType () const
virtual void	setMunitionType (const DtEntityType &objType)
virtual DtString	munitionName () const
virtual void	setMunitionName (const DtString &name)
virtual DtVector	launchOffset () const
virtual void	setLaunchOffset (const DtVector &offset)
virtual DtTaitBryan	launchOrientation () const
virtual void	setLaunchOrientation (const DtTaitBryan &orient)
virtual DtReal	initialSpeed () const
virtual void	setInitialSpeed (const DtReal speed)
virtual DtReal	minTimeBetweenLaunch () const
virtual void	setMinTimeBetweenLaunch (DtReal time)
virtual DtReal	cruiseMissileRangeRingRange () const
virtual void	setCruiseMissileRangeRingRange (DtReal time)
virtual const DtString &	rangeName () const
virtual void	setRangeName (const DtString &rangeName)
virtual int	rangeId () const
virtual void	setRangeId (int rangeId)
virtual bool	rangeIdIsSpecified () const
virtual const DtTargetingControlTable &	targetingControlTable () const
virtual DtTargetingControlTable &	targetingControlTable ()
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
virtual	~DtComponentDescriptor () override
virtual void	putData (std::string &fp, int indentLevel=0) override
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
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 ()
virtual const DtRwProperties &	internalStateData () const
virtual DtRwProperties &	internalStateData ()
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	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.
DtRwEntityType	myMunitionType
DtRwString	myMunitionName
DtRwOffsetVector	myLaunchOffset
DtRwTaitBryan	myLaunchOrientation
DtRwReal	myInitialSpeed
DtRwReal	myMinTimeBetweenLaunch
DtRwReal	myCruiseMissileRangeRingRange
DtRwString	myRangeName
DtRwInt	myRangeId
DtTargetingControlTable	myTargetingControlTable
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
DtRwProperties	myInternalStateData
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
	DtCruiseMissileLaunchControllerDescriptor ()

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

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

constructor

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

copy constructor

virtual DtCruiseMissileLaunchControllerDescriptor::~DtCruiseMissileLaunchControllerDescriptor ( )

overridevirtual

destructor

DtCruiseMissileLaunchControllerDescriptor::DtCruiseMissileLaunchControllerDescriptor ( )

private

default constructor – not implemented.

Member Function Documentation

DtCruiseMissileLaunchControllerDescriptor& DtCruiseMissileLaunchControllerDescriptor::operator=

(

const DtCruiseMissileLaunchControllerDescriptor &

orig

)

assignment

virtual DtString DtCruiseMissileLaunchControllerDescriptor::type ( ) const

overridevirtual

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

DtCruiseMissileLaunchControllerDescriptorType

Reimplemented from DtComponentDescriptor.

virtual DtEntityType DtCruiseMissileLaunchControllerDescriptor::munitionType ( ) const

virtual

Accessor/mutator for myMunitionType.

virtual void DtCruiseMissileLaunchControllerDescriptor::setMunitionType ( const DtEntityType &  objType )

virtual

Accessor/mutator for myMunitionType.

virtual DtString DtCruiseMissileLaunchControllerDescriptor::munitionName ( ) const

virtual

Accessor/mutator for myMunitionName.

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

virtual

Accessor/mutator for myMunitionName.

virtual DtVector DtCruiseMissileLaunchControllerDescriptor::launchOffset ( ) const

virtual

Accessor/mutator for myLaunchOffset.

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

virtual

Accessor/mutator for myLaunchOffset.

virtual DtTaitBryan DtCruiseMissileLaunchControllerDescriptor::launchOrientation ( ) const

virtual

Accessor/mutator for myLaunchOrientation.

virtual void DtCruiseMissileLaunchControllerDescriptor::setLaunchOrientation ( const DtTaitBryan &  orient )

virtual

Accessor/mutator for myLaunchOrientation.

virtual DtReal DtCruiseMissileLaunchControllerDescriptor::initialSpeed ( ) const

virtual

Accessor/mutator for myInitialSpeed.

virtual void DtCruiseMissileLaunchControllerDescriptor::setInitialSpeed ( const DtReal  speed )

virtual

Accessor/mutator for myInitialSpeed.

virtual DtReal DtCruiseMissileLaunchControllerDescriptor::minTimeBetweenLaunch ( ) const

virtual

Accessor/mutator for myMinTimeBetweenLaunch.

virtual void DtCruiseMissileLaunchControllerDescriptor::setMinTimeBetweenLaunch ( DtReal  time )

virtual

Accessor/mutator for myMinTimeBetweenLaunch.

virtual DtReal DtCruiseMissileLaunchControllerDescriptor::cruiseMissileRangeRingRange ( ) const

virtual

Accessor/mutator for myCruiseMissileRangeRingRange.

virtual void DtCruiseMissileLaunchControllerDescriptor::setCruiseMissileRangeRingRange ( DtReal  time )

virtual

Accessor/mutator for myCruiseMissileRangeRingRange.

virtual const DtString& DtCruiseMissileLaunchControllerDescriptor::rangeName ( ) const

virtual

Accessor/mutator for myRangeName. Deprecated.

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

virtual

Accessor/mutator for myRangeName. Deprecated.

virtual int DtCruiseMissileLaunchControllerDescriptor::rangeId ( ) const

virtual

Accessor/mutator for myRangeId.

virtual void DtCruiseMissileLaunchControllerDescriptor::setRangeId ( int  rangeId )

virtual

Accessor/mutator for myRangeId.

virtual bool DtCruiseMissileLaunchControllerDescriptor::rangeIdIsSpecified ( ) const

virtual

Accessor/mutator for myRangeId.

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

overridevirtual

Reimplemented from DtComponentDescriptor.

virtual const DtTargetingControlTable& DtCruiseMissileLaunchControllerDescriptor::targetingControlTable ( ) const

virtual

Accessor for myTargetingControlTable.

virtual DtTargetingControlTable& DtCruiseMissileLaunchControllerDescriptor::targetingControlTable ( )

virtual

Accessor for myTargetingControlTable.

virtual void DtCruiseMissileLaunchControllerDescriptor::postGetSelf ( )

overridevirtual

Updates ammo select and targeting control variables from the targeting control table if that is specified such that controllers that use this descriptor do not have to change their code for updating.

Reimplemented from DtReaderWriter.

static DtComponentDescriptor* DtCruiseMissileLaunchControllerDescriptor::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

DtRwEntityType DtCruiseMissileLaunchControllerDescriptor::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 DtCruiseMissileLaunchControllerDescriptor::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 entitiy's resources and decremented.
Parameter Default Value: "".

DtRwOffsetVector DtCruiseMissileLaunchControllerDescriptor::myLaunchOffset

protected

Parameter Name: launch-offset
Offset from orgin of launch vehicle where the missile will be created. Parameter Description: Offset from orgin 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.

DtRwTaitBryan DtCruiseMissileLaunchControllerDescriptor::myLaunchOrientation

protected

Parameter Name: launch-orientation
Parameter Description: Initial orientation (relative to the launching entity) for a newly created cruise missile.
Parameter Default Value: (0 0 0) (heading, pitch, roll)
Parameter Units: radians.

DtRwReal DtCruiseMissileLaunchControllerDescriptor::myInitialSpeed

protected

Parameter Name: initial-speed
Parameter Description: Initial speed when launched, in the direction of the launch orientation. This effective velocity vector is added to the platform's initial velocity to get the net initial velocity.
Parameter Default Value: 0.0
Parameter Units: meters per second.

DtRwReal DtCruiseMissileLaunchControllerDescriptor::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 DtCruiseMissileLaunchControllerDescriptor::myCruiseMissileRangeRingRange

protected

Parameter Name: cruise-missile-range-ring-range
Parameter Description: Size of the range ring to display for the cruise missile (in meters).
Parameter Default Value: 100000
Parameter Units: meters.

DtRwString DtCruiseMissileLaunchControllerDescriptor::myRangeName

protected

Parameter Name: range-name
Parameter Description: Deprecated. The name of the range ring.
Parameter Default Value:
.

DtRwInt DtCruiseMissileLaunchControllerDescriptor::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
.

DtTargetingControlTable DtCruiseMissileLaunchControllerDescriptor::myTargetingControlTable

protected

Parameter Name: targeting-control-table
Parameter Description: The table that will specify ammunition that is available to this controller and target priorities. If this is defined, in the postGetSelf, will set the munition name and type from the information given. The controller will need to initialize the resource manager Parameter Default Value:
.

---

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

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