DtLaserGuidedLauncherControllerDescriptor Class Reference

Parameters for the DtLaserGuidedLauncherController. More...

Inheritance diagram for DtLaserGuidedLauncherControllerDescriptor:

Public Member Functions
	DtLaserGuidedLauncherControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtLaserGuidedLauncherControllerDescriptor (const DtLaserGuidedLauncherControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtLaserGuidedLauncherControllerDescriptor &	operator= (const DtLaserGuidedLauncherControllerDescriptor &orig)
	assignment
virtual	~DtLaserGuidedLauncherControllerDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtObjectType	munitionType () const
	Accessor/mutator for myMunitionType.
virtual void	setMunitionType (const DtObjectType &objType)
	Accessor/mutator for myMunitionType.
virtual DtString	munitionName () const
	Accessor/mutator for myMunitionName.
virtual void	setMunitionName (const DtString &name)
	Accessor/mutator for myMunitionName.
virtual DtVector	launchOffset () const
	Accessor/mutator for myLaunchOffset.
virtual void	setLaunchOffset (const DtVector &offset)
	Accessor/mutator for myLaunchOffset.
virtual DtReal	minTimeBetweenLaunch () const
	Accessor/mutator for myMinTimeBetweenLaunch.
virtual void	setMinTimeBetweenLaunch (DtReal time)
	Accessor/mutator for myMinTimeBetweenLaunch.
virtual DtReal	maxAngleOffBoresight () const
	Accessor/mutator for myMaxAngleOffBoresight.
virtual void	setMaxAngleOffBoresight (DtReal angle)
	Accessor/mutator for myMaxAngleOffBoresight.
virtual int	designatorCode () const
virtual void	setDesignatorCode (int value)
virtual const DtString &	rangeName () const
	Accessor/mutator for myRangeName.
virtual void	setRangeName (const DtString &rangeName)
	Accessor/mutator for myRangeName.
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
	assignment
virtual	~DtComponentDescriptor ()
virtual void	putData (FILE *fp, int indentLevel=0)
	Overrides base class putData to output our type.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored.
virtual bool	init ()
	Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary.
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)
	Type of DtSimComponent this descriptor is associated with.
virtual const DtString &	componentType () const
	Type of DtSimComponent this descriptor is associated with.
virtual void	setMinTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTickPeriod () const
virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)
virtual DtReal	minTickPeriodVariance () const
virtual void	setTickPeriodUsesRealTime (bool value)
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual bool	tickPeriodUsesRealTime () const
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR.
virtual void	setProcessStateRepositoryName (const DtString &name)
	Name which this component will assign to its PSR.
virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create.
virtual void	setProcessStateRepositoryType (const DtString &type)
	Type of PSR this component will create.
virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not.
virtual bool	isEnabled () const
	Is the component enabled or not.
virtual void	setDebugActive (bool active)
	Should detailed debug info be printed for this component.
virtual bool	debugActive ()
	Should detailed debug info be printed for this component.
virtual void	setCreateComponent (bool yesNo)
	Should the component be created or not.
virtual bool	createComponent () const
	Should the component be created or not.
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtComponentDescriptor *	creator ()
Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
	Adds a given component descriptor creation function and corresponding type (defined in compDescTypes.h) to the DtComponentDescriptorFactory.
static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Creates and initializes a component descriptor when reading in from an MTL (MAK Technologies Lisp) file (i.e.
static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
	Creates and initializes a new instance of this class.
static DtComponentDescriptorFactory *	factory ()
	The factory for creating objects of type DtComponentDescriptor.
static void	setFactory (DtComponentDescriptorFactory *factory)
	The factory for creating objects of type DtComponentDescriptor.
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwObjectType	myMunitionType
	Parameter Name: munition-type Parameter Description: Object type used to create the missile when it is fired.
DtRwString	myMunitionName
	Parameter Name: munition-name Parameter Description: Name of munition used to check for quantity in the entity's resource list.
DtRwVector	myLaunchOffset
	Parameter Name: launch-offset Offset from origin of launch vehicle where the missile will be created.
DtRwReal	myMinTimeBetweenLaunch
	Parameter Name: min-time-between-launch Parameter Description: Minimum time between cruise missile launches.
DtRwReal	myMaxAngleOffBoresight
	Parameter Name: max-angle-off-boresight Parameter Description: The maximum angle between the launcher orientation and the angle to the target where the launcher will still fire the missile.
DtRwInt	myDesignatorCode
	Parameter Name: designator-code Parameter Description: The default laser designator code that will be used by this launcher.
DtRwString	myRangeName
	Name given to any range item associated with this descriptor.
Protected Attributes inherited from DtComponentDescriptor
DtRwBoolean	myIsEnabled
DtRwBoolean	myDebug
	This parameter defaults to false.
DtRwBoolean	myCreateComponent
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component.
DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Minimum tick period for this component.
DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: Minimum tick period for this component.
DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the min-tick-period and min-tick-period-variance parameters are based on real time or simulation time.
DtRwString	myProcessStateRepositoryName
	Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component.
DtRwString	myProcessStateRepositoryType
	Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository assoicated with this component.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Private Member Functions
	DtLaserGuidedLauncherControllerDescriptor ()
	default constructor – not implemented.

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::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory

Detailed Description

Parameters for the DtLaserGuidedLauncherController.

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

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::maxAngleOffBoresight ( ) const

virtual

Accessor/mutator for myMaxAngleOffBoresight.

virtual void DtLaserGuidedLauncherControllerDescriptor::setMaxAngleOffBoresight ( DtReal  angle )

virtual

Accessor/mutator for myMaxAngleOffBoresight.

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.

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

virtual

Accessor/mutator for myRangeName.

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.

Reimplemented from DtComponentDescriptor.

Reimplemented in DtIntegratedLaserGuidedLauncherDescriptor.

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

DtRwVector 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::myMaxAngleOffBoresight

protected

Parameter Name: max-angle-off-boresight
Parameter Description: 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

Name given to any range item associated with this descriptor.

Parameter Default Value:

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/laserGuidedLauncherDesc.h