localObjectCreateInformation.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2021 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

#pragma once

#include "vrfmsgs/vrfmsgsDefines.h"
#include "vrfutil/rwUUID.h"
#include <vlpi/entityType.h>
#include "vlpi/entityIdentifier.h"
#include "matrix/vlVector.h"
#include "matrix/vlVector.h"
#include "vlpi/disEnums.h"

#include <vector>
#include <list>

class DtIfCreateVrfObject;
class DtLocalObject;
class DtAdminContent;
class DtSimInterfaceContent;

typedef bool(*DtVrfObjectUserInitFcn)(DtLocalObject* vrfObject, void* usr);

namespace makVrf
{
   class DtExternalCurrentFrameState;
}

class DT_DLL_vrfmsgs DtLocalObjectCreateInformation
{
public:
   DtLocalObjectCreateInformation(const DtUUID& uuid);

   DtLocalObjectCreateInformation();

   DtLocalObjectCreateInformation(const DtIfCreateVrfObject&);

   DtLocalObjectCreateInformation(const DtLocalObjectCreateInformation&);
   DtLocalObjectCreateInformation& operator=(const DtLocalObjectCreateInformation&);

   virtual ~DtLocalObjectCreateInformation();

   void setUUID(const DtUUID&);
   const DtUUID& uuid() const;

   void setOverlay(const DtString&);
   const DtString& overlay() const;

   void setObjectType(const DtEntityType&);
   const DtEntityType& objectType() const;

   void setPublishFlag(int);
   void setPublishObject(bool);  
   bool publishObject() const ;  
   int publishFlag() const;

   void setEntityIdentifier(const DtEntityIdentifier&);

   DtEntityIdentifier entityIdentifier() const;

   void setLabel(const DtString&);
   const DtString& label() const;

   void setExtendedLabels(const std::map<int, DtString>&);
   const std::map<int, DtString>& extendedLabels() const;

   void setPosition(const DtVector& geocLocation);

   DtVector position() const;
   DtVector endPosition() const;

   const std::vector<DtVector>& vertices() const;
   std::vector<DtVector>& vertices();

   void setVertices(const DtList&);
   void setVertices(const std::vector<DtVector>&);
   void addVertex(const DtVector&);

   const DtTaitBryan& orientation() const;
   void setOrientation(const DtTaitBryan&);

   void setColor(int);
   int color() const;
   bool colorSet() const;
   void clearColor();

   void setLineWidth(int);
   int lineWidth() const;
   bool lineWidthSet() const;
   void clearLineWidth();

   void setPenStyle(int);
   int penStyle() const;
   bool penStyleSet() const;
   void clearPenStyle();

   void setFillStyle(int);
   int fillStyle() const;
   bool fillStyleSet() const;
   void clearFillStyle();

   void setWorldVelocity(const DtVector&);
   const DtVector& worldVelocity() const;
   bool worldVelocitySet() const;
   void clearWorldVelocity();

   void setWorldOrientation(const DtTaitBryan&);
   const DtTaitBryan& worldOrientation() const;
   bool worldOrientationSet() const;
   void clearWorldOrientation();

   void setAmClampedToGround(bool);
   bool amClampedToGround() const;

   void setHeading(double rad);
   double heading() const;

   void setPitch(double rad);
   double pitch() const;

   void setRoll(double rad);
   double roll() const;

   void setObjectName(const DtString&);
   const DtString& objectName() const;

   void setObjectNamePrefix(const DtString&);
   const DtString& objectNamePrefix() const;

   void setForceType(DtForceType);
   DtForceType forceType() const;

   void setClampToGround(bool);
   bool clampToGround() const;

   void setProjected(bool);
   bool projected() const;

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

   void setGlobalId(const DtString&);
   const DtString& globalId() const;

   void setClosedFigure(bool);
   bool closedFigure() const;

   void setAppearance(unsigned int);
   unsigned int appearance() const;

   void setConnectToRadioNetwork(bool b);
   bool connectToRadioNetwork() const;

   void setAddToOrbat(bool);
   bool addToOrbat() const;

   void setCreateSubObjects(bool b);
   bool createSubObjects() const;

   void setOrganized(bool);
   bool organized() const;

   void setUserCallback(DtVrfObjectUserInitFcn, void*);
   DtVrfObjectUserInitFcn callbackFunction() const;
   void* callbackData() const;

   void setRequestId(unsigned long);
   unsigned long requestId() const;

   void setStartingFormation(const DtString&);
   const DtString& startingFormation() const;

   void setAggregateCreationMode(int);
   int aggregateCreationMode() const;

   const std::map<std::string, std::string>& extendedData() const;
   std::map<std::string, std::string>& extenedData();
   void setExtendedData(const std::map<std::string, std::string>&);
   void setExtendedData(const std::map<DtString, DtString>&);
   void setExtendedData( const DtString& keyword, const DtString& data );

   const DtString& userData() const;
   void setUserData(const DtString&);

   void setSuperior(const DtUUID&);
   const DtUUID& superior() const;

   const std::list<DtAdminContent*>& initialAdminContent() const;

   std::list<DtAdminContent*>& initialAdminContent();

   void setInitialAdminContent(const std::list<DtAdminContent*>& adminContent);
   void addInitialAdminContent(DtAdminContent* adminContent);
   void clearInitialAdminContent();

   const std::list<DtSimInterfaceContent*>& initialInterfaceContent() const;

   std::list<DtSimInterfaceContent*>& initialInterfaceContent();

   void setInitialInterfaceContent(const std::list<DtSimInterfaceContent*>& adminContent);
   void addInitialInterfaceContent(DtSimInterfaceContent* adminContent);
   void clearInitialInterfaceContent();

   void addSubordinates(const std::vector<DtUUID>&);
   void addSubordinate(const DtUUID&);
   void renmoveSubordinate(const DtUUID&);
   void clearSubordinates();
   const std::vector<DtUUID>& subordinates() const;

   virtual bool isValid() const;

protected:
   void validateUUID();

protected:
   DtUUID myUUID;
   DtEntityType myObjectType;
   DtString myLabel;
   DtString myObjectName;
   DtString myObjectNamePrefix;
   DtString myOverlay;
   std::map<int, DtString> myExtendedLabels;
   bool myAddToOrbat;
   bool myCreateSubObjects;
   bool myOrganized;
   DtString myUserData;
   bool myClampToGround;

   DtString myStartingFormation;
   int myAggregateCreationMode;

   DtVrfObjectUserInitFcn myUserInitFunction;
   void* myUserInitData;

   DtTaitBryan myOrientation;

   std::vector<DtVector> myVertices;

   int myPublishFlag;

   DtForceType myForceType;

   DtEntityIdentifier myEntityIdentifier;

   bool myProjected;

   bool myClosedFigure;

   unsigned int myAppearance;
   bool myConnectToRadioNetwork;

   unsigned long myRequestId;

   std::map<std::string, std::string> myExtendedData;

   std::list<DtAdminContent*> myAdminContent;
   std::list<DtSimInterfaceContent*> myInterfaceContent;

   DtUUID mySuperior;

   DtVector myWorldVelocity;
   bool myWorldVelocitySet;

   DtTaitBryan myWorldOrientation;
   bool myWorldOrientationSet;

   std::vector<DtUUID> mySubordinates;

   int myColor;
   bool myColorSet;

   int myLineWidth;
   bool myLineWidthSet;

   int myPenStyle;
   bool myPenStyleSet;

   int myFillStyle;
   bool myFillStyleSet;

   bool myIsClutterEntity;

   DtString myGlobalId;
};