VR-Forces 5.0.2 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
DtRwJammingTechnique Class Reference

Holds the 4 integer set of SISO jamming technique identification. -1 is used as a wildcard for matching against other instances.

Inheritance diagram for DtRwJammingTechnique:
Inheritance graph
[legend]

Public Member Functions

 DtRwJammingTechnique (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwJammingTechnique (const DtRwJammingTechnique &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
DtRwJammingTechnique & operator= (const DtRwJammingTechnique &orig)
 
virtual ~DtRwJammingTechnique ()
 
virtual const char * readerWriterType () const
 
virtual DtString prettyPrint () const
 
bool operator== (const DtRwJammingTechnique &) const
 
bool operator!= (const DtRwJammingTechnique &rhs) const
 
virtual void setKind (int v)
 
virtual int kind () const
 
virtual void setCategory (int v)
 
virtual int category () const
 
virtual void setSubcategory (int v)
 
virtual int subcategory () const
 
virtual void setSpecific (int v)
 
virtual int specific () const
 
virtual void setValues (int kind, int category, int subcategory, int specific)
 
virtual void setFromU32 (DtU32 value)
 
virtual bool matches (const DtRwJammingTechnique &other) 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 * xmlType () 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

DtRwInt myKind
 
DtRwInt myCategory
 
DtRwInt mySubcategory
 
DtRwInt mySpecific
 
- 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

DtRwJammingTechnique::DtRwJammingTechnique ( const DtString &  name = DtString::nullString(),
DtReaderWriterRegistry *  parentRegistry = NULL 
)

default constructor

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

copy constructor

virtual DtRwJammingTechnique::~DtRwJammingTechnique ( )
virtual

Member Function Documentation

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

assignment: assigns value only

virtual const char* DtRwJammingTechnique::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 DtString DtRwJammingTechnique::prettyPrint ( ) const
virtual

Routine to return a human readable form of this variable.

Reimplemented from DtReaderWriter.

bool DtRwJammingTechnique::operator== ( const DtRwJammingTechnique &  ) const
bool DtRwJammingTechnique::operator!= ( const DtRwJammingTechnique &  rhs) const
inline
virtual void DtRwJammingTechnique::setKind ( int  v)
virtual
virtual int DtRwJammingTechnique::kind ( ) const
virtual
virtual void DtRwJammingTechnique::setCategory ( int  v)
virtual
virtual int DtRwJammingTechnique::category ( ) const
virtual
virtual void DtRwJammingTechnique::setSubcategory ( int  v)
virtual
virtual int DtRwJammingTechnique::subcategory ( ) const
virtual
virtual void DtRwJammingTechnique::setSpecific ( int  v)
virtual
virtual int DtRwJammingTechnique::specific ( ) const
virtual
virtual void DtRwJammingTechnique::setValues ( int  kind,
int  category,
int  subcategory,
int  specific 
)
virtual
virtual void DtRwJammingTechnique::setFromU32 ( DtU32  value)
virtual

Sets the members of this class from a 32 bit value where, in which each field of the technique is defined by 8 bits: 0-7: Specific 8-15: Subcategory 16-23: Category 24-32: Kind.

Note
No wildcard values are inserted using this function.
virtual bool DtRwJammingTechnique::matches ( const DtRwJammingTechnique &  other) const
virtual
Returns
True if all values of this DtRwJammingTechnique match the other, or either instance have a -1 wildcard for the entry.

Member Data Documentation

DtRwInt DtRwJammingTechnique::myKind
protected
DtRwInt DtRwJammingTechnique::myCategory
protected
DtRwInt DtRwJammingTechnique::mySubcategory
protected
DtRwInt DtRwJammingTechnique::mySpecific
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Sun Dec 4 20:22:03 EST 2022 from SVN revision 249613
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)