A readable/writable object that indicates the power of a detonation of a given type, potentially at different ranges from the point of impact.

Inheritance diagram for DtPowerRangeListDeterminant:

[legend]

Public Member Functions
	DtPowerRangeListDeterminant ()

const DtPowerRangeListDeterminant &	operator= (const DtPowerRangeListDeterminant &orig)

virtual bool	operator== (const DtPowerRangeDeterminant &rhs) const

virtual	~DtPowerRangeListDeterminant ()

virtual DtPowerRangeListDeterminant *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const

virtual DtPowerRangeListDeterminant *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const

virtual double	detonationPower (double rangeFromShooter, double rangeFromImpact) const

virtual double	rangeFromShooterForPower (double power) const

virtual double	rangeFromImpactForPower (double power) const

virtual double	maximumRangeFromShooter () const

virtual double	maximumRangeFromImpact () const


	DtPowerRangeListDeterminant (const DtString &surface, DtReaderWriterRegistry *parentRegistry=NULL)

	DtPowerRangeListDeterminant (const DtSymbolString &surface, DtReaderWriterRegistry *parentRegistry=NULL)


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

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

Public Member Functions inherited from DtPowerRangeDeterminant
	DtPowerRangeDeterminant ()

const DtPowerRangeDeterminant &	operator= (const DtPowerRangeDeterminant &orig)

bool	operator!= (const DtPowerRangeDeterminant &rhs) const

virtual	~DtPowerRangeDeterminant ()

virtual void	postGetSelf ()

virtual const DtString &	rangeFrom () const

virtual void	setRangeFrom (const DtString &)

virtual DtString	powerType () const

	DtPowerRangeDeterminant (const DtString &surface, DtReaderWriterRegistry *parentRegistry=NULL)

	DtPowerRangeDeterminant (const DtSymbolString &surface, DtReaderWriterRegistry *parentRegistry=NULL)

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

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

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

Protected Attributes
parameters
DtPowerRangeList	myRangeList

Protected Attributes inherited from DtPowerRangeDeterminant
DtRwString	myRangeFrom

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 Types
typedef DtPrbStepFunction	DtPowerRangeList

virtual void	setRangeList (const DtPowerRangeList &rangeList)

virtual const DtPowerRangeList &	rangeList () const

virtual DtPowerRangeList &	rangeList ()

static DtPowerRangeDeterminant *	creator ()

virtual double	powerFromRange (double range) const

virtual double	rangeFromPower (double power) const

virtual void	validateRangeFrom ()

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

Static Public Attributes inherited from DtPowerRangeDeterminant
static const DtString	DtRangeFromShooterToImpact

static const DtString	DtRangeFromImpactPoint

static const DtString	DtRangeUnused

static const DtString	DtRangeFromShooterAndImpact

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

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

Member Typedef Documentation

typedef DtPrbStepFunction DtPowerRangeListDeterminant::DtPowerRangeList

private

The probability range list is essentially the same structure as our power range list: a series of values associated with a range. The only difference is that here we are limited to one value per range rather than a list.

Constructor & Destructor Documentation

DtPowerRangeListDeterminant::DtPowerRangeListDeterminant ( )

Default constructor.

DtPowerRangeListDeterminant::DtPowerRangeListDeterminant	(	const DtString &	surface,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

Constructor with parameters to set up read/writability correctly.

DtPowerRangeListDeterminant::DtPowerRangeListDeterminant	(	const DtSymbolString &	surface,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

Constructor with parameters to set up read/writability correctly.

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

Copy constructor.

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

Copy constructor.

virtual DtPowerRangeListDeterminant::~DtPowerRangeListDeterminant ( )

virtual

Destructor.

Member Function Documentation

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

virtual bool DtPowerRangeListDeterminant::operator== ( const DtPowerRangeDeterminant & rhs ) const

virtual

Reimplemented from DtPowerRangeDeterminant.

virtual DtPowerRangeListDeterminant* DtPowerRangeListDeterminant::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const

virtual

Implements DtPowerRangeDeterminant.

virtual DtPowerRangeListDeterminant* DtPowerRangeListDeterminant::clone	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const

virtual

Implements DtPowerRangeDeterminant.

virtual double DtPowerRangeListDeterminant::detonationPower	(	double	rangeFromShooter,
		double	rangeFromImpact
	)		const

virtual

Gets the detonation's power the given range from the shooter and range from the point of impact.

Implements DtPowerRangeDeterminant.

virtual double DtPowerRangeListDeterminant::rangeFromShooterForPower ( double power ) const

virtual

Gets the maximum range from the shooter where the impact point would experience the specified power.

Implements DtPowerRangeDeterminant.

virtual double DtPowerRangeListDeterminant::rangeFromImpactForPower ( double power ) const

virtual

Gets the maximum range from the impact point where one would experience the specified power.

Implements DtPowerRangeDeterminant.

virtual double DtPowerRangeListDeterminant::maximumRangeFromShooter ( ) const

virtual

Gets the maximum effective range from shooter of this detonation.

Implements DtPowerRangeDeterminant.

virtual double DtPowerRangeListDeterminant::maximumRangeFromImpact ( ) const

virtual

Gets the maximum effective range from impact of this detonation.

Implements DtPowerRangeDeterminant.

virtual void DtPowerRangeListDeterminant::setRangeList ( const DtPowerRangeList & rangeList )

virtual

Accessor/mutator for myRangeList.

virtual const DtPowerRangeList& DtPowerRangeListDeterminant::rangeList ( ) const

virtual

Accessor/mutator for myRangeList.

virtual DtPowerRangeList& DtPowerRangeListDeterminant::rangeList ( )

virtual

Accessor/mutator for myRangeList.

static DtPowerRangeDeterminant* DtPowerRangeListDeterminant::creator ( )

inlinestatic

}

Creator function.

virtual double DtPowerRangeListDeterminant::powerFromRange ( double range ) const

protectedvirtual

Looks up a power value based on an input range.

virtual double DtPowerRangeListDeterminant::rangeFromPower ( double power ) const

protectedvirtual

Looks up a power value based on an input range.

virtual void DtPowerRangeListDeterminant::validateRangeFrom ( )

protectedvirtual

Validates the configured range-from setting and restores to a valid default if configuration is unsupported. This determinant expects a value of "shooter-to-impact" or "impact-point".

Implements DtPowerRangeDeterminant.

Member Data Documentation

DtPowerRangeList DtPowerRangeListDeterminant::myRangeList

protected

Parameter Name: range-list
Parameter Description: List of range/power entries, in order of increasing range. The power for a given entry applies to a range interval going from the range in the previous entry to the current entry range. For the first item in the list, the probability applies to a range of zero to the range specified in the entry.
.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjparam/powerRangeListDeterminant.h

Public Member Functions

Protected Attributes

Private Types

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation