vrfExtensions.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2017 VT MAK
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include <vrfExtObjects/dllExport.h>
#include <vrfExtProtocol/rangeItem.h>
#include <vlutil/vlString.h>
#include <map>

class DtObjectType;
class DtIfVrfObjectData;

const DtU32 DtNoExpectedVrfMessageVersion = 0;

class DT_DLL_vrfExtObjects DtVrfExtensions
{
public:

   // Constructor
   DtVrfExtensions();

   virtual ~DtVrfExtensions();

   // copy constructor
   DtVrfExtensions(const DtVrfExtensions& orig);

   // assignment operator
   DtVrfExtensions& operator=(const DtVrfExtensions& orig);

   virtual const DtString& name() const;
   virtual void setName(const DtString& n);

   virtual const DtString& vrfObjectLabel() const;
   virtual void setVrfObjectLabel(const DtString& l);

   virtual const DtString& echelonId() const;
   virtual void setEchelonId(const DtString& l);

   virtual const DtString& overlayParent() const;
   virtual void setOverlayParent(const DtString& l);

   virtual bool isVrfSimulated() const;
   virtual void setIsVrfSimulated(bool vrf);

   virtual DtU32 vrfSessionId() const;
   virtual void setVrfSessionId(DtU32 id);

   virtual void setVrfMessageVersionSupported(DtU32 id);
   virtual DtU32 vrfMessageVersionSupported() const;

   virtual void setObjectType(const DtObjectType&);
   virtual const DtObjectType& objectType() const;

   virtual void setIsSubordinateOfForce(bool b);
   virtual bool isSubordinateOfForce() const;

   // Independently tasked status (individual entities and aggregates
   // only).  Default is false.
   // @{
   virtual void setIndependentlyTasked(bool yesNo);
   virtual bool independentlyTasked() const;
   // @}

   virtual int superType() const;

   // Under fire status (individual entities and aggregates
   // only).  Default is false.
   // @{
   virtual void setUnderFire(bool yesNo);
   virtual bool underFire() const;
   // @}

   virtual void setHasPlan(bool yesNo);
   virtual bool hasPlan() const;

   // Indicates whether the entity is executing a plan.
   virtual void setExecutingPlan(bool yesNo);
   virtual bool executingPlan() const;

   virtual void setIsCurrentlyTasked(bool yesNo);
   virtual bool isCurrentlyTasked() const;

   virtual void setRulesOfEngagement(const DtString&);
   virtual const DtString& rulesOfEngagement() const;

   virtual void setIsClutterEntity(bool yesNo);
   virtual bool isClutterEntity() const;

   // Sets up internal information based on session id and vrf object data.  Returns true if
   // anything has changed due to the new setting of information
   virtual bool setupFromVrfObjectData(const DtIfVrfObjectData& data);

   //{@
   virtual void addRangeItem(const DtRangeItem&);
   virtual void removeRangeItem(int index);
   virtual void setRangeItems(const DtRangeItems&);
   const DtRangeItems& rangeItems() const;

   virtual void setExtendedData(const std::map<DtString, DtString>&);
   virtual const std::map<DtString, DtString>& extendedData() const;
   virtual void setExtendedData(const DtString& key, const DtString& value);
   virtual DtString extendedData(const DtString&) const;

   virtual void setBoundingVolume(const DtVector32&);
   virtual const DtVector32& boundingVolume() const;

   virtual void setBoundingVolumeOffset(const DtVector32&);
   virtual const DtVector32& boundingVolumeOffset() const;

   static void setExpectedVrfMessageVersion(DtU32 version);
   static DtU32 expectedVrfMessageVersion();

   bool isVrfObject() const { return (myVrfObjectDataMessage != nullptr); };

public:
   // createVrfObjectDataMessage()
   // allocates myVrfObjectDataMessage, a DtIfVrfObjectData
   // used by VR-Forces as extended vrf object data message information
   virtual bool createVrfObjectDataMessage();

   // vrfObjectDataMessage()
   // returns the myVrfObjectDataMessage for inspection by
   // the caller.  If myVrfObjectDataMessage is NULL, it is created.
   virtual DtIfVrfObjectData* vrfObjectDataMessage() const;

protected:
   // Used internally to signal that this structure has been modified.  By default does nothing
   virtual void extensionModified();

protected:
   DtString myName;
   DtIfVrfObjectData* myVrfObjectDataMessage;

   static DtU32 theExpectedVrfMessageVersion;
};