vrforces5.0.2/classref/convoy_p_s_r_8h_source.html

 /*******************************************************************************

 ** Copyright (c) 2010 MAK Technologies, Inc.

 ** All rights reserved.

 *******************************************************************************/


 #pragma once

 #include "vrfobjcore/vrfobjcoreDefines.h"

 #include "vrfobjcore/vrfProcessStateRepository.h"

 #include "vrfobjcore/simObject.h"

 #include <readerWriter/rwReal.h>

 #include <readerWriter/rwString.h>

 #include "vrfobjcore/promotionIdUUIDInformation.h"

 #include "vrfutil/railSegment.h"

 #include "vrfutil/rwRailSegment.h"

 #include "readerWriter/rwVector.h"

 #include <set>

 #include "vrftasks/railMoveAlongTask.h"

 #include "vrftasks/moveToLocationTasks.h"

 #include <readerWriter/rwReal.h>

 #include <readerWriter/rwBoolean.h>

 #include "vrfobjcore/simObjectReferenceList.h"


 class DT_DLL_vrfobjcore DtConvoyPSR : public DtVrfProcessStateRepository

 {


 public:

    DtConvoyPSR(DtLocalObject* vrfObject,

       const DtString& rwName = DtString::nullString(),

       DtReaderWriterRegistry*  parentRegistry = 0);


    DtConvoyPSR(const DtConvoyPSR& orig,

       const DtString& rwName = DtString::nullString(),

       DtReaderWriterRegistry*  parentRegistry = 0);


    virtual ~DtConvoyPSR();


    DtConvoyPSR& operator=(const DtConvoyPSR& orig);


    virtual DtVrfProcessStateRepository* clone(

       const DtString& rwName = DtString::nullString(),

       DtReaderWriterRegistry*  parentRegistry = 0) const;


    virtual DtString type() const;


    static DtVrfProcessStateRepository* creator (const DtString& rwName,

       DtLocalObject* vrfObject, DtReaderWriterRegistry* parentRegistry);


    virtual void setPathPlanFlag(bool flag);

    virtual bool pathPlanFlag() const;


    virtual void setConvoyPhase(const DtString& phase);

    virtual const DtString& convoyPhase() const;


    virtual void setDestination(const DtUUID& destination);

    virtual DtSimObjectReference destination() const;


    virtual const DtRwSimObjectReferenceList& subordinates() const;

    virtual void addSubordinate(const DtUUID& subordinate);

    virtual void removeSubordinate(const DtUUID& subordinate);

    virtual bool isASubordinate(const DtUUID& subordinate) const;

    virtual bool isSubordinatesEmpty() const;

    virtual void clearSubordinates();


    virtual void addAwaitingTaskSubordinate(const DtUUID& subordinate);

    virtual void removeAwaitingTaskSubordinate(const DtUUID& subordinate);

    virtual DtSimObjectReference lastTaskedSubordinate() const;

    virtual DtSimObjectReference firstAwaitingTaskSubordinate() const;

    virtual void clearAwaitingTaskSubordinates();

    virtual bool isAwaitingTaskSubordinatesEmpty() const;


    virtual void setAssemblyPoint(const DtVector& assemblyPoint);

    virtual const DtVector& assemblyPoint() const;


    virtual void setConvoyLeader(const DtUUID& name);

    virtual DtSimObjectReference convoyLeader() const;


    virtual void setLeadOnDistance(const float distance);

    virtual const float leadOnDistance() const;


    virtual void setFollowDistance(const float distance);

    virtual const float followDistance() const;


    virtual void setLastGeneratedEntryRail(const DtRwRailSegment& entryRail);

    virtual DtRwRailSegment* lastGeneratedEntryRail();


    virtual void setLastOrderedSpeed(const float speed);

    virtual const float lastOrderedSpeed() const;


    virtual void setStopIfEntityDestroyed(bool);

    virtual bool stopIfEntityDestroyed() const;


    virtual void addRailSegment(const DtRailSegment& railSegment);

    virtual void addRailSegment(const DtRwRailSegment& railSegment);

    virtual void addRailSegment(const DtRwRailSegment* railSegment);

    virtual void addRailSegmentToFront(const DtRwRailSegment* railSegment);

    virtual DtRwRailSegment removeRailSegmentFromFront();

    virtual void setRailSegments(const DtRwRailSegmentList& segments);

    virtual void setRailSegments(const DtRailSegmentList& segments);

    virtual const DtRwRailSegmentList& railSegmentList() const;

    virtual void clearRailSegments();


    virtual DtRailSegmentList* railSegments();


 protected:

    void clearTempRailList();


 protected:

    DtRwBoolean myPathPlanFlag;

    DtRwString myConvoyPhase;

    DtRwSimObjectReference myDestination;

    DtRwVector myAssemblyPoint;

    DtRwSimObjectReference myConvoyLeader;

    DtRwSimObjectReference myLastTaskedSubordinate;

    DtRwReal myLeadOnDistance;

    DtRwReal myFollowDistance;

    DtRwReal myLastOrderedSpeed;

    DtRwSimObjectReferenceList mySubordinates;

    DtRwSimObjectReferenceList myAwaitingTaskSubordinates;

    DtRwRailSegmentList myRailSegments;

    DtRwRailSegment myLastGeneratedEntryRail;

    DtRailSegmentList* myTempListPtr;

    DtRwBoolean myStopIfEntityDestroyed;

    bool myRegenerateTempRailList;

 };

DtUUID
UUID is a unique ID wrapper class.
Definition: rwUUID.h:229

DtConvoyPSR::myAwaitingTaskSubordinates
DtRwSimObjectReferenceList myAwaitingTaskSubordinates
Definition: convoyPSR.h:135

rwRailSegment.h
File: rwRailSegment.h.

DtRwSimObjectReferenceList
If you use a list of object names to archive which objects are part of a controller (or any object) u...
Definition: simObjectReferenceList.h:122

DtRailSegmentList
std::list< DtRailSegment * > DtRailSegmentList
Definition: railSegment.h:197

DtConvoyPSR::mySubordinates
DtRwSimObjectReferenceList mySubordinates
Definition: convoyPSR.h:134

DtConvoyPSR::myAssemblyPoint
DtRwVector myAssemblyPoint
Definition: convoyPSR.h:128

DtRailSegment
DtRailSegment are segments entities can follow when using the rail movement system.
Definition: railSegment.h:23

rwBoolean.h

DtSimObjectReference
The DtSimObjectReference is a shared pointer that can be used amongst many object for access to the u...
Definition: simObjectReference.h:26

DtRwString
Description: Readable, Writable DtString Variable substitutions are done on this object when it is re...
Definition: rwString.h:20

DtConvoyPSR::myRailSegments
DtRwRailSegmentList myRailSegments
Definition: convoyPSR.h:136

DtReaderWriterRegistry
Definition: readerWriterRegistry.h:39

promotionIdUUIDInformation.h

DtConvoyPSR::myConvoyLeader
DtRwSimObjectReference myConvoyLeader
Definition: convoyPSR.h:129

DtConvoyPSR
This is a process state repository for the DtConvoyController that stores the list of the names of cu...
Definition: convoyPSR.h:29

DtConvoyPSR::myRegenerateTempRailList
bool myRegenerateTempRailList
Definition: convoyPSR.h:140

moveToLocationTasks.h

DtConvoyPSR::myStopIfEntityDestroyed
DtRwBoolean myStopIfEntityDestroyed
Definition: convoyPSR.h:139

railSegment.h

DtConvoyPSR::myLeadOnDistance
DtRwReal myLeadOnDistance
Definition: convoyPSR.h:131

DtVector

DtRwVector
Definition: rwVector.h:23

DtRwSimObjectReference
Specialized reader/writer version of the shared object reference that will encapsulate the actual sha...
Definition: simObjectReference.h:74

DtConvoyPSR::myPathPlanFlag
DtRwBoolean myPathPlanFlag
Definition: convoyPSR.h:125

DT_DLL_vrfobjcore
#define DT_DLL_vrfobjcore
This file is used to determine how to build.
Definition: vrfobjcoreDefines.h:24

makVrv::vrvTacticalGraphicUtilities::distance
DT_DLL_VRVCORE double distance(const makVrv::DtCoordinateSystem &, const DtVector &from, const DtVector &to)
Returns the distance from the two points. Coordinates are in local database coordinates The coordinat...

DtConvoyPSR::myDestination
DtRwSimObjectReference myDestination
Definition: convoyPSR.h:127

DtVrfProcessStateRepository::clone
virtual DtVrfProcessStateRepository * clone(const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const =0

DtConvoyPSR::myLastOrderedSpeed
DtRwReal myLastOrderedSpeed
Definition: convoyPSR.h:133

rwReal.h

DtConvoyPSR::myTempListPtr
DtRailSegmentList * myTempListPtr
Definition: convoyPSR.h:138

railMoveAlongTask.h

DtRwReal
Description: Readable, Writable DtReal (double)
Definition: rwReal.h:27

rwString.h

DtConvoyPSR::myConvoyPhase
DtRwString myConvoyPhase
Definition: convoyPSR.h:126

DtConvoyPSR::myLastTaskedSubordinate
DtRwSimObjectReference myLastTaskedSubordinate
Definition: convoyPSR.h:130

DtVrfProcessStateRepository
Class DtVrfProcessStateRepository: Abstract base class for all process state repositories. Process state repositories represent (potentially) shared, savable information for one or more components functioning together to achieve some process or set of processes; such as aiming and firing a weapon; moving an object; or just waiting a specified amount of time.
Definition: vrfProcessStateRepository.h:45

DtRwBoolean
Description: Readable, Writable bool.
Definition: rwBoolean.h:26

DtRwTemplatedListPtr< DtRwRailSegment, true >

DtConvoyPSR::myLastGeneratedEntryRail
DtRwRailSegment myLastGeneratedEntryRail
Definition: convoyPSR.h:137

simObjectReferenceList.h

DtVrfProcessStateRepository::type
virtual DtString type() const =0
Returns the string type of the repository, as defined in procSRTypes.h.

DtConvoyPSR::myFollowDistance
DtRwReal myFollowDistance
Definition: convoyPSR.h:132

DtString

DtRwRailSegment
Definition: rwRailSegment.h:27

vrfobjcoreDefines.h

vrfProcessStateRepository.h

rwVector.h
File: rwVector.h.

simObject.h

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

DtLocalObject
A locally simulated VRF object. Holds all internal and external data for the object, and provides access to both the current frame and next frame state data for the object. All current frame data is read-only, and next-frame data can be written to. No thread safety guarantees are made on this object during the simulation frame and it should only be accessed by the thread that is simulating the object.
Definition: localObject.h:86