ifCreateVrfObject.h

Go to the documentation of this file.

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


#pragma once

#include <vrfmsgs/localObjectCreateInformation.h>
#include <vrfExtProtocol/simInterfaceContent.h>
#include <vlpi/simulationAddress.h>
#include <vlpi/appearance.h>

class DT_DLL_vrfmsgs DtIfCreateVrfObject : public DtSimInterfaceContent
{
public:

   DtIfCreateVrfObject();

   virtual ~DtIfCreateVrfObject();

   DtIfCreateVrfObject(const DtIfCreateVrfObject& orig);

   DtIfCreateVrfObject& operator=(const DtIfCreateVrfObject& orig);

   virtual DtSimInterfaceContent * clone() const;

   virtual int type() const;

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

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

   virtual void setVrfProcessAddress(const DtSimulationAddress & address);
   virtual const DtSimulationAddress & vrfProcessAddress() const;

   virtual void setMarkingText(const DtString & objectName);
   virtual const DtString & markingText() const;

   virtual void setMarkingTextPrefix(const DtString & objectName);
   virtual const DtString & markingTextPrefix() const;

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

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

   virtual void setObjectLabel(const DtString & objectLabel);
   virtual const DtString & objectLabel() const;

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

   virtual DtVector position() const;
   virtual void setPosition(const DtVector & position);
   
   virtual DtReal heading() const;
   virtual void setHeading(DtReal heading);
   
   virtual DtReal pitch() const;
   virtual void setPitch(DtReal pitch);
   virtual bool isPitchSpecified() const;
   virtual void clearPitchSpecified();

   virtual const std::vector<DtVector>& vertexList() const;
   virtual const std::vector<DtVector>& vertices() const;
   virtual void setVertices(const std::vector<DtVector>& vertices);
   virtual void setVertices(const DtList& vertices);

   virtual void addVertex(const DtVector & vertex);

   virtual bool projection() const;
   virtual void setProjection(bool projection);

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

   virtual DtAppearance appearance() const;
   virtual void setAppearance(const DtAppearance& appearance);

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

   virtual bool addToOrganization() const;
   virtual void setAddToOrganization(bool addToOrg);

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


   virtual DtString initialFormation() const;
   virtual void setInitialFormation(const DtString& formation);


   virtual bool publishObject() const;
   virtual void setPublishObject(bool);


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

   virtual DtAggregateState initialAggregateState() const;
   virtual void setInitialAggregateState(DtAggregateState aggregateState);

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

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

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

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

   void setStartPosition(const DtVector& position);
   DtVector startPosition() const;
   void setEndPosition(const DtVector& position);
   DtVector endPosition() const;

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

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


   virtual int netRepSize() const;
   virtual bool setFromNet(const char* contentBuffer, 
      unsigned contentSize);
   virtual bool setToNet();

   virtual void printDataToString(DtString& str);

   static DtSimInterfaceContent* creator();

   virtual bool isValid() const;

protected:
   DtLocalObjectCreateInformation myLocalObjectCreateInformation;
   DtSimulationAddress myVrfProcessAddress;
   bool myPitchSpecified;
};