![]() |
VR-Forces 4.2 Class Documentation
|
DtSetDataRequest is an abstract base class from which real setDataRequests can derive. More...
Inherits DtReaderWriter.
Inherited by BHAVE::DtSetBhaveMovementMode, BHAVE::DtSetViewTarget, DtClearTask, DtDiGuySetAppearanceRequest, DtFireNowRequest, DtSetActiveSonarMode, DtSetAggregateState, DtSetAltitudeRequest, DtSetAppearanceRequest, DtSetArmedRequest, DtSetAutoLaunchEnabledRequest, DtSetCapabilityRequest, DtSetChannelRequest, DtSetCollisionAvoidTypes, DtSetConcealedRequest, DtSetConvoyFollowTarget, DtSetDesignatorRequest, DtSetDestroyRequest, DtSetDetonate, DtSetEmitterRequest, DtSetEngagementRulesRequest, DtSetForceRequest, DtSetFormationRequest, DtSetFormationTypeRequest, DtSetHeadingRequest, DtSetIffRequest, DtSetJoyDeviceSwitchRequest, DtSetLaseAutonomousRequest, DtSetLaserCodeRequest, DtSetLifeFormPostureRequest, DtSetLifeFormWeaponStateRequest, DtSetLoadEntityRequest, DtSetLocationRequest, DtSetMovementStrategyRequest, DtSetNotifyLevel, DtSetRadarMode, DtSetReactiveTaskCancel, DtSetReactiveTaskDisabled, DtSetReactiveTaskEnabled, DtSetReactiveTaskPriority, DtSetReactiveTaskTable, DtSetReorganizeRequest, DtSetResourceRequest, DtSetRestoreRequest, DtSetScanSectorRequest, DtSetSonarDepthRequest, DtSetSpeedRequest, DtSetSpotReportingRequest, DtSetStayInLaneRequest, DtSetSurrenderRequest, DtSetSwitchSystem, DtSetSyncLaserCode, DtSetTargetRequest, DtSetTaskedBySuperiorRequest, DtSetUnloadEntityRequest, DtSetWarheadInfo, DtSnapIntoFormationRequest, and vrfAddSetExample::DtSetSpeedAndHeadingRequest.
Public Member Functions | |
| virtual | ~DtSetDataRequest () |
| destructor | |
| virtual bool | init () |
| Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation. | |
| virtual const DtSetMessageType & | type () const =0 |
| What kind of setDataRequest am I? (from radioMsgTypes.h). | |
| virtual DtSetDataRequest * | clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const =0 |
| Make a copy of this request. | |
| virtual DtString | stringRep () const =0 |
| Get a readable string representation of this setDataRequest. | |
| virtual void | putData (FILE *fp, int indentLevel=0) |
| putData writes our type, which is provided by the virtual type accessor of the deriving class. | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings) |
| getData is just used to get us past the type in the data stream, since it's not actual stored. | |
| virtual char * | netRep () |
Serialization Methods | |
These three methods must be overridden for any setRequest subclass that is going to be sent over the network and need to package their own data elements. | |
| virtual int | netRepSize () const |
| virtual bool | setFromNet (const char *contentBuffer, unsigned contentSize) |
| Sets the contents of this set request based on the network buffer. | |
| virtual bool | setToNet () |
| Sets netRep buffer to the contents of this set request. | |
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 | |
| 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 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 const char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. | |
| 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 DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. | |
| DtReaderWriterRegistry & | registry () |
| Collection of child DtReaderWriter nodes owned by this object. | |
Protected Member Functions | |
| DtSetDataRequest () | |
| Constructors are protected because no one should instantiate the base class, just derived versions. | |
| DtSetDataRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor If you have a request 'put' itself, the write name will preface it. | |
| DtSetDataRequest (const DtString &writeName, const DtSetDataRequest &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| const DtSetDataRequest & | operator= (const DtSetDataRequest &orig) |
| assignment operator; same as copy costructor. | |
| virtual char * | createNetworkBuffer () |
| int setDataType); | |
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 DtlObjPtr | getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings) |
| Deriving class overrides these to get/put class specific data. | |
Protected Attributes | |
| char * | myNetRep |
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. | |
Static Protected Attributes | |
| 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 |
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 )() |
DtSetDataRequest is an abstract base class from which real setDataRequests can derive.
It manages the read/write capability; derived classes need only use and register read/writatble data types for derived information.
The DtSetDataRequest class is derived from DtReaderWriter, from which it inherits the ability to read and write itself to a file. This capability is essential to being able to save and restore Set Data Request statements in a plan.
|
protected |
Constructors are protected because no one should instantiate the base class, just derived versions.
default constructor
|
protected |
constructor If you have a request 'put' itself, the write name will preface it.
|
protected |
copy constructor
|
virtual |
destructor
|
protected |
assignment operator; same as copy costructor.
|
virtual |
Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation.
Reimplemented in DtSetNotifyLevel.
|
pure virtual |
What kind of setDataRequest am I? (from radioMsgTypes.h).
Returns a string representing the kind of data request. Derived classes must implement this function to return a unique type. See radioMsgTypes.h for a list of the Set Data Request types used in VR-Forces.
Implemented in DtSetOrderedAltitudeRequest, DtSetWarheadInfo, DtSetScanSectorRequest, DtSetEngagementRulesRequest, DtSetResourceRequest, DtSetAltitudeRequest, DtSetLocationRequest, DtSetFormationTypeRequest, DtSetIffRequest, DtSetHeadingRequest, DtSetLoadEntityRequest, DtSetAppearanceRequest, DtSetEmitterRequest, DtSetCapabilityRequest, DtSetFormationRequest, DtSetSpeedRequest, DtFireNowRequest, DtSetForceRequest, DtSetLifeFormPostureRequest, DtSetLifeFormWeaponStateRequest, DtSetLaseAutonomousRequest, DtSetTaskedBySuperiorRequest, DtSnapIntoFormationRequest, DtSetConcealedRequest, DtSetDesignatorRequest, DtSetUnloadEntityRequest, DtSetDestroyRequest, DtSetLaserCodeRequest, DtSetRestoreRequest, DtSetSurrenderRequest, DtClearTask, DtSetChannelRequest, DtSetStayInLaneRequest, DtSetCollisionAvoidTypes, DtSetJoyDeviceSwitchRequest, DtSetTargetRequest, vrfAddSetExample::DtSetSpeedAndHeadingRequest, DtSetDetonate, DtSetSonarDepthRequest, DtSetSpotReportingRequest, DtSetAutoLaunchEnabledRequest, DtSetReorganizeRequest, DtSetNotifyLevel, DtSetAggregateState, DtSetArmedRequest, DtSetConvoyFollowTarget, DtSetSwitchSystem, DtSetActiveSonarMode, DtSetRadarMode, BHAVE::DtSetBhaveMovementMode, DtSetMovementStrategyRequest, DtSetSyncLaserCode, BHAVE::DtSetViewTarget, DtSetReactiveTaskCancel, DtSetReactiveTaskDisabled, DtSetReactiveTaskPriority, DtSetReactiveTaskTable, DtSetReactiveTaskEnabled, and DtDiGuySetAppearanceRequest.
|
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.
Implemented in DtSetIffRequest, DtSetOrderedAltitudeRequest, DtSetWarheadInfo, DtSetScanSectorRequest, DtSetEmitterRequest, DtSetEngagementRulesRequest, DtSetResourceRequest, DtSetAltitudeRequest, DtSetLocationRequest, DtSetCollisionAvoidTypes, DtSetFormationTypeRequest, DtSetLoadEntityRequest, DtSetHeadingRequest, DtSetAppearanceRequest, DtSetCapabilityRequest, DtSetFormationRequest, DtSetSpeedRequest, DtFireNowRequest, DtSetForceRequest, DtSetLifeFormPostureRequest, DtSetLifeFormWeaponStateRequest, DtSetLaseAutonomousRequest, DtSetUnloadEntityRequest, DtSnapIntoFormationRequest, DtSetConcealedRequest, DtSetDesignatorRequest, DtSetTaskedBySuperiorRequest, DtSetDestroyRequest, DtSetLaserCodeRequest, DtSetNotifyLevel, DtSetRestoreRequest, DtSetSurrenderRequest, DtClearTask, DtSetChannelRequest, DtSetStayInLaneRequest, DtSetJoyDeviceSwitchRequest, DtSetTargetRequest, vrfAddSetExample::DtSetSpeedAndHeadingRequest, DtSetDetonate, DtSetSonarDepthRequest, DtSetSpotReportingRequest, DtSetAutoLaunchEnabledRequest, DtSetReorganizeRequest, DtSetAggregateState, DtSetArmedRequest, DtSetConvoyFollowTarget, DtSetSwitchSystem, DtSetActiveSonarMode, DtSetRadarMode, BHAVE::DtSetBhaveMovementMode, DtSetMovementStrategyRequest, DtSetSyncLaserCode, BHAVE::DtSetViewTarget, DtSetReactiveTaskCancel, DtSetReactiveTaskDisabled, DtSetReactiveTaskPriority, DtSetReactiveTaskTable, DtSetReactiveTaskEnabled, and DtDiGuySetAppearanceRequest.
Referenced by BHAVE::BHAVE3DGui::DtCreateItemData::DtCreateItemData(), and BHAVE::BHAVE3DGui::DtCreateItemData::operator=().
|
pure virtual |
Get a readable string representation of this setDataRequest.
Returns a human readable string representation of the Set Data Request. Derived classes must implement this function. The string should include the identity of the Set Data Request, along with any parameters. The format of the string is up to you. The plan viewer and editor use the string representation to display the type of task and its parameters.
Implemented in DtSetIffRequest, DtSetWarheadInfo, DtSetScanSectorRequest, DtSetEmitterRequest, DtSetEngagementRulesRequest, DtSetResourceRequest, DtSetAltitudeRequest, DtSetLocationRequest, DtSetCollisionAvoidTypes, DtSetFormationTypeRequest, DtSetLoadEntityRequest, DtSetHeadingRequest, DtSetAppearanceRequest, DtSetCapabilityRequest, DtSetFormationRequest, DtSetSpeedRequest, DtFireNowRequest, DtSetForceRequest, DtSetLifeFormPostureRequest, DtSetLifeFormWeaponStateRequest, DtSetUnloadEntityRequest, DtSetLaseAutonomousRequest, DtSnapIntoFormationRequest, DtSetConcealedRequest, DtSetDesignatorRequest, DtSetTaskedBySuperiorRequest, DtSetDestroyRequest, DtSetLaserCodeRequest, DtSetNotifyLevel, DtSetRestoreRequest, DtSetSurrenderRequest, DtClearTask, DtSetChannelRequest, DtSetStayInLaneRequest, DtSetJoyDeviceSwitchRequest, DtSetTargetRequest, vrfAddSetExample::DtSetSpeedAndHeadingRequest, DtSetDetonate, DtSetSonarDepthRequest, DtSetSpotReportingRequest, DtSetAutoLaunchEnabledRequest, DtSetReorganizeRequest, DtSetAggregateState, DtSetArmedRequest, DtSetConvoyFollowTarget, DtSetSwitchSystem, DtSetActiveSonarMode, DtSetRadarMode, BHAVE::DtSetBhaveMovementMode, DtSetMovementStrategyRequest, DtSetSyncLaserCode, BHAVE::DtSetViewTarget, DtSetReactiveTaskCancel, DtSetReactiveTaskDisabled, DtSetReactiveTaskPriority, DtSetReactiveTaskTable, DtSetReactiveTaskEnabled, and DtDiGuySetAppearanceRequest.
|
virtual |
putData writes our type, which is provided by the virtual type accessor of the deriving class.
Reimplemented from DtReaderWriter.
|
virtual |
getData is just used to get us past the type in the data stream, since it's not actual stored.
|
virtual |
|
virtual |
Reimplemented in DtSetIffRequest, DtSetWarheadInfo, DtSetScanSectorRequest, DtSnapIntoFormationRequest, DtSetEngagementRulesRequest, DtSetLoadEntityRequest, DtSetResourceRequest, DtSetLocationRequest, DtSetFormationTypeRequest, DtSetAltitudeRequest, DtSetFormationRequest, DtSetEmitterRequest, DtSetHeadingRequest, DtSetLifeFormPostureRequest, DtSetLifeFormWeaponStateRequest, DtSetSpotReportingRequest, DtSetAppearanceRequest, DtSetDetonate, DtSetSpeedRequest, DtFireNowRequest, DtSetCapabilityRequest, DtSetCollisionAvoidTypes, DtSetSwitchSystem, DtSetForceRequest, DtSetLaseAutonomousRequest, DtSetConvoyFollowTarget, DtSetDesignatorRequest, DtSetConcealedRequest, DtSetLaserCodeRequest, DtSetUnloadEntityRequest, vrfAddSetExample::DtSetSpeedAndHeadingRequest, DtClearTask, DtSetStayInLaneRequest, DtSetSurrenderRequest, DtSetSonarDepthRequest, DtSetTargetRequest, DtSetTaskedBySuperiorRequest, DtSetChannelRequest, DtSetDestroyRequest, DtSetRestoreRequest, DtSetJoyDeviceSwitchRequest, DtSetNotifyLevel, DtSetActiveSonarMode, DtSetAutoLaunchEnabledRequest, DtSetRadarMode, DtSetAggregateState, DtSetReactiveTaskEnabled, DtSetMovementStrategyRequest, DtSetArmedRequest, DtSetReorganizeRequest, DtSetSyncLaserCode, BHAVE::DtSetBhaveMovementMode, DtSetReactiveTaskDisabled, DtSetReactiveTaskPriority, DtSetReactiveTaskCancel, BHAVE::DtSetViewTarget, DtSetReactiveTaskTable, and DtDiGuySetAppearanceRequest.
|
virtual |
Sets the contents of this set request based on the network buffer.
Base class does nothing and returns true.
Reimplemented in DtSetIffRequest, DtSetWarheadInfo, DtSetScanSectorRequest, DtSetLoadEntityRequest, DtSnapIntoFormationRequest, DtSetEngagementRulesRequest, DtSetResourceRequest, DtSetLocationRequest, DtSetFormationTypeRequest, DtSetAltitudeRequest, DtSetFormationRequest, DtSetEmitterRequest, DtSetHeadingRequest, DtSetLifeFormPostureRequest, DtSetLifeFormWeaponStateRequest, DtSetSpotReportingRequest, DtSetAppearanceRequest, DtSetDetonate, DtSetSpeedRequest, DtFireNowRequest, DtSetCapabilityRequest, DtSetCollisionAvoidTypes, DtSetSwitchSystem, DtSetForceRequest, DtSetLaseAutonomousRequest, DtSetConvoyFollowTarget, DtSetDesignatorRequest, DtSetUnloadEntityRequest, DtSetConcealedRequest, DtSetLaserCodeRequest, vrfAddSetExample::DtSetSpeedAndHeadingRequest, DtClearTask, DtSetStayInLaneRequest, DtSetSurrenderRequest, DtSetSonarDepthRequest, DtSetTargetRequest, DtSetTaskedBySuperiorRequest, DtSetChannelRequest, DtSetDestroyRequest, DtSetRestoreRequest, DtSetJoyDeviceSwitchRequest, DtSetNotifyLevel, DtSetActiveSonarMode, DtSetAutoLaunchEnabledRequest, DtSetRadarMode, DtSetAggregateState, DtSetReactiveTaskEnabled, DtSetMovementStrategyRequest, DtSetArmedRequest, DtSetReorganizeRequest, DtSetSyncLaserCode, BHAVE::DtSetBhaveMovementMode, DtSetReactiveTaskDisabled, DtSetReactiveTaskPriority, DtSetReactiveTaskCancel, BHAVE::DtSetViewTarget, DtSetReactiveTaskTable, and DtDiGuySetAppearanceRequest.
|
virtual |
Sets netRep buffer to the contents of this set request.
Base class does nothing and returns true.
Reimplemented in DtSetIffRequest, DtSetWarheadInfo, DtSetScanSectorRequest, DtSetLoadEntityRequest, DtSnapIntoFormationRequest, DtSetEngagementRulesRequest, DtSetResourceRequest, DtSetLocationRequest, DtSetFormationTypeRequest, DtSetAltitudeRequest, DtSetFormationRequest, DtSetEmitterRequest, DtSetHeadingRequest, DtSetLifeFormPostureRequest, DtSetLifeFormWeaponStateRequest, DtSetSpotReportingRequest, DtSetAppearanceRequest, DtSetDetonate, DtSetSpeedRequest, DtFireNowRequest, DtSetCapabilityRequest, DtSetCollisionAvoidTypes, DtSetSwitchSystem, DtSetForceRequest, DtSetLaseAutonomousRequest, DtSetConvoyFollowTarget, DtSetDesignatorRequest, DtSetUnloadEntityRequest, DtSetConcealedRequest, DtSetLaserCodeRequest, vrfAddSetExample::DtSetSpeedAndHeadingRequest, DtClearTask, DtSetStayInLaneRequest, DtSetSurrenderRequest, DtSetSonarDepthRequest, DtSetTargetRequest, DtSetTaskedBySuperiorRequest, DtSetChannelRequest, DtSetDestroyRequest, DtSetRestoreRequest, DtSetJoyDeviceSwitchRequest, DtSetNotifyLevel, DtSetActiveSonarMode, DtSetAutoLaunchEnabledRequest, DtSetRadarMode, DtSetAggregateState, DtSetReactiveTaskEnabled, DtSetMovementStrategyRequest, DtSetArmedRequest, DtSetReorganizeRequest, DtSetSyncLaserCode, BHAVE::DtSetBhaveMovementMode, DtSetReactiveTaskDisabled, DtSetReactiveTaskPriority, DtSetReactiveTaskCancel, BHAVE::DtSetViewTarget, DtSetReactiveTaskTable, and DtDiGuySetAppearanceRequest.
|
static |
Static functions.
|
static |
|
static |
|
static |
|
static |
Reimplemented from DtReaderWriter.
|
static |
|
protectedvirtual |
int setDataType);
|
protected |
|
staticprotected |