DtVisualSignaturePropagatorDescriptor; descriptor for the DtVisualSignaturePropagator component. More...

Inheritance diagram for DtVisualSignaturePropagatorDescriptor:

Public Member Functions
	DtVisualSignaturePropagatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtVisualSignaturePropagatorDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtVisualSignaturePropagatorDescriptor (const DtVisualSignaturePropagatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtVisualSignaturePropagatorDescriptor &	operator= (const DtVisualSignaturePropagatorDescriptor &orig)
	assignment
virtual	~DtVisualSignaturePropagatorDescriptor ()
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtSignaturePropagatorDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const

virtual bool	checkSmokeIntersections () const
	Accessor/mutator for myCheckSmoke.
virtual void	setCheckSmokeIntersections (bool check)

virtual const DtObjectType &	smokeType () const
	Accessor/mutator for mySmokeType.
virtual void	setSmokeType (const DtObjectType &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)
	real constructor
	DtStandardPropagatorDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtStandardPropagatorDescriptor (const DtStandardPropagatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtStandardPropagatorDescriptor &	operator= (const DtStandardPropagatorDescriptor &orig)
	assignment
virtual	~DtStandardPropagatorDescriptor ()
virtual bool	checkLineOfSight () const
	Accessor/mutator for myCheckLineOfSight.
virtual void	setCheckLineOfSight (bool yesNo)
virtual DtString	defaultFeatureLosQuery () const
	Accessor/mutator for myDefaultFeatureLosQuery.
virtual void	setDefaultFeatureLosQuery (const DtString &query)
virtual DtString	highAltitudeFeatureLosQuery () const
	Accessor/mutator for myHighAltitudeFeatureLosQuery.
virtual void	setHighAltitudeFeatureLosQuery (const DtString &query)
Public Member Functions inherited from DtSignaturePropagatorDescriptor
	DtSignaturePropagatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtSignaturePropagatorDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtSignaturePropagatorDescriptor (const DtSignaturePropagatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtSignaturePropagatorDescriptor &	operator= (const DtSignaturePropagatorDescriptor &orig)
	assignment
virtual	~DtSignaturePropagatorDescriptor ()
virtual void	putData (std::string &fp, int indentLevel=0)
	Overrides base class putData to output our type.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, 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 createSignaturePropagatorDescriptor(), allowing derived classes to do memory allocation if necessary.
virtual void	setPropagatorType (const DtString &componentType)
	Accessor/mutator for myPropagatorType.
virtual DtString	propagatorType () const
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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
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 (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &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 void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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 const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static DtSignaturePropagatorDescriptor *	creator ()

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwBoolean	myCheckSmoke
	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 .
DtRwObjectType	mySmokeType
	Parameter Name: smoke-type Parameter Description: The object type of the smoke objects to check for intersection Parameter Default Value: .
DtRwReal	myMinSmokeBlockDistance
	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.
DtRwReal	myMinSmokeBlockDensity
	Parameter Name: min-smoke-block-density Parameter Description: The minimum smoke cloud density that will block the sensor.
Protected Attributes inherited from DtStandardPropagatorDescriptor
DtRwBoolean	myCheckLineOfSight
	Parameter Name: check-line-of-sight Parameter Description: Flag indicating whether or not a line-of-sight check should be performed.
DtRwString	myDefaultFeatureLosQuery
	Parameter Name: default-feature-los-query Parameter Description: The default Los query to used.
DtRwString	myHighAltitudeFeatureLosQuery
	Parameter Name: high-altitude-feature-los-query Parameter Description: The Los query to used when both entities are high above the terrain.
Protected Attributes inherited from DtSignaturePropagatorDescriptor
DtRwString	myPropagatorType
	Parameter Name: propagator-type Parameter Description: String identifying type of signature propagator object.
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
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked.

Private Member Functions
	DtVisualSignaturePropagatorDescriptor ()
	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::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Static Protected Attributes inherited from DtSignaturePropagatorDescriptor
static DtSignaturePropagatorDescriptorFactory *	theFactory

Detailed Description

DtVisualSignaturePropagatorDescriptor; descriptor for the DtVisualSignaturePropagator component.

Descriptor containing configuration parameters for the DtStandardSignaturePropagator class.

Constructor & Destructor Documentation

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

real constructor

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

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

copy constructor

virtual DtVisualSignaturePropagatorDescriptor::~DtVisualSignaturePropagatorDescriptor ( )

virtual

DtVisualSignaturePropagatorDescriptor::DtVisualSignaturePropagatorDescriptor ( )

private

default constructor; not implemented

Member Function Documentation

DtVisualSignaturePropagatorDescriptor& DtVisualSignaturePropagatorDescriptor::operator= ( const DtVisualSignaturePropagatorDescriptor & orig )

assignment

virtual DtString DtVisualSignaturePropagatorDescriptor::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: DtVisualSignaturePropagatorDescriptorType

Reimplemented from DtStandardPropagatorDescriptor.

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

virtual

Reimplemented from DtStandardPropagatorDescriptor.

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

virtual bool DtVisualSignaturePropagatorDescriptor::checkSmokeIntersections ( ) const

virtual

Accessor/mutator for myCheckSmoke.

virtual void DtVisualSignaturePropagatorDescriptor::setCheckSmokeIntersections ( bool check )

virtual

virtual const DtObjectType& DtVisualSignaturePropagatorDescriptor::smokeType ( ) const

virtual

Accessor/mutator for mySmokeType.

virtual void DtVisualSignaturePropagatorDescriptor::setSmokeType ( const DtObjectType & type )

virtual

virtual double DtVisualSignaturePropagatorDescriptor::minSmokeBlockDistance ( ) const

virtual

See Also: myMinSmokeBlockDistance

virtual void DtVisualSignaturePropagatorDescriptor::setMinSmokeBlockDistance ( double value )

virtual

virtual double DtVisualSignaturePropagatorDescriptor::minSmokeBlockDensity ( ) const

virtual

See Also: myMinSmokeBlockDensity

virtual void DtVisualSignaturePropagatorDescriptor::setMinSmokeBlockDensity ( double value )

virtual

Member Data Documentation

DtRwBoolean DtVisualSignaturePropagatorDescriptor::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
.

DtRwObjectType DtVisualSignaturePropagatorDescriptor::mySmokeType

protected

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

DtRwReal DtVisualSignaturePropagatorDescriptor::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 DtVisualSignaturePropagatorDescriptor::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:

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation