DtDynamicTerrainCommand Class Reference

Base class for any DtSimCommand which causes dynamic terrain changes to be added or removed. Must be subclassed for specific functionality.

Inheritance diagram for DtDynamicTerrainCommand:

Public Types
enum	GeometryType { Circular, Polygonal, WholeWorld }
Public Types inherited from DtSimCommand
typedef DtSimCommandMessageType	FactoryKeyType
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 )()

Public Member Functions
	DtDynamicTerrainCommand ()
	DtDynamicTerrainCommand (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtDynamicTerrainCommand (const DtString &writeName, const DtDynamicTerrainCommand &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtDynamicTerrainCommand ()
DtDynamicTerrainCommand &	operator= (const DtDynamicTerrainCommand &orig)
virtual DtString	stringRep () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	setGeometryType (GeometryType geomType)
virtual GeometryType	geometryType () const
virtual void	setCenterOfCircle (const DtVector &location)
virtual DtVector	centerOfCircle () const
virtual void	setRadiusOfCircle (double radius)
virtual double	radiusOfCircle () const
virtual void	setVerticesOfPolygon (const DtRwVectorList &locations)
virtual const DtRwVectorList &	verticesOfPolygon () const
virtual void	addVertexToPolygon (const DtVector &location)
virtual void	setChanges (const std::map< DtString, DtString > &changes)
virtual void	setChanges (const DtRwKeyValueList &changes)
virtual const DtRwKeyValueList &	changes () const
virtual void	addChange (const DtString &changeType, const DtString &changeVal)
Public Member Functions inherited from DtSimCommand
virtual	~DtSimCommand ()
virtual bool	init ()
virtual const DtSimCommandMessageType &	type () const =0
virtual DtSimCommand *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const =0
virtual DtSimCommand *	clone () const
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual char *	netRep ()
virtual void	setLocalDelivery (bool)
virtual bool	localDelivery () 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)
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	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
DtRwInt	myGeometryType
DtRwVector	myCenterOfCircle
DtRwReal	myRadiusOfCircle
DtRwVectorList	myVerticesOfPolygon
DtRwKeyValueList	myChanges
Protected Attributes inherited from DtSimCommand
char *	myNetRep
bool	myLocalDelivery
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
Static Public Member Functions inherited from DtSimCommand
static DtSimCommand *	createSimCommand (DtlObjPtr mtlStream)
static DtSimCommand *	createSimCommand (const DtSimCommandMessageType &simCommandType)
static DtSimCommand *	createFromFactory (const DtSimCommandMessageType &simCommandType)
static void	addSimCommandCreatorFcn (const DtSimCommandMessageType &simCommandName, DtSimCommandCreatorFcn fcn)
static void	setFactory (DtSimCommandFactory *factory)
static DtSimCommandFactory *	factory ()
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 DtSimCommand
	DtSimCommand ()
	DtSimCommand (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtSimCommand (const DtString &writeName, const DtSimCommand &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtSimCommand &	operator= (const DtSimCommand &orig)
virtual char *	createNetworkBuffer ()
virtual bool	isTypeRegistered (const DtSimCommandMessageType &commandType)
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
Static Protected Attributes inherited from DtSimCommand
static DtSimCommandFactory *	myFactory
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 Enumeration Documentation

enum DtDynamicTerrainCommand::GeometryType

Enumerator
Circular
Polygonal	Changes within radius of point.
WholeWorld	Changes within area defined by vertices. All changes

Constructor & Destructor Documentation

DtDynamicTerrainCommand::DtDynamicTerrainCommand

(

)

Default constructor.

DtDynamicTerrainCommand::DtDynamicTerrainCommand	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

Usual constructor.

DtDynamicTerrainCommand::DtDynamicTerrainCommand	(	const DtString &	writeName,
		const DtDynamicTerrainCommand &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

virtual DtDynamicTerrainCommand::~DtDynamicTerrainCommand ( )

virtual

destructor

Member Function Documentation

DtDynamicTerrainCommand& DtDynamicTerrainCommand::operator=

(

const DtDynamicTerrainCommand &

orig

)

assignment operator

virtual void DtDynamicTerrainCommand::setGeometryType ( GeometryType  geomType )

virtual

The type of geometry being described.

virtual GeometryType DtDynamicTerrainCommand::geometryType ( ) const

virtual

The type of geometry being described.

virtual void DtDynamicTerrainCommand::setCenterOfCircle ( const DtVector &  location )

virtual

The geocentric location of the center of the circular area. Valid only if geometryType is Circular.

virtual DtVector DtDynamicTerrainCommand::centerOfCircle ( ) const

virtual

The geocentric location of the center of the circular area. Valid only if geometryType is Circular.

virtual void DtDynamicTerrainCommand::setRadiusOfCircle ( double  radius )

virtual

The radius of the circular area. Valid only if geometryType is Circular.

virtual double DtDynamicTerrainCommand::radiusOfCircle ( ) const

virtual

The radius of the circular area. Valid only if geometryType is Circular.

virtual void DtDynamicTerrainCommand::setVerticesOfPolygon ( const DtRwVectorList &  locations )

virtual

The geocentric locations of the vertices of the polygonal area. Valid only if geometryType is Polygonal.

virtual const DtRwVectorList& DtDynamicTerrainCommand::verticesOfPolygon ( ) const

virtual

The geocentric locations of the vertices of the polygonal area. Valid only if geometryType is Polygonal.

virtual void DtDynamicTerrainCommand::addVertexToPolygon ( const DtVector &  location )

virtual

The geocentric locations of the vertices of the polygonal area. Valid only if geometryType is Polygonal.

virtual void DtDynamicTerrainCommand::setChanges ( const std::map< DtString, DtString > &  changes )

virtual

Optional list of the specific types of terrain changes to be made.

virtual void DtDynamicTerrainCommand::setChanges ( const DtRwKeyValueList &  changes )

virtual

Optional list of the specific types of terrain changes to be made.

virtual const DtRwKeyValueList& DtDynamicTerrainCommand::changes ( ) const

virtual

Optional list of the specific types of terrain changes to be made.

virtual void DtDynamicTerrainCommand::addChange ( const DtString &  changeType, const DtString &  changeVal  )

virtual

Optional list of the specific types of terrain changes to be made.

virtual DtString DtDynamicTerrainCommand::stringRep ( ) const

virtual

Text representation of this command.

Implements DtSimCommand.

virtual int DtDynamicTerrainCommand::netRepSize ( ) const

virtual

Returns the size in bytes of the network representation of the class. This is the size in bytes of the DtNetSimSimCommand structure. Derived classes should take into acount the size returned by this class when overriding (they should call down to this class and add the result to their additional size).

Reimplemented from DtSimCommand.

virtual bool DtDynamicTerrainCommand::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

virtual

Sets mySubsimCommand member from the incoming contentBuffer (cast to type DtNetSimSimCommand). Derived classes should call down to this function first, and then extract their own data starting at the location contentBuffer + DtSimCommand::netRepSize().

Reimplemented from DtSimCommand.

virtual bool DtDynamicTerrainCommand::setToNet ( )

virtual

Calls netRep() to create the network buffer. Casts the resulting myNetRep to type DtNetSimSimCommand*, and then sets the mySubsimCommand member in the DtNetSimSimCommand from mySubsimCommand. Derived classes should call down to the base class version of setToNet() at the start of the function (before doing any processing on the network representation) They can then start to fill in their network data, starting at the location myNetRep + DtSimCommand::netRepSize().

Reimplemented from DtSimCommand.

Member Data Documentation

DtRwInt DtDynamicTerrainCommand::myGeometryType

protected

DtRwVector DtDynamicTerrainCommand::myCenterOfCircle

protected

DtRwReal DtDynamicTerrainCommand::myRadiusOfCircle

protected

DtRwVectorList DtDynamicTerrainCommand::myVerticesOfPolygon

protected

DtRwKeyValueList DtDynamicTerrainCommand::myChanges

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfplan/dynamicTerrainCommand.h