VR-Forces 4.2 Class Documentation
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
DtRwGaussianPuffData Class Reference

DtRwGaussianPuffData; descriptor for the DtRwGaussianPuffData. More...

Inheritance diagram for DtRwGaussianPuffData:
Inheritance graph
[legend]

Public Member Functions

 DtRwGaussianPuffData (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 constructor
 DtRwGaussianPuffData (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=0)
 DtRwGaussianPuffData (const DtString &name, const DtRwGaussianPuffData &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
DtRwGaussianPuffDataoperator= (const DtRwGaussianPuffData &orig)
 assignment
virtual ~DtRwGaussianPuffData ()
 destructor
virtual void setDensity (double d)
virtual double density () const
virtual void setDensityRate (double d)
virtual double densityRate () const
virtual void setSigma (const DtVector &v)
virtual const DtVectorsigma () const
virtual void setSigmaRate (const DtVector &v)
virtual const DtVectorsigmaRate () const
virtual void setVelocity (const DtVector &v)
virtual const DtVectorvelocity () const
virtual void setLocation (const DtVector &v)
virtual const DtVectorlocation () const
virtual const DtVectororiginalLocation () const
virtual void setOrientation (const DtTaitBryan &tb)
virtual const DtTaitBryan & orientation () const
virtual void setAngularVelocity (const DtVector &v)
virtual const DtVectorangularVelocity () const
const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.
- 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)
 copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
bool operator== (const DtReaderWriter &) const
 Equivalence operator.
bool operator!= (const DtReaderWriter &rhs)
virtual ~DtReaderWriter ()
 destructor
virtual void putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file.
virtual void getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
virtual void writeSelf (FILE *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 bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
virtual bool isReadonly () const
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 DtString prettyPrint () const
 Routine to return a human readable form of the reader/writer variable.
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 void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
 The specified flags are used for optional values.
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)
 The variable name, if this object is a variable reference.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.

Protected Member Functions

 DtRwGaussianPuffData ()
 default constructor; not implemented
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
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 putData (FILE *fp, int indentLevel=0)
 Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Deriving class overrides these to get/put class specific data.

Protected Attributes

DtRwReal myDensity
DtRwReal myDensityRate
DtRwVector mySigma
DtRwVector mySigmaRate
DtRwVector myVelocity
DtRwVector myOrigLocation
DtRwVector myAngularVelocity
DtRwTaitBryan myOrientation
DtRwVector myLocation
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
DtReaderWriterRegistry myRegistry
bool myValueSpecified
bool myReadOnlyFlag
bool myIsVariableReference
DtSymbolString myVariableName
bool myVariableIsBound
aliasContainer myAliases
 Container for the aliases which represent alternative names for the object.
bool myInvalid
 Set to true if there is a problem reading this item.

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::pair
< DtSymbolString, DtString
DtVariableNameType
typedef DtReaderWriterFactory *(* DtReaderWriterFactoryCreatorFcn )()
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (FILE *fp, int indentLevel)
static const
DtVariableBindingsList
nullVariableReference ()
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
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 DtReaderWriterFactoryfactory ()
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
static DtGetSelfCallbackInfo thePostGetSelfCallback
static DtPutSelfCallbackInfo thePrePutSelfCallback
static const DtVariableBindingsList theEmptyVariableBindingsList
static bool theCreatorFcnSet
static DtReaderWriterFactorytheFactory
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn

Detailed Description

DtRwGaussianPuffData; descriptor for the DtRwGaussianPuffData.

DtRwPuffData: Read writable container to store geometric and associated data about a puff cloud such as density, the rate the density is changing, the standard deviation of the cloud

Constructor & Destructor Documentation

DtRwGaussianPuffData::DtRwGaussianPuffData ( const DtString name,
DtReaderWriterRegistry parentRegistry = 0 
)

constructor

DtRwGaussianPuffData::DtRwGaussianPuffData ( const DtSymbolString &  name,
DtReaderWriterRegistry parentRegistry = 0 
)
DtRwGaussianPuffData::DtRwGaussianPuffData ( const DtString name,
const DtRwGaussianPuffData orig,
DtReaderWriterRegistry parentRegistry = 0 
)

copy constructor

virtual DtRwGaussianPuffData::~DtRwGaussianPuffData ( )
virtual

destructor

DtRwGaussianPuffData::DtRwGaussianPuffData ( )
protected

default constructor; not implemented

Member Function Documentation

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

assignment

virtual void DtRwGaussianPuffData::setDensity ( double  d)
virtual
virtual double DtRwGaussianPuffData::density ( ) const
virtual
virtual void DtRwGaussianPuffData::setDensityRate ( double  d)
virtual
virtual double DtRwGaussianPuffData::densityRate ( ) const
virtual
virtual void DtRwGaussianPuffData::setSigma ( const DtVector v)
virtual
virtual const DtVector& DtRwGaussianPuffData::sigma ( ) const
virtual
virtual void DtRwGaussianPuffData::setSigmaRate ( const DtVector v)
virtual
virtual const DtVector& DtRwGaussianPuffData::sigmaRate ( ) const
virtual
virtual void DtRwGaussianPuffData::setVelocity ( const DtVector v)
virtual
virtual const DtVector& DtRwGaussianPuffData::velocity ( ) const
virtual
virtual void DtRwGaussianPuffData::setLocation ( const DtVector v)
virtual
virtual const DtVector& DtRwGaussianPuffData::location ( ) const
virtual
virtual const DtVector& DtRwGaussianPuffData::originalLocation ( ) const
virtual
virtual void DtRwGaussianPuffData::setOrientation ( const DtTaitBryan &  tb)
virtual
virtual const DtTaitBryan& DtRwGaussianPuffData::orientation ( ) const
virtual
virtual void DtRwGaussianPuffData::setAngularVelocity ( const DtVector v)
virtual
virtual const DtVector& DtRwGaussianPuffData::angularVelocity ( ) const
virtual
const char* DtRwGaussianPuffData::readerWriterType ( ) const
virtual

Used to supply a string type that this reader writer type is.

This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create

Reimplemented from DtReaderWriter.

Member Data Documentation

DtRwReal DtRwGaussianPuffData::myDensity
protected
DtRwReal DtRwGaussianPuffData::myDensityRate
protected
DtRwVector DtRwGaussianPuffData::mySigma
protected
DtRwVector DtRwGaussianPuffData::mySigmaRate
protected
DtRwVector DtRwGaussianPuffData::myVelocity
protected
DtRwVector DtRwGaussianPuffData::myOrigLocation
protected
DtRwVector DtRwGaussianPuffData::myAngularVelocity
protected
DtRwTaitBryan DtRwGaussianPuffData::myOrientation
protected
DtRwVector DtRwGaussianPuffData::myLocation
protected

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

Document ID: Generated on Sun Nov 24 19:49:21 EST 2013 from SVN revision 133924
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)