embeddedEntitiesPSR.h

Go to the documentation of this file.

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


#pragma once

#include "vrfobjcore/vrfProcessStateRepository.h"
#include "vrfobjcore/vrfobjcoreDefines.h"

#include "vrfobjparam/rwEmbeddedEntity.h"

#include "vrfutil/rwInt.h"
#include "vrfutil/rwReal.h"
#include "vrfutil/rwTemplatedList.h"

class DT_DLL_vrfobjcore DtRwEmbeddedEntityTaskState : public DtReaderWriter{

public:
   enum DtEmbeddedEntityControlState
   {
      DtIdle,
      DtWaitingToDeployForForwarding,
      DtForwardingMessage,
      DtWaitingToDeploy,
      DtWaitingToRecover,
      DtWaitingOnSubtaskCompletion,
      DtComplete,
      DtUnable //Error state(unable to perform task as requested)
   };

public:

   DtRwEmbeddedEntityTaskState(const DtString& rwName, DtReaderWriterRegistry* parentRegistry = 0);
   DtRwEmbeddedEntityTaskState(const DtRwEmbeddedEntityTaskState & orig, DtReaderWriterRegistry* parentRegistry = 0);
   virtual DtRwEmbeddedEntityTaskState& operator=(const DtRwEmbeddedEntityTaskState& orig);
   virtual ~DtRwEmbeddedEntityTaskState();

   virtual void increaseTimeWaited(double delta);
   virtual void resetToIdle();

   virtual void setTaskState(const DtEmbeddedEntityControlState& stateEnum);
   virtual DtEmbeddedEntityControlState taskState() const;

   virtual void setTaskId(const int& tskId);
   virtual int taskId() const;

   virtual void setSubtaskId(const int& subtskId);
   virtual int subtaskId() const;

   virtual void setTimeWaiting(const double& time);
   virtual double timeWaiting() const;

   virtual void setEntityName(const DtString& entName);
   virtual const DtString& entityName() const;

private:
   DtRwEmbeddedEntityTaskState();

protected:
   DtRwInt myTaskState;
   DtRwInt myTaskId;
   DtRwInt mySubtaskId;
   DtRwReal myTimeWaiting;
   DtRwString myEntityName;
};

class DT_DLL_vrfobjcore DtEmbeddedEntitiesPSR : public DtVrfProcessStateRepository{

public:
   DtEmbeddedEntitiesPSR(DtVrfObject* vrfObject,
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0);

   DtEmbeddedEntitiesPSR(const DtEmbeddedEntitiesPSR& orig,
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0);

   virtual ~DtEmbeddedEntitiesPSR();

   DtEmbeddedEntitiesPSR& operator=(const DtEmbeddedEntitiesPSR& orig);

   virtual DtVrfProcessStateRepository* clone(
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0) const;

   virtual DtString type() const;

   virtual const DtRwTemplatedListPtr<DtRwEmbeddedEntityStatus, true>& entityStatusList() const;
   virtual DtRwTemplatedListPtr<DtRwEmbeddedEntityStatus, true>& entityStatusList();

   virtual const DtRwTemplatedListPtr<DtRwEmbeddedEntityTaskState, true>& entityTaskStateList() const;
   virtual DtRwTemplatedListPtr<DtRwEmbeddedEntityTaskState, true>& entityTaskStateList();

   virtual bool entityDeployed(const DtString& entityName);
   virtual bool entityTasking(const DtString& entityName);

   virtual DtRwEmbeddedEntityStatus* const findEntityStatus(
      const DtString& name, DtListItem*& elem, bool searchByMarkingText);
   virtual DtRwEmbeddedEntityStatus* const findEntityStatusByName(const DtString& entityName);
   virtual DtRwEmbeddedEntityStatus* const findEntityStatusByMarkingText(const DtString& entityMarkingText);

   virtual void const addNewEntityStatus(
      const DtString& entityName, const DtString rwElemName = "embedded-entity");

   virtual DtRwEmbeddedEntityTaskState* const findEntityTaskStateByName(const DtString& name);
   virtual DtRwEmbeddedEntityTaskState* const findEntityTaskStateByTaskId(const int& tskId);

   virtual void const addNewEntityTaskState(
      const DtString& entityName, const DtString rwElemName = "ee-task-state");

public:
   static DtVrfProcessStateRepository* creator (const DtString& rwName,
      DtVrfObject* vrfObject, DtReaderWriterRegistry* parentRegistry);
protected:
   //DtRwString myRecoveryWaypointName;

   DtRwTemplatedListPtr<DtRwEmbeddedEntityStatus, true> myEntityStatusList;
   DtRwTemplatedListPtr<DtRwEmbeddedEntityTaskState, true> myEntityTaskStateList;
};