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.

Inheritance diagram for DtUnderwaterAcousticsSignatureModifier:

Public Member Functions
	DtUnderwaterAcousticsSignatureModifier ()

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

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

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

DtUnderwaterAcousticsSignatureModifier &	operator= (const DtUnderwaterAcousticsSignatureModifier &orig)

virtual	~DtUnderwaterAcousticsSignatureModifier () override

virtual DtSignatureModifier *	clone (DtReaderWriterRegistry *const parentRegistry=NULL) const override

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

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

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

	DtSignatureModifier (const DtSignatureModifier &orig, DtReaderWriterRegistry *const parentRegistry=NULL)

DtSignatureModifier &	operator= (const DtSignatureModifier &orig)

virtual	~DtSignatureModifier () override

virtual DtString	type () const

virtual bool	operator== (const DtSignatureModifier &) const

bool	operator!= (const DtSignatureModifier &rhs) 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	putData (std::string &fp, int indentLevel=0)

virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

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 DtSignatureModifier *	create ()

Static Public Member Functions inherited from DtSignatureModifier
static void	setFactory (DtSignatureModifierFactory *factory)

static DtSignatureModifier *	createSignatureModifier (const DtString &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 ()

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
DtRwInt	myNominalRPM

DtRwReal	myMinimumSignatureModifier

DtRwReal	myMaximumSignatureModifier

DtRwReal	myActiveSonarEnabledModifier

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

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Static Protected Attributes inherited from DtSignatureModifier
static DtSignatureModifierFactory *	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

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

overridevirtual

Member Function Documentation

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

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

overridevirtual

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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfutil/underwaterAcousticsSignatureModifier.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation