DtLasingControllerDescriptor Class Reference

File: lasingCtlrDesc.h.

Class: DtLasingControllerDescriptor A DtComponentDescriptor that has additional information needed for providing parameters to a laser controller. It contains wavelength, power, range, designator code.

Inheritance diagram for DtLasingControllerDescriptor:

Public Member Functions
	DtLasingControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtLasingControllerDescriptor (const DtLasingControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
DtLasingControllerDescriptor &	operator= (const DtLasingControllerDescriptor &orig)
virtual	~DtLasingControllerDescriptor () override
virtual DtString	type () const override
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const override
virtual void	postGetSelf () override
virtual void	setWavelength (DtReal wave)
virtual DtReal	wavelength () const
virtual void	setPower (DtReal pow)
virtual DtReal	power () const
virtual void	setDesignatorCode (int code)
virtual int	designatorCode () const
virtual void	setRange (DtReal range)
virtual DtReal	range () const
virtual DtReal	rangeSquared () const
virtual void	setTaskable (bool isTaskable)
virtual bool	taskable () const
virtual void	setOffset (DtVector off)
virtual DtVector	offset () const
virtual DtTargetSelectionCriteria &	targetSelectionCriteria ()
virtual const DtTargetSelectionCriteria &	targetSelectionCriteria () const
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 Member Functions
	DtLasingControllerDescriptor ()
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
void	addPrefixToStateAndParameterData ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtRwReal	myWavelength
DtRwReal	myPower
DtRwInt	myDesignatorCode
DtRwReal	myRange
DtRwBoolean	myTaskable
DtRwOffsetVector	myOffset
DtReal	myRangeSquared
DtTargetSelectionCriteria	myTargetSelectionCriteria
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

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 )()
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

DtLasingControllerDescriptor::DtLasingControllerDescriptor ( )

protected

default constructor, not implemented

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

real constructor

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

copy constructor

virtual DtLasingControllerDescriptor::~DtLasingControllerDescriptor ( )

overridevirtual

Member Function Documentation

DtLasingControllerDescriptor& DtLasingControllerDescriptor::operator=

(

const DtLasingControllerDescriptor &

orig

)

assignment

virtual DtString DtLasingControllerDescriptor::type ( ) const

overridevirtual

Returns the type of descriptor. This will be used to create the descriptor on read from an mtl file.

Reimplemented from DtComponentDescriptor.

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

overridevirtual

Returns a clone of the descriptor.

Reimplemented from DtComponentDescriptor.

virtual void DtLasingControllerDescriptor::postGetSelf ( )

overridevirtual

Called after getSelf to ensure myRangeSquared is updated after myRange is read in.

Reimplemented from DtReaderWriter.

virtual void DtLasingControllerDescriptor::setWavelength ( DtReal  wave )

virtual

The wavelength of the lasing equipment.

virtual DtReal DtLasingControllerDescriptor::wavelength ( ) const

virtual

virtual void DtLasingControllerDescriptor::setPower ( DtReal  pow )

virtual

Power of lasing equipment.

virtual DtReal DtLasingControllerDescriptor::power ( ) const

virtual

virtual void DtLasingControllerDescriptor::setDesignatorCode ( int  code )

virtual

Default designator code used to identify target to lasing munitions.

virtual int DtLasingControllerDescriptor::designatorCode ( ) const

virtual

virtual void DtLasingControllerDescriptor::setRange ( DtReal  range )

virtual

Range of the laser device.

virtual DtReal DtLasingControllerDescriptor::range ( ) const

virtual

virtual DtReal DtLasingControllerDescriptor::rangeSquared ( ) const

virtual

Helper function for range checks.

virtual void DtLasingControllerDescriptor::setTaskable ( bool  isTaskable )

virtual

Whether or not it is taskable or is controlled by another sim component.

virtual bool DtLasingControllerDescriptor::taskable ( ) const

virtual

virtual void DtLasingControllerDescriptor::setOffset ( DtVector  off )

virtual

Offset of the lasing device from the origin of the object.

virtual DtVector DtLasingControllerDescriptor::offset ( ) const

virtual

virtual DtTargetSelectionCriteria& DtLasingControllerDescriptor::targetSelectionCriteria ( )

virtual

Accessor/mutator for myTargetSelectionCriteria.

virtual const DtTargetSelectionCriteria& DtLasingControllerDescriptor::targetSelectionCriteria ( ) const

virtual

Accessor/mutator for myTargetSelectionCriteria.

static DtComponentDescriptor* DtLasingControllerDescriptor::creator ( )

static

Member Data Documentation

DtRwReal DtLasingControllerDescriptor::myWavelength

protected

Parameter Name: wave-length
Parameter Description: The wavelength of the laser, only used to publish to the network.
Parameter Default Value: 790.0
.

DtRwReal DtLasingControllerDescriptor::myPower

protected

Parameter Name: power
Parameter Description: The power of the laser, only used to publish to the network.
Parameter Default Value: 20.0
.

DtRwInt DtLasingControllerDescriptor::myDesignatorCode

protected

Parameter Name: designator-prf-lasing-code
Parameter Description: A semi-random integer meant to tell a munition which laser to guide to.
Parameter Default Value:
.

DtRwReal DtLasingControllerDescriptor::myRange

protected

Parameter Name: range
Parameter Description: Max range of laser in meters.
Parameter Default Value: 10000.0
.

DtRwBoolean DtLasingControllerDescriptor::myTaskable

protected

Parameter Name: taskable
Parameter Description: Boolean describing if the laser is taskable.
Parameter Default Value: True
.

DtRwOffsetVector DtLasingControllerDescriptor::myOffset

protected

Parameter Name: offset
Parameter Description: A vector of meters used to offset the laser origin.
Parameter Default Value: (0, 0, 0)
.

DtReal DtLasingControllerDescriptor::myRangeSquared

protected

Value is not settable via sysdef so it was decided not to add to docs. This is the range multiplied by itself.

DtTargetSelectionCriteria DtLasingControllerDescriptor::myTargetSelectionCriteria

protected

Parameter Name: targeting-control
Parameter Description: List of DtTargetSelectionCriteria objects, that hold target selection criteria for a given weapon system.
See DtTargetSelectionCriteria for more information on this item.
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/lasingControllerDescriptor.h