VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Classes | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
makVrf::DtAggregateCopyObject Class Reference
Inheritance diagram for makVrf::DtAggregateCopyObject:
Inheritance graph
[legend]

Classes

struct  SubordinateState
 

Public Member Functions

 DtAggregateCopyObject (makVrv::DtDe &)
 
virtual ~DtAggregateCopyObject ()
 
virtual bool copyOperationsPending () const
 Return true if copy operations are complete, else false will signal that there are other operations yet to be done. More...
 
- Public Member Functions inherited from makVrf::DtEntityCopyObject
 DtEntityCopyObject (makVrv::DtDe &)
 
virtual ~DtEntityCopyObject ()
 
virtual DtGeodeticCoord calculateCenter () const
 Returns the center of the object in geocentric coordinates. More...
 
virtual void createFacade (const DtGeodeticCoord &origin)
 Creates the facade that will be used to display a temp item during paste operation. More...
 
virtual void setOrigin (const DtGeodeticCoord &)
 Should shift (rather than absolute location set) points by amount specified. More...
 
virtual DtVector pasteOrigin () const
 Origin at which to paste the object. Will take into account offsets (if they exist) More...
 
virtual DtVector origin () const
 If facade is available, returns the origin of the facade, else returns center(). Returns in local coordinates. More...
 
virtual double groundHeight (const DtVector &currentLocal) const
 Returns the height at the given local position. More...
 
- Public Member Functions inherited from makVrf::DtCopyObject
 DtCopyObject (makVrv::DtDe &)
 
virtual ~DtCopyObject ()
 
virtual void read (const std::string &buf)
 Reads data from the buffer. More...
 
const std::string & name () const
 
const DtUUIDuuid () const
 
virtual void setAltitudeClampType (DtAltitudeClampType)
 Sets the clamp type to used when calculating localLocation. Default is above terrain. More...
 
DtAltitudeClampType altitudeClampType () const
 
void setType (int t)
 
int type () const
 
void setBuffer (const std::string &b)
 
const std::string & buffer () const
 
virtual bool preserveOffsets () const
 Returns true if offsets from origin should be preserved on paste. Default is false. More...
 
virtual DtGeodeticCoord center () const
 Returns the center of the object in geocentric coordinates. More...
 
virtual DtVector localCenter () const
 
virtual void setGeometricCenter (const DtGeodeticCoord &)
 Sets the center of all objects being painted (in geocentric as per center() call). More...
 
const DtGeodeticCoord & geometricCenter () const
 
const
makVrv::DtVrlinkSimulatedBaseState
readableStateData () const
 
virtual bool updateDataBeforeCopy () const
 Returns true as to whether or not to force a data update before copy. Default is false. More...
 
virtual void setUpdateDataBeforeCopy (bool)
 

Protected Types

typedef std::set< DtUUIDAwaitingMap
 
- Protected Types inherited from makVrf::DtCopyObject
typedef std::vector< doubleHeightOffsets
 

Protected Member Functions

virtual void write (std::ostringstream &str, const makVrv::DtVrlinkSimulatedEntityState *data, makVrv::DtUniqueID id)
 Copies aggregate specific information and starts hierarchy copy. More...
 
virtual void read (std::istringstream &str, makVrv::DtVrlinkSimulatedEntityState *data)
 Reads in data specific to this aggregate and all subordinates. More...
 
virtual void copied (DtCopyObject *, const std::string &)
 Called when subordinate object has successfully copied. Re-emits signal. More...
 
virtual void copyOperationPending (DtCopyObject *, const std::string &)
 Reemits copy operation pending signal. More...
 
virtual void createObject (const DtVector &)
 Creates this object and all sub objects. More...
 
virtual void pasteCompleted ()
 Called when all child objects have been created. Completes aggregate process. More...
 
virtual bool pasteComplete () const
 Returns true if paste operation is complete. Default is true. More...
 
virtual std::string pastePendingMessage () const
 Message that is describing what this object is waiting for as far as pasting goes. More...
 
virtual void readComplete (std::istringstream &str)
 Called when reading of buffer for object is complete. More...
 
virtual void pasted (DtCopyObject *)
 Called when paste operation has completed for the supplied object. Re-emits pasted signal. More...
 
virtual void pasteOperationPending (DtCopyObject *, const std::string &)
 Called when a paste operation is pending, emits signal_pasteOperationPending. More...
 
virtual void pasteCancelled (DtCopyObject *)
 Called when a paste operation is cancelled. More...
 
virtual void addStateData (std::map< std::string, std::string > &, const DtRwVariableBindings &, const DtString &var)
 Adds state data that will be used to set when the aggregate is pased. More...
 
virtual void paste (const DtVector &geocLocation, int flags)
 Pastes object given the current information. More...
 
virtual void copyChildren (const makVrv::DtElementIDHierarchy::ElementIDs &)
 Schedules to copy all children found. Will use copy/paste manager to create copy objects. More...
 
virtual void cancel ()
 Cancels pending operations. If awaiting plan, unregisters callback. More...
 
virtual std::string copyPendingMessage () const
 Message that is describing what this object is waiting for as far as copying goes. More...
 
virtual void forceUpdate (DtVrlinkSimulatedBaseStateView *stateView, makVrv::DtSimEntry *simEntry)
 
virtual bool cancelComplete () const
 Returns true if cancel is complete. More...
 
virtual void copy (makVrv::DtSimEntry *simEntry)
 Starts copy process. Subclasses need to implement specific copy procedures. More...
 
virtual void slot_onStateViewUpdated (DtVrlinkAggregateStateView *state, makVrv::DtSimEntry *simEntry)
 
virtual void copyComplete ()
 Copies all paste data into the output buffer before calling parent method. More...
 
virtual
makVrv::DtVrlinkSimulatedBaseState
createReadableStateData () const
 Creates state data that will be used to read into a readable buffer. More...
 
virtual DtEntityCreationData entityCreationData (const DtVector &)
 Return entity creation data for this entity. More...
 
virtual void processPasteStep ()
 If all other steps are complete, do aggregatation and setting of formation. More...
 
- Protected Member Functions inherited from makVrf::DtEntityCopyObject
virtual bool canAdjustAltitude (const DtEntityType &) const
 Returns whether or not this item can have it's altitude adjusted. More...
 
virtual void write (std::ostringstream &str, const makVrv::DtVrlinkSimulatedBaseState *data, makVrv::DtUniqueID id)
 Writes data to stream. More...
 
virtual void write (std::ostringstream &str, const DtVrfObjectDataState *data)
 Writes vrf object data state. More...
 
virtual void read (std::istringstream &str, makVrv::DtVrlinkSimulatedBaseState *data)
 Reads data from stream. More...
 
virtual void read (std::istringstream &str, DtVrfObjectDataState *data)
 Reads vrf object data state. More...
 
virtual void requestPlan ()
 Requests plan from back-end. More...
 
virtual void processReceivedPlan (DtSimMessage *)
 Call back in response to receiving plan. More...
 
virtual
DtVrfObjectFacadeInterface
facade () const
 Returns the facade. More...
 
virtual void uuidChanged (const DtUUID &)
 Called when the UUID has changed for an object. If the new UUID is this object then it is also discovered. More...
 
virtual void processObjectCreated (DtString, const DtUUID &, const DtEntityIdentifier &)
 Called in response to object being created. More...
 
virtual void sendRulesOfEngagement ()
 Called to send rules of engagement. More...
 
virtual void sendPlan ()
 Sends plan for entity to back-end. More...
 
virtual void processObjectDiscovered ()
 Called when the object that has just been created is fully discovered by the state view collection manager. More...
 
- Protected Member Functions inherited from makVrf::DtCopyObject
virtual DtVrfObjectDataStatecreateReadableObjectStateData () const
 Creates state data that will be used to read into a readable buffer. More...
 
virtual void checkCopyComplete ()
 Checks whether or not the copy is complete, and, if it is, calls copyComplet() More...
 
virtual void checkPasteComplete ()
 Checks to see if paste operation is complete. More...
 
virtual int generateRequestId ()
 Generates a request id to match our request. More...
 
virtual void setupOffsets (const DtGeodeticCoord &)
 Sets up offsets from geometric center. More...
 
virtual void slot_onStateViewUpdated (DtVrlinkSimulatedBaseStateView *state, makVrv::DtSimEntry *simEntry)
 
virtual DtVector offsetLocation (int, const DtVector &loc) const
 Returns the geocentric location of the point at offset location index offset by geocentric loc. More...
 
virtual DtGeodeticCoord calculateOffsetPoint (const DtGeodeticCoord &start, const DtGeodeticCoord &end, double &altAboveTerrain, double &altAboveSeaLevel) const
 Calculates an offset point based on the start and end positions. More...
 
virtual DtVector localLocation (const DtGeodeticCoord &, int) const
 Given an origin and an index, return local location as an offset from that origin. More...
 

Protected Attributes

DtVrfAggregateCopyPasteHandler myCopyPasteHandler
 
makVrv::DtSignalConnectionManager myCopyConnections
 
makVrv::DtSignalConnectionManager myPasteConnections
 
int myWaitingForChildren
 
bool myPasteComplete
 
bool myAwaitingSubordinateCreation
 
DtVector myAggregatePasteLocation
 
std::vector< SubordinateStatemyPastedSubordinates
 
AwaitingMap myAwaitingOrganization
 
makVrv::DtStateView
< makVrv::DtVrlinkSimulatedBaseState > * 
myAggregateStateView
 
- Protected Attributes inherited from makVrf::DtEntityCopyObject
bool myAwaitingPlan
 
DtIfPlanmyPlan
 
int myAwaiting
 
int myRequestId
 
DtEntityFacadeCollectionmyFacade
 
bool myClampToGround
 
DtVector myPosition
 
unsigned int myCreateCallbackId
 
makVrv::DtSignalConnectionManager myAddedSignalManager
 
- Protected Attributes inherited from makVrf::DtCopyObject
makVrv::DtDemyDe
 
std::ostringstream myOutput
 
std::string myName
 
int myPasteFlags
 
DtVrfObjectDataStatemyReadableObjectStateData
 
makVrv::DtVrlinkSimulatedBaseStatemyReadableStateData
 
DtGeodeticCoord myCenter
 
CopyOffsets myOffsets
 
HeightOffsets myAltitudeAboveTerrain
 
HeightOffsets myAltitudeAboveSeaLevel
 
DtAltitudeClampType myAltitudeClampType
 
DtReferenceEllipsoid myReferenceEllipsoid
 
int myType
 
std::string myBuffer
 
DtGeodeticCoord myGeometricCenter
 
bool myIsLocal
 
bool myUpdateDataBeforeCopy
 
DtUUID myUUID
 
bool myUpdated
 
makVrv::DtSignalConnectionManager myStateViewConnections
 

Additional Inherited Members

- Public Types inherited from makVrf::DtCopyObject
enum  DtPasteFlags {
  DtPasteNewName = 0x00000001, DtPasteAppearance = 0x00000002, DtPasteHeading = 0x00000004, DtPasteEngagement = 0x00000008,
  DtPastePlan = 0x00000010, DtPasteAboveSeaLevel = 0x00000020, DtPasteAboveTerrain = 0x00000040, DtPasteFormation = 0x00000080,
  DtPasteStateProperties = 0x00000100, DtAllPasteFlags
}
 
- Public Attributes inherited from makVrf::DtCopyObject
boost::signals2::signal< void(DtCopyObject *)> signal_copyCancelled
 
boost::signals2::signal< void(DtCopyObject
*, const std::string &)> 
signal_copied
 
boost::signals2::signal< void(DtCopyObject
*, const std::string &)> 
signal_copyOperationPending
 
boost::signals2::signal< void(DtCopyObject *)> signal_pasted
 
boost::signals2::signal< void(DtCopyObject
*, const std::string &)> 
signal_pasteOperationPending
 
boost::signals2::signal< void(DtCopyObject *)> signal_pasteCancelled
 

Member Typedef Documentation

Constructor & Destructor Documentation

makVrf::DtAggregateCopyObject::DtAggregateCopyObject ( makVrv::DtDe )
virtual makVrf::DtAggregateCopyObject::~DtAggregateCopyObject ( )
virtual

Member Function Documentation

virtual void makVrf::DtAggregateCopyObject::write ( std::ostringstream &  str,
const makVrv::DtVrlinkSimulatedEntityState data,
makVrv::DtUniqueID  id 
)
protectedvirtual

Copies aggregate specific information and starts hierarchy copy.

Reimplemented from makVrf::DtEntityCopyObject.

virtual void makVrf::DtAggregateCopyObject::read ( std::istringstream &  str,
makVrv::DtVrlinkSimulatedEntityState data 
)
protectedvirtual

Reads in data specific to this aggregate and all subordinates.

Reimplemented from makVrf::DtEntityCopyObject.

virtual void makVrf::DtAggregateCopyObject::copied ( DtCopyObject ,
const std::string &   
)
protectedvirtual

Called when subordinate object has successfully copied. Re-emits signal.

virtual void makVrf::DtAggregateCopyObject::copyOperationPending ( DtCopyObject ,
const std::string &   
)
protectedvirtual

Reemits copy operation pending signal.

virtual void makVrf::DtAggregateCopyObject::createObject ( const DtVector )
protectedvirtual

Creates this object and all sub objects.

Will wait until sub objects are created before creating this object and then aggregating sub objects. The vector supplied is in geocentric

Reimplemented from makVrf::DtEntityCopyObject.

virtual void makVrf::DtAggregateCopyObject::pasteCompleted ( )
protectedvirtual

Called when all child objects have been created. Completes aggregate process.

virtual bool makVrf::DtAggregateCopyObject::pasteComplete ( ) const
protectedvirtual

Returns true if paste operation is complete. Default is true.

Reimplemented from makVrf::DtEntityCopyObject.

virtual std::string makVrf::DtAggregateCopyObject::pastePendingMessage ( ) const
protectedvirtual

Message that is describing what this object is waiting for as far as pasting goes.

Reimplemented from makVrf::DtEntityCopyObject.

virtual void makVrf::DtAggregateCopyObject::readComplete ( std::istringstream &  str)
protectedvirtual

Called when reading of buffer for object is complete.

Reimplemented from makVrf::DtCopyObject.

virtual void makVrf::DtAggregateCopyObject::pasted ( DtCopyObject )
protectedvirtual

Called when paste operation has completed for the supplied object. Re-emits pasted signal.

virtual void makVrf::DtAggregateCopyObject::pasteOperationPending ( DtCopyObject ,
const std::string &   
)
protectedvirtual

Called when a paste operation is pending, emits signal_pasteOperationPending.

virtual void makVrf::DtAggregateCopyObject::pasteCancelled ( DtCopyObject )
protectedvirtual

Called when a paste operation is cancelled.

Will remove from objectsBeingPasted list, and, if list is empty, signals pasteComplete message

virtual void makVrf::DtAggregateCopyObject::addStateData ( std::map< std::string, std::string > &  ,
const DtRwVariableBindings ,
const DtString var 
)
protectedvirtual

Adds state data that will be used to set when the aggregate is pased.

virtual void makVrf::DtAggregateCopyObject::paste ( const DtVector ,
int  flags 
)
protectedvirtual

Pastes object given the current information.

If paste is not complete, will send out pasteOperationPending signal. The geocentric coordinate given the the center around which this item should be placed. This object will figure out the correct placement based on that center (in geocentric coordinates)

Reimplemented from makVrf::DtCopyObject.

virtual bool makVrf::DtAggregateCopyObject::copyOperationsPending ( ) const
virtual

Return true if copy operations are complete, else false will signal that there are other operations yet to be done.

Will return true if waiting for plan or subordinates

Reimplemented from makVrf::DtEntityCopyObject.

virtual void makVrf::DtAggregateCopyObject::copyChildren ( const makVrv::DtElementIDHierarchy::ElementIDs )
protectedvirtual

Schedules to copy all children found. Will use copy/paste manager to create copy objects.

virtual void makVrf::DtAggregateCopyObject::cancel ( )
protectedvirtual

Cancels pending operations. If awaiting plan, unregisters callback.

Reimplemented from makVrf::DtEntityCopyObject.

virtual std::string makVrf::DtAggregateCopyObject::copyPendingMessage ( ) const
protectedvirtual

Message that is describing what this object is waiting for as far as copying goes.

Reimplemented from makVrf::DtEntityCopyObject.

virtual void makVrf::DtAggregateCopyObject::forceUpdate ( DtVrlinkSimulatedBaseStateView stateView,
makVrv::DtSimEntry simEntry 
)
protectedvirtual

Reimplemented from makVrf::DtCopyObject.

virtual bool makVrf::DtAggregateCopyObject::cancelComplete ( ) const
protectedvirtual

Returns true if cancel is complete.

Reimplemented from makVrf::DtCopyObject.

virtual void makVrf::DtAggregateCopyObject::copy ( makVrv::DtSimEntry )
protectedvirtual

Starts copy process. Subclasses need to implement specific copy procedures.

Reimplemented from makVrf::DtCopyObject.

virtual void makVrf::DtAggregateCopyObject::slot_onStateViewUpdated ( DtVrlinkAggregateStateView state,
makVrv::DtSimEntry simEntry 
)
protectedvirtual
virtual void makVrf::DtAggregateCopyObject::copyComplete ( )
protectedvirtual

Copies all paste data into the output buffer before calling parent method.

Reimplemented from makVrf::DtCopyObject.

virtual makVrv::DtVrlinkSimulatedBaseState* makVrf::DtAggregateCopyObject::createReadableStateData ( ) const
protectedvirtual

Creates state data that will be used to read into a readable buffer.

Will persist until object is deleted

Reimplemented from makVrf::DtEntityCopyObject.

virtual DtEntityCreationData makVrf::DtAggregateCopyObject::entityCreationData ( const DtVector )
protectedvirtual

Return entity creation data for this entity.

Reimplemented from makVrf::DtEntityCopyObject.

virtual void makVrf::DtAggregateCopyObject::processPasteStep ( )
protectedvirtual

If all other steps are complete, do aggregatation and setting of formation.

Reimplemented from makVrf::DtEntityCopyObject.

Member Data Documentation

DtVrfAggregateCopyPasteHandler makVrf::DtAggregateCopyObject::myCopyPasteHandler
protected
makVrv::DtSignalConnectionManager makVrf::DtAggregateCopyObject::myCopyConnections
protected
makVrv::DtSignalConnectionManager makVrf::DtAggregateCopyObject::myPasteConnections
protected
int makVrf::DtAggregateCopyObject::myWaitingForChildren
protected
bool makVrf::DtAggregateCopyObject::myPasteComplete
protected
bool makVrf::DtAggregateCopyObject::myAwaitingSubordinateCreation
protected
DtVector makVrf::DtAggregateCopyObject::myAggregatePasteLocation
protected
std::vector<SubordinateState> makVrf::DtAggregateCopyObject::myPastedSubordinates
protected
AwaitingMap makVrf::DtAggregateCopyObject::myAwaitingOrganization
protected
makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* makVrf::DtAggregateCopyObject::myAggregateStateView
protected

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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)