createObjectCommand.h

Go to the documentation of this file.

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



#pragma once

#include "vrfplan/simCommand.h"
#include "vrfplan/vrfplanDefines.h"
#include "vrfutil/rwString.h"
#include "vrfutil/rwObjectType.h"
#include "vrfutil/rwVector.h"
#include "vrfutil/rwTemplatedList.h"
#include "vrfutil/rwForceType.h"
#include "vrfutil/rwReal.h"
#include "vrfutil/rwBoolean.h"
#include "vrfutil/rwInt.h"
#include "vrfutil/rwStringList.h"
#include "vrfutil/rwIntegerAttributeList.h"
#include "vrfutil/rwStringAttributeList.h"
#include "vrfutil/rwVectorList.h"
#include <vrfExtProtocol/simInterfaceContent.h>

class DtAdminContent;
class DtSimInterfaceContent;

class DT_DLL_vrfplan DtCreateObjectCommand : public DtSimCommand
{
public:
   DtCreateObjectCommand();

   DtCreateObjectCommand(const DtString& writeName,
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtCreateObjectCommand(const DtString & writeName, const DtCreateObjectCommand& orig,
      DtReaderWriterRegistry* parentRegistry = NULL);

   virtual ~DtCreateObjectCommand();

   DtCreateObjectCommand& operator=(const DtCreateObjectCommand& orig);

   virtual const DtSimCommandMessageType& type() const;

   virtual DtSimCommand * clone(const DtString & name, DtReaderWriterRegistry *
      parentRegistry = 0) const;


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

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


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

   virtual void clearVertices();
   virtual void addVertex(const DtVector& vertex);
   virtual int numberOfVertices() const;
   virtual DtVector vertex(unsigned int index) const;


   virtual DtReal heading() const;
   virtual void setHeading(DtReal heading);

   virtual bool headingSpecified() const;


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


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


   virtual bool clampedToGround() const;
   virtual void setClampedToGround(bool value);


   virtual bool aggregated() const;
   virtual void setAggregated(bool value);

   virtual DtString stringRep() const;

   virtual int netRepSize() const;

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

   virtual bool setToNet();

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

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

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

   virtual void encodeAndAddAdminContent(const DtAdminContent*);
   
   virtual void createAndAddInterfaceContentFromEncodedBuffer(const DtString&);

   virtual void encodeAndAddInterfaceContent(const DtSimInterfaceContent*);

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

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

   virtual void setUserData(const DtString&);
   virtual void setUserData(const std::string&);
   virtual const DtString& userData() const;

   static DtSimCommand* creator();

protected:
   virtual void getSelf(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
                                          const DtVariableBindingsList& variableBindings);

   virtual char* decodeBuffer(const DtString&) const;
   virtual DtString encodeBuffer(const char* chr, int length) const;

protected:
   DtRwString myObjectName;
   DtRwObjectType myObjectType;
   DtRwForceType myForceType;
   DtRwVectorList myVertices;
   DtRwReal myHeading;
   DtRwBoolean myClosedFigure;
   DtRwBoolean myProjected;
   DtRwBoolean myClampedToGround;
   DtRwBoolean myAggregated;
   DtRwStringList myAdminContents;
   DtRwStringList myInterfaceContents;
   DtRwString myUserData;
   DtRwStringAttributeList myExtendedData;
   DtRwIntegerAttributeList myExtendedLabels;
   DtRwInt myAppearance;

   std::list<DtAdminContent*> myAdditionalAdminContent;

   std::list<DtSimInterfaceContent*> myAdditionalInterfaceContent;
};