ifComputeRoute.h

Go to the documentation of this file.

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


#pragma once

#include <vrfExtProtocol/simInterfaceContent.h>
#include <vrfutil/bufferSerialize.h>
#include "vrfmsgs/vrfmsgsDefines.h"
#include "vrfmsgs/messageTypes.h"

class DtSimManager;

class DT_DLL_vrfmsgs DtIfComputeRoute : public DtSimInterfaceContent
{

public:

   DtIfComputeRoute();

   DtIfComputeRoute(const DtIfComputeRoute& orig);

   const DtIfComputeRoute& operator=(const DtIfComputeRoute& orig);

   virtual ~DtIfComputeRoute();

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

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

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

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

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

   virtual const DtVector& startPoint() const;
   virtual void setStartPoint(const DtVector&);

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

   virtual const DtVector& endPoint() const;
   virtual void setEndPoint(const DtVector&);

   virtual const std::vector<DtString>& obstacleTypes() const;
   virtual void setObstacleTypes(const std::vector<DtString>&);
   virtual void addObstacleType(const DtString&);

   virtual const std::vector<DtString>& pathTypes() const;
   virtual void setPathTypes(const std::vector<DtString>&);
   virtual void addPathType(const DtString&);

   virtual bool cancel() const;
   virtual void setCancel(bool);

   virtual int type() const;

   virtual DtIfComputeRoute* clone() const;

   virtual int netRepSize() const;

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

   virtual bool setToNet();

   virtual void printDataToString(DtString& str);

   static DtSimInterfaceContent* creator();

protected:
   DtU32                myRequestId;
   DtString             myObjectName;
   DtForceType          myForceType;
   DtString             myOverlay;
   DtString             myObjectLabel;
   DtVector             myStartPoint;
   DtVector             myEndPoint;
   std::vector<DtString> myObstacleTypes;
   std::vector<DtString> myPathTypes;
   std::map<int, DtString> myExtendedLabels;
   bool                 myCancelFlag;
};

class DT_DLL_vrfmsgs DtIfComputeRouteResponse : public DtSimInterfaceContent
{

public:

   DtIfComputeRouteResponse();

   DtIfComputeRouteResponse(const DtIfComputeRouteResponse& orig);

   const DtIfComputeRouteResponse& operator=(const DtIfComputeRouteResponse& orig);

   virtual ~DtIfComputeRouteResponse();

   virtual int type() const;

   virtual void setObjectIdentifier(const DtEntityIdentifier & objectIdentifier);
   virtual const DtEntityIdentifier & objectIdentifier() const;

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

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

   virtual void setSuccess(bool);
   virtual bool success() const;

   virtual DtIfComputeRouteResponse* clone() const;

   virtual int netRepSize() const;

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

   virtual bool setToNet();

   virtual void printDataToString(DtString& str);

   static DtSimInterfaceContent* creator();

protected:

   DtEntityIdentifier         myObjectIdentifier;
   DtU32                      myRequestId;
   DtString                   myObjectName;
   bool                       mySuccessFlag;
};