VR-Forces 5.0.3 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
DtSetEmitterTrackJamTargets Class Referenceabstract

Set data request for setting tracking/jamming mode and target list if necessary.

Pure virtual base class for the Track and Jam specific messages.

Inheritance diagram for DtSetEmitterTrackJamTargets:
Inheritance graph
[legend]

Public Member Functions

 DtSetEmitterTrackJamTargets ()
 
 DtSetEmitterTrackJamTargets (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
 DtSetEmitterTrackJamTargets (const DtString &name, const DtSetEmitterTrackJamTargets &orig, DtReaderWriterRegistry *parentRegistry=0)
 
const DtSetEmitterTrackJamTargets & operator= (const DtSetEmitterTrackJamTargets &orig)
 
virtual ~DtSetEmitterTrackJamTargets ()
 
virtual const DtSetMessageType & type () const =0
 
virtual bool isJammingRequest () const =0
 
virtual bool isTrackingRequest () const =0
 
virtual DtSetDataRequest * clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const =0
 
virtual DtString stringRep () const
 
virtual void setEmitterId (DtU8 id)
 
virtual DtU8 emitterId () const
 
virtual bool useHighDensityMode () const
 
virtual void setUseHighDensityMode (bool usehighD)
 
virtual const
DtRwNLengthUUIDVector & 		targets () const
 
virtual DtRwNLengthUUIDVector & targets ()
 
virtual int netRepSize () const
 
virtual bool setFromNet (const char *buff, unsigned contentSize)
 
virtual bool setToNet ()
 
- Public Member Functions inherited from DtSetDataRequest
virtual ~DtSetDataRequest ()
 
virtual bool init ()
 
virtual void putData (std::string &fp, int indentLevel=0)
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
virtual char * netRep ()
 
- 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 myEmitterId
 
DtRwBoolean myUseHighDensityMode
 
DtRwNLengthUUIDVector myTargets
 
- Protected Attributes inherited from DtSetDataRequest
char * myNetRep
 
- 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 DtSetDataRequest
static DtSetDataRequest * createSetDataRequest (DtlObjPtr mtlStream)
 
static DtSetDataRequest * createSetDataRequest (DtSetMessageType requestType)
 
static void addSetDataRequestCreatorFcn (const DtSetMessageType &setDataName, DtSetDataRequestCreatorFcn fcn)
 
static void setFactory (DtSetDataRequestFactory *factory)
 
static DtSetDataRequestFactory * factory ()
 
static bool isTypeRegistered (DtSetMessageType setDataType)
 
- 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 DtSetDataRequest
 DtSetDataRequest ()
 
 DtSetDataRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
 
 DtSetDataRequest (const DtString &writeName, const DtSetDataRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
 
const DtSetDataRequest & operator= (const DtSetDataRequest &orig)
 
virtual char * createNetworkBuffer ()
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 
- Static Protected Attributes inherited from DtSetDataRequest
static DtSetDataRequestFactory * 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
 

Constructor & Destructor Documentation

DtSetEmitterTrackJamTargets::DtSetEmitterTrackJamTargets ( )

Default constructor.

DtSetEmitterTrackJamTargets::DtSetEmitterTrackJamTargets ( const DtString &  name,
DtReaderWriterRegistry *  parentRegistry = 0 
)

True constructor.

DtSetEmitterTrackJamTargets::DtSetEmitterTrackJamTargets ( const DtString &  name,
const DtSetEmitterTrackJamTargets &  orig,
DtReaderWriterRegistry *  parentRegistry = 0 
)

Copy Constructor.

virtual DtSetEmitterTrackJamTargets::~DtSetEmitterTrackJamTargets ( )
virtual

Destructor.

Member Function Documentation

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

Assignment operator.

virtual const DtSetMessageType& DtSetEmitterTrackJamTargets::type ( ) const
pure virtual

Type, creator, clone, and jam/track are the only differences between the child classes...

Implements DtSetDataRequest.

Implemented in DtSetEmitterJamTargets, and DtSetEmitterTrackTargets.

virtual bool DtSetEmitterTrackJamTargets::isJammingRequest ( ) const
pure virtual

Implemented in DtSetEmitterJamTargets, and DtSetEmitterTrackTargets.

virtual bool DtSetEmitterTrackJamTargets::isTrackingRequest ( ) const
pure virtual

Implemented in DtSetEmitterJamTargets, and DtSetEmitterTrackTargets.

virtual DtSetDataRequest* DtSetEmitterTrackJamTargets::clone ( const DtString &  name,
DtReaderWriterRegistry *  parentRegistry = 0 
) const
pure virtual

Make a copy of this request. Returns a pointer to a newly created copy of this data request. Derived classes must override this function to create and return an instance of the derived type.

Implements DtSetDataRequest.

Implemented in DtSetEmitterJamTargets, and DtSetEmitterTrackTargets.

virtual DtString DtSetEmitterTrackJamTargets::stringRep ( ) const
virtual

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual void DtSetEmitterTrackJamTargets::setEmitterId ( DtU8  id)
virtual
virtual DtU8 DtSetEmitterTrackJamTargets::emitterId ( ) const
virtual
virtual bool DtSetEmitterTrackJamTargets::useHighDensityMode ( ) const
virtual
virtual void DtSetEmitterTrackJamTargets::setUseHighDensityMode ( bool  usehighD)
virtual
virtual const DtRwNLengthUUIDVector& DtSetEmitterTrackJamTargets::targets ( ) const
virtual

Should not be modified, only consumed by client code.

virtual DtRwNLengthUUIDVector& DtSetEmitterTrackJamTargets::targets ( )
virtual
virtual int DtSetEmitterTrackJamTargets::netRepSize ( ) const
virtual

Framework serialization methods.

Reimplemented from DtSetDataRequest.

virtual bool DtSetEmitterTrackJamTargets::setFromNet ( const char *  buff,
unsigned  contentSize 
)
virtual

Framework serialization methods.

Reimplemented from DtSetDataRequest.

virtual bool DtSetEmitterTrackJamTargets::setToNet ( )
virtual

Framework serialization methods.

Reimplemented from DtSetDataRequest.

Member Data Documentation

DtRwInt DtSetEmitterTrackJamTargets::myEmitterId
protected
DtRwBoolean DtSetEmitterTrackJamTargets::myUseHighDensityMode
protected
DtRwNLengthUUIDVector DtSetEmitterTrackJamTargets::myTargets
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Thu Jun 1 17:58:13 EDT 2023 from SVN revision 255404
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)