Inheritance diagram for DtCraterDeformationParamsEntry:

Public Member Functions
	DtCraterDeformationParamsEntry ()

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

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

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

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

const DtCraterDeformationParamsEntry &	operator= (const DtCraterDeformationParamsEntry &orig)

virtual	~DtCraterDeformationParamsEntry ()

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

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


virtual int	originalLandCover () const

virtual void	setOriginalLandCover (int origLandCover)


virtual int	craterLandCover () const

virtual void	setcraterLandCover (int craterLandCover)


virtual int	craterTypeEnumerant () const

virtual void	setcraterTypeEnumerant (int craterTypeEnumerant)


virtual int	craterImageEnumerant () const

virtual void	setCraterImageEnumerant (int craterImageEnumearant)


virtual double	craterRadiusCoefficent () const

virtual void	setcraterRadiusCoefficent (double craterRadiusCoefficient)


virtual double	craterDepthCoefficient () const

virtual void	setcraterDepthCoefficient (double craterDepthCoefficient)

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	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	wasUpdatedSince (DtTime t) 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
These parameters are available for setting in the OPD files.
DtRwInt	myOriginalLandCover

DtRwInt	myCraterLandCover

DtRwInt	myCraterTypeEnumerant

DtRwInt	myCraterImageEnum

DtRwReal	myCraterRadiusCoefficient

DtRwReal	myCraterDepthCoefficient

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)

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

Constructor & Destructor Documentation

DtCraterDeformationParamsEntry::DtCraterDeformationParamsEntry ( )

default constructor

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

real constructor

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

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

copy constructor

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

virtual DtCraterDeformationParamsEntry::~DtCraterDeformationParamsEntry ( )

virtual

Member Function Documentation

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

assignment operator

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

virtual

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

virtual

virtual int DtCraterDeformationParamsEntry::originalLandCover ( ) const

virtual

Accessor/mutator for myOriginalLandCover.

virtual void DtCraterDeformationParamsEntry::setOriginalLandCover ( int origLandCover )

virtual

Accessor/mutator for myOriginalLandCover.

virtual int DtCraterDeformationParamsEntry::craterLandCover ( ) const

virtual

Accessor/mutator for myCraterLandCover.

virtual void DtCraterDeformationParamsEntry::setcraterLandCover ( int craterLandCover )

virtual

Accessor/mutator for myCraterLandCover.

virtual int DtCraterDeformationParamsEntry::craterTypeEnumerant ( ) const

virtual

Accessor/mutator for myCraterTypeEnumerant.

virtual void DtCraterDeformationParamsEntry::setcraterTypeEnumerant ( int craterTypeEnumerant )

virtual

Accessor/mutator for myCraterTypeEnumerant.

virtual int DtCraterDeformationParamsEntry::craterImageEnumerant ( ) const

virtual

Accessor/mutator for myCraterImageEnum.

virtual void DtCraterDeformationParamsEntry::setCraterImageEnumerant ( int craterImageEnumearant )

virtual

Accessor/mutator for myCraterImageEnum.

virtual double DtCraterDeformationParamsEntry::craterRadiusCoefficent ( ) const

virtual

Accessor/mutator for myCraterRadiusCoefficient.

virtual void DtCraterDeformationParamsEntry::setcraterRadiusCoefficent ( double craterRadiusCoefficient )

virtual

Accessor/mutator for myCraterRadiusCoefficient.

virtual double DtCraterDeformationParamsEntry::craterDepthCoefficient ( ) const

virtual

Accessor/mutator for myCraterDepthCoefficient.

virtual void DtCraterDeformationParamsEntry::setcraterDepthCoefficient ( double craterDepthCoefficient )

virtual

Accessor/mutator for myCraterDepthCoefficient.

Member Data Documentation

DtRwInt DtCraterDeformationParamsEntry::myOriginalLandCover

protected

Parameter Name: original-land-cover
Parameter Description: The existing land cover for the crater area.
Parameter Default Value:
.

DtRwInt DtCraterDeformationParamsEntry::myCraterLandCover

protected

Parameter Name: crater-land-cover
Parameter Description: The resulting land cover for the crater area.
Parameter Default Value:
.

DtRwInt DtCraterDeformationParamsEntry::myCraterTypeEnumerant

protected

Parameter Name: crater-type-enumerant
Parameter Description: An enumerant determining whether the entry is for the elevation, land cover or both.
Parameter Default Value:
.

DtRwInt DtCraterDeformationParamsEntry::myCraterImageEnum

protected

Parameter Name: crater-image-enumerant
Parameter Description: An enumeration for the crater image Parameter Default Value: -1
.

DtRwReal DtCraterDeformationParamsEntry::myCraterRadiusCoefficient

protected

Parameter Name: crater-radius-coefficient
Parameter Description: The coefficient used in determining the crater radius.
Parameter Default Value: 1.35
.

DtRwReal DtCraterDeformationParamsEntry::myCraterDepthCoefficient

protected

Parameter Name: crater-depth-coefficient
Parameter Description: The coefficient used in determining the crater depth.
Parameter Default Value: 0.5
.

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation