DtLoadPoint; Readable/writeable object for describing position for entity loading/unloading. More...

Inheritance diagram for DtLoadPoint:

Public Member Functions
	DtLoadPoint (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtLoadPoint (const DtLoadPoint &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtLoadPoint ()
DtLoadPoint &	operator= (const DtLoadPoint &orig)
	assignment
const DtRwTemplatedListPtr < DtRwVector > &	points () const
	Accessor for myPoints.
void	addPoint (const DtVector &)
	Add a point to myPoints.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual bool	operator== (const DtLoadPoint &) const
	Equivalence operator.
virtual bool	operator!= (const DtLoadPoint &) const

DtNLengthIntegerVector &	supportedSlots ()
	Accessor/mutator for mySlots.
const DtNLengthIntegerVector &	supportedSlots () const
	Accessor/mutator for mySlots.
void	setSupportedSlots (const DtNLengthIntegerVector &)
	Accessor/mutator for mySlots.
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 DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
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 aliasContainer &	aliases () 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 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 DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtNLengthIntegerVector	mySlots
	Parameter Name: embarkation-slots Parameter Description: List of integer identifiers for positions that can be occupied by embarked entities.
DtRwTemplatedListPtr< DtRwVector >	myPoints
	Parameter Name: embarkation-load-points Parameter Description: List of position offsets relative to the entity being embarked upon.
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
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 DtReaderWriterFactory *	factory ()
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.
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static DtReaderWriterFactory	theFactory

Detailed Description

DtLoadPoint; Readable/writeable object for describing position for entity loading/unloading.

Instances of DtLoadPoint describe a point that an entity will move to when loading onto or unloading off of an entity.

Constructor & Destructor Documentation

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

DtLoadPoint::DtLoadPoint	(	const DtLoadPoint &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

virtual DtLoadPoint::~DtLoadPoint ( )

virtual

Member Function Documentation

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

assignment

DtNLengthIntegerVector & DtLoadPoint::supportedSlots ( )

inline

Accessor/mutator for mySlots.

References mySlots.

const DtNLengthIntegerVector & DtLoadPoint::supportedSlots ( ) const

inline

Accessor/mutator for mySlots.

References mySlots.

void DtLoadPoint::setSupportedSlots ( const DtNLengthIntegerVector & s )

inline

Accessor/mutator for mySlots.

References mySlots.

const DtRwTemplatedListPtr< DtRwVector > & DtLoadPoint::points ( ) const

inline

Accessor for myPoints.

References myPoints.

void DtLoadPoint::addPoint ( const DtVector & v )

inline

Add a point to myPoints.

References DtRwList::add(), and myPoints.

virtual const char* DtLoadPoint::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.

virtual bool DtLoadPoint::operator== ( const DtLoadPoint & ) const

virtual

Equivalence operator.

virtual bool DtLoadPoint::operator!= ( const DtLoadPoint & ) const

virtual

Member Data Documentation

DtNLengthIntegerVector DtLoadPoint::mySlots

protected

Parameter Name: embarkation-slots
Parameter Description: List of integer identifiers for positions that can be occupied by embarked entities.

Parameter Default Value:

Referenced by setSupportedSlots(), and supportedSlots().

DtRwTemplatedListPtr<DtRwVector> DtLoadPoint::myPoints

protected

Parameter Name: embarkation-load-points
Parameter Description: List of position offsets relative to the entity being embarked upon.

Parameter Default Value:

Referenced by addPoint(), and points().

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

include/vrfobjparam/loadPoint.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation