DtInfraredSignaturePropagatorDescriptor Class Reference

DtInfraredSignaturePropagatorDescriptor; descriptor for the DtInfraredSignaturePropagator component.

Descriptor containing configuration parameters for the DtStandardSignaturePropagator class.

Inheritance diagram for DtInfraredSignaturePropagatorDescriptor:

Public Member Functions
	DtInfraredSignaturePropagatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtInfraredSignaturePropagatorDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtInfraredSignaturePropagatorDescriptor (const DtInfraredSignaturePropagatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtInfraredSignaturePropagatorDescriptor &	operator= (const DtInfraredSignaturePropagatorDescriptor &orig)
virtual	~DtInfraredSignaturePropagatorDescriptor () override
virtual DtString	type () const override
virtual DtSignaturePropagatorDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const override
virtual bool	checkSmokeIntersections () const
virtual void	setCheckSmokeIntersections (bool check)
virtual const DtEntityType &	smokeType () const
virtual void	setSmokeType (const DtEntityType &type)
virtual double	minSmokeBlockDistance () const
virtual void	setMinSmokeBlockDistance (double value)
virtual double	minSmokeBlockDensity () const
virtual void	setMinSmokeBlockDensity (double value)
Public Member Functions inherited from DtStandardPropagatorDescriptor
	DtStandardPropagatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtStandardPropagatorDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtStandardPropagatorDescriptor (const DtStandardPropagatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtStandardPropagatorDescriptor &	operator= (const DtStandardPropagatorDescriptor &orig)
virtual	~DtStandardPropagatorDescriptor () override
virtual bool	checkLineOfSight () const
virtual void	setCheckLineOfSight (bool yesNo)
Public Member Functions inherited from DtSignaturePropagatorDescriptor
	DtSignaturePropagatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtSignaturePropagatorDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtSignaturePropagatorDescriptor (const DtSignaturePropagatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtSignaturePropagatorDescriptor &	operator= (const DtSignaturePropagatorDescriptor &orig)
virtual	~DtSignaturePropagatorDescriptor () 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 void	setPropagatorType (const DtString &componentType)
virtual DtString	propagatorType () 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 DtSignaturePropagatorDescriptor *	creator ()
Static Public Member Functions inherited from DtStandardPropagatorDescriptor
static DtSignaturePropagatorDescriptor *	creator ()
Static Public Member Functions inherited from DtSignaturePropagatorDescriptor
static DtSignaturePropagatorDescriptorFactory *	factory ()
static void	setFactory (DtSignaturePropagatorDescriptorFactory *factory)
static DtSignaturePropagatorDescriptor *	createSignaturePropagatorDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
static DtSignaturePropagatorDescriptor *	createSignaturePropagatorDescriptor (const char *pName)
static DtSignaturePropagatorDescriptor *	creator ()
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.
DtRwBoolean	myCheckSmoke
DtRwEntityType	mySmokeType
DtRwReal	myMinSmokeBlockDistance
DtRwReal	myMinSmokeBlockDensity
Protected Attributes inherited from DtStandardPropagatorDescriptor
DtRwBoolean	myCheckLineOfSight
Protected Attributes inherited from DtSignaturePropagatorDescriptor
DtRwString	myPropagatorType
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
	DtInfraredSignaturePropagatorDescriptor ()

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 DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
Static Protected Attributes inherited from DtSignaturePropagatorDescriptor
static DtSignaturePropagatorDescriptorFactory *	theFactory
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

DtInfraredSignaturePropagatorDescriptor::DtInfraredSignaturePropagatorDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

real constructor

DtInfraredSignaturePropagatorDescriptor::DtInfraredSignaturePropagatorDescriptor	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtInfraredSignaturePropagatorDescriptor::DtInfraredSignaturePropagatorDescriptor	(	const DtInfraredSignaturePropagatorDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

virtual DtInfraredSignaturePropagatorDescriptor::~DtInfraredSignaturePropagatorDescriptor ( )

overridevirtual

DtInfraredSignaturePropagatorDescriptor::DtInfraredSignaturePropagatorDescriptor ( )

private

default constructor; not implemented

Member Function Documentation

DtInfraredSignaturePropagatorDescriptor& DtInfraredSignaturePropagatorDescriptor::operator=

(

const DtInfraredSignaturePropagatorDescriptor &

orig

)

assignment

virtual DtString DtInfraredSignaturePropagatorDescriptor::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

DtInfraredSignaturePropagatorDescriptorType

Reimplemented from DtStandardPropagatorDescriptor.

virtual DtSignaturePropagatorDescriptor* DtInfraredSignaturePropagatorDescriptor::clone ( DtReaderWriterRegistry *  parentRegistry = NULL ) const

overridevirtual

Reimplemented from DtStandardPropagatorDescriptor.

static DtSignaturePropagatorDescriptor* DtInfraredSignaturePropagatorDescriptor::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.

virtual bool DtInfraredSignaturePropagatorDescriptor::checkSmokeIntersections ( ) const

virtual

Accessor/mutator for myCheckSmoke.

virtual void DtInfraredSignaturePropagatorDescriptor::setCheckSmokeIntersections ( bool  check )

virtual

Accessor/mutator for myCheckSmoke.

virtual const DtEntityType& DtInfraredSignaturePropagatorDescriptor::smokeType ( ) const

virtual

Accessor/mutator for mySmokeType.

virtual void DtInfraredSignaturePropagatorDescriptor::setSmokeType ( const DtEntityType &  type )

virtual

Accessor/mutator for mySmokeType.

virtual double DtInfraredSignaturePropagatorDescriptor::minSmokeBlockDistance ( ) const

virtual

See Also

myMinSmokeBlockDistance

virtual void DtInfraredSignaturePropagatorDescriptor::setMinSmokeBlockDistance ( double  value )

virtual

See Also

myMinSmokeBlockDistance

virtual double DtInfraredSignaturePropagatorDescriptor::minSmokeBlockDensity ( ) const

virtual

See Also

myMinSmokeBlockDensity

virtual void DtInfraredSignaturePropagatorDescriptor::setMinSmokeBlockDensity ( double  value )

virtual

See Also

myMinSmokeBlockDensity

Member Data Documentation

DtRwBoolean DtInfraredSignaturePropagatorDescriptor::myCheckSmoke

protected

Parameter Name: check-smoke
Parameter Description: Determines whether the propagator should check of any smoke objects that might be in between the sensor and the surrounding objects
Parameter Default Value: True
.

DtRwEntityType DtInfraredSignaturePropagatorDescriptor::mySmokeType

protected

Parameter Name: smoke-type
Parameter Description: The object type of the smoke objects to check for intersection
Parameter Default Value:
.

DtRwReal DtInfraredSignaturePropagatorDescriptor::myMinSmokeBlockDistance

protected

Parameter Name: min-smoke-block-distance
Parameter Description: The maximum distance that a viewer may look though a smoke cloud before their view is blocked completely. Any distance greater than the one specified here will block the sensor. This only applies to smoke clouds of greater density than the min-smoke-block-density. Parameter Units: meters Parameter Default Value: 2
.

DtRwReal DtInfraredSignaturePropagatorDescriptor::myMinSmokeBlockDensity

protected

Parameter Name: min-smoke-block-density
Parameter Description: The minimum smoke cloud density that will block the sensor. Any smoke clouds less than this density are ignored. Parameter Units: percent (0 - 1.0) Parameter Default Value: 0.25
.

---

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

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