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 DtPowerRangeDeterminant:

[legend]

Public Member Functions
	DtPowerRangeDeterminant ()

const DtPowerRangeDeterminant &	operator= (const DtPowerRangeDeterminant &orig)

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

bool	operator!= (const DtPowerRangeDeterminant &rhs) const

virtual	~DtPowerRangeDeterminant ()

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

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

virtual void	postGetSelf ()

virtual const DtString &	rangeFrom () const

virtual void	setRangeFrom (const DtString &)

virtual DtString	powerType () const

virtual double	detonationPower (double rangeFromShooter, double rangeFromImpact) const =0

virtual double	rangeFromShooterForPower (double power) const =0

virtual double	rangeFromImpactForPower (double power) const =0

virtual double	maximumRangeFromShooter () const =0

virtual double	maximumRangeFromImpact () const =0


	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)

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)

Static Public Attributes
static const DtString	DtRangeFromShooterToImpact

static const DtString	DtRangeFromImpactPoint

static const DtString	DtRangeUnused

static const DtString	DtRangeFromShooterAndImpact

Protected Member Functions
virtual void	validateRangeFrom ()=0

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

Protected Attributes
parameters
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

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

DtPowerRangeDeterminant::DtPowerRangeDeterminant ( )

= "shooter-and-impact-point"

Default constructor

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

Constructor with parameters to set up read/writability correctly.

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

Constructor with parameters to set up read/writability correctly.

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

Copy constructor.

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

Copy constructor.

virtual DtPowerRangeDeterminant::~DtPowerRangeDeterminant ( )

virtual

Destructor.

Member Function Documentation

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

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

virtual

Reimplemented in DtPowerRangeCoefficientsDeterminant, DtPowerRangeListDeterminant, DtPowerRangeEquivalentTntDeterminant, and DtPowerDirectDeterminant.

bool DtPowerRangeDeterminant::operator!= ( const DtPowerRangeDeterminant & rhs ) const

inline

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

pure virtual

Implemented in DtPowerRangeCoefficientsDeterminant, DtPowerRangeListDeterminant, DtPowerRangeEquivalentTntDeterminant, and DtPowerDirectDeterminant.

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

pure virtual

Implemented in DtPowerRangeCoefficientsDeterminant, DtPowerRangeListDeterminant, DtPowerRangeEquivalentTntDeterminant, and DtPowerDirectDeterminant.

virtual void DtPowerRangeDeterminant::postGetSelf ( )

virtual

Called after reading in settings. Calls validateRangeFrom to ensure the configured rangeFrom value is valid.

Reimplemented from DtReaderWriter.

Reimplemented in DtPowerRangeEquivalentTntDeterminant.

virtual const DtString& DtPowerRangeDeterminant::rangeFrom ( ) const

virtual

Indicates how the input range is measured. Expected values are "shooter-to-impact", "impact-point", "unused", or "shooter-and-impact-point". Not all values are supported for all determinant types.

virtual void DtPowerRangeDeterminant::setRangeFrom ( const DtString & )

virtual

Sets the myRangeFrom.

virtual DtString DtPowerRangeDeterminant::powerType ( ) const

virtual

A string indicating the type of power being represented (e.g. "explosive", "kinetic").

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

pure virtual

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

Implemented in DtPowerRangeCoefficientsDeterminant, DtPowerRangeListDeterminant, DtPowerRangeEquivalentTntDeterminant, and DtPowerDirectDeterminant.

virtual double DtPowerRangeDeterminant::rangeFromShooterForPower ( double power ) const

pure virtual

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

Implemented in DtPowerRangeCoefficientsDeterminant, DtPowerRangeListDeterminant, DtPowerRangeEquivalentTntDeterminant, and DtPowerDirectDeterminant.

virtual double DtPowerRangeDeterminant::rangeFromImpactForPower ( double power ) const

pure virtual

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

Implemented in DtPowerRangeCoefficientsDeterminant, DtPowerRangeListDeterminant, DtPowerRangeEquivalentTntDeterminant, and DtPowerDirectDeterminant.

virtual double DtPowerRangeDeterminant::maximumRangeFromShooter ( ) const

pure virtual

Gets the maximum effective range from shooter of this detonation.

Implemented in DtPowerRangeCoefficientsDeterminant, DtPowerRangeListDeterminant, DtPowerRangeEquivalentTntDeterminant, and DtPowerDirectDeterminant.

virtual double DtPowerRangeDeterminant::maximumRangeFromImpact ( ) const

pure virtual

Gets the maximum effective range from impact of this detonation.

Implemented in DtPowerRangeCoefficientsDeterminant, DtPowerRangeListDeterminant, DtPowerRangeEquivalentTntDeterminant, and DtPowerDirectDeterminant.

virtual void DtPowerRangeDeterminant::validateRangeFrom ( )

protectedpure virtual

Validates the configured range-from setting and restores to a valid default if configuration is unsupported.

Implemented in DtPowerRangeCoefficientsDeterminant, DtPowerRangeEquivalentTntDeterminant, DtPowerRangeListDeterminant, and DtPowerDirectDeterminant.

Member Data Documentation

const DtString DtPowerRangeDeterminant::DtRangeFromShooterToImpact

static

const DtString DtPowerRangeDeterminant::DtRangeFromImpactPoint

static

= "shooter-to-impact"

const DtString DtPowerRangeDeterminant::DtRangeUnused

static

= "impact-point"

const DtString DtPowerRangeDeterminant::DtRangeFromShooterAndImpact

static

= "unused"

DtRwString DtPowerRangeDeterminant::myRangeFrom

protected

Parameter Name: range-from
Parameter Description: The determinant will determine the power based on the input ranges according to this setting. Not all determinants support all values.
Expected values are:
"shooter-to-impact" - Only uses the range from shooter to the point of impact.
"impact-point" - Only uses the range from the point of impact.
"unused" - The input ranges are unused.
"shooter-and-impact-point" - Uses both range from shooter to impact and range from impact.
Parameter Default Value: "impact-point"
.

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

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

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation