DtUnderwaterAcousticsSignatureModifier Class Reference

Modifies a signature based on presence of an enabled active sonar system and a propulsion noise generator. More...

Inheritance diagram for DtUnderwaterAcousticsSignatureModifier:

Public Member Functions
	DtUnderwaterAcousticsSignatureModifier ()
	default constructor
	DtUnderwaterAcousticsSignatureModifier (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	real constructor
	DtUnderwaterAcousticsSignatureModifier (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtUnderwaterAcousticsSignatureModifier (const DtUnderwaterAcousticsSignatureModifier &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
	copy constructor
DtUnderwaterAcousticsSignatureModifier &	operator= (const DtUnderwaterAcousticsSignatureModifier &orig)
virtual	~DtUnderwaterAcousticsSignatureModifier ()
virtual DtSignatureModifier *	clone (DtReaderWriterRegistry *const parentRegistry=NULL) const
	Returns a copy of this class.
int	nominalRPM () const
void	setNominalRPM (int rpm)
double	maximumSignatureModifier () const
void	setMaximumSignatureModifier (double limit)
double	minimumSignatureModifier () const
void	setMinimumSignatureModifier (double limit)
double	activeSonarEnabledModifier () const
void	setActiveSonarEnabledModifier (double modifier)
Public Member Functions inherited from DtSignatureModifier
	DtSignatureModifier ()
	default constructor
	DtSignatureModifier (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	real constructor
	DtSignatureModifier (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtSignatureModifier (const DtSignatureModifier &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
	copy constructor
DtSignatureModifier &	operator= (const DtSignatureModifier &orig)
virtual	~DtSignatureModifier ()
virtual DtString	type () const
virtual bool	operator== (const DtSignatureModifier &) const
	Comparrison operator. Override to compare specific subclasses.
bool	operator!= (const DtSignatureModifier &rhs) 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 void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
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 DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class.
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 DtSignatureModifier *	create ()
Static Public Member Functions inherited from DtSignatureModifier
static void	setFactory (DtSignatureModifierFactory *factory)
	Sets the static factory member.
static DtSignatureModifier *	createSignatureModifier (const DtString &type)
	Uses the static factory assigned in setFactory to create the requested signature modifier type.
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 ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
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)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.

Protected Attributes
DtRwInt	myNominalRPM
	RPM at which the signature modifier is 1.0.
DtRwReal	myMinimumSignatureModifier
	Regardless of actual RPM vs nominal RPM, the signature modifier will never go below this value.
DtRwReal	myMaximumSignatureModifier
	Regardless of actual RPM vs nominal RPM, the signature modifier will never go below this value.
DtRwReal	myActiveSonarEnabledModifier
	This modifier will override the RPM modifier if the entity has an active sonar enabled.

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 DtSignatureModifier
static DtSignatureModifierFactory *	theFactory
	Static pointer to the factory for signature modifiers.

Detailed Description

Modifies a signature based on presence of an enabled active sonar system and a propulsion noise generator.

Uses a nominal RPM to compare with the actual RPM to generate a signature modifier.

Constructor & Destructor Documentation

DtUnderwaterAcousticsSignatureModifier::DtUnderwaterAcousticsSignatureModifier

(

)

default constructor

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

real constructor

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

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

copy constructor

virtual DtUnderwaterAcousticsSignatureModifier::~DtUnderwaterAcousticsSignatureModifier ( )

virtual

Member Function Documentation

DtUnderwaterAcousticsSignatureModifier& DtUnderwaterAcousticsSignatureModifier::operator=

(

const DtUnderwaterAcousticsSignatureModifier &

orig

)

virtual DtSignatureModifier* DtUnderwaterAcousticsSignatureModifier::clone ( DtReaderWriterRegistry *const  parentRegistry = NULL ) const

virtual

Returns a copy of this class.

Implements DtSignatureModifier.

static DtSignatureModifier* DtUnderwaterAcousticsSignatureModifier::create ( )

static

int DtUnderwaterAcousticsSignatureModifier::nominalRPM ( ) const

inline

void DtUnderwaterAcousticsSignatureModifier::setNominalRPM ( int  rpm )

inline

double DtUnderwaterAcousticsSignatureModifier::maximumSignatureModifier ( ) const

inline

void DtUnderwaterAcousticsSignatureModifier::setMaximumSignatureModifier ( double  limit )

inline

double DtUnderwaterAcousticsSignatureModifier::minimumSignatureModifier ( ) const

inline

void DtUnderwaterAcousticsSignatureModifier::setMinimumSignatureModifier ( double  limit )

inline

double DtUnderwaterAcousticsSignatureModifier::activeSonarEnabledModifier ( ) const

inline

void DtUnderwaterAcousticsSignatureModifier::setActiveSonarEnabledModifier ( double  modifier )

inline

Member Data Documentation

DtRwInt DtUnderwaterAcousticsSignatureModifier::myNominalRPM

protected

RPM at which the signature modifier is 1.0.

For example: if the nominal rpm is 100, and the actual rpm is 85, the modifier is 0.85; or if the actual rpm is 150, the modifier is 1.5.

DtRwReal DtUnderwaterAcousticsSignatureModifier::myMinimumSignatureModifier

protected

Regardless of actual RPM vs nominal RPM, the signature modifier will never go below this value.

DtRwReal DtUnderwaterAcousticsSignatureModifier::myMaximumSignatureModifier

protected

Regardless of actual RPM vs nominal RPM, the signature modifier will never go below this value.

DtRwReal DtUnderwaterAcousticsSignatureModifier::myActiveSonarEnabledModifier

protected

This modifier will override the RPM modifier if the entity has an active sonar enabled.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/underwaterAcousticsSignatureModifier.h