taskStatusEntry.h

Go to the documentation of this file.

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


#pragma once

#include <readerWriter/readerWriter.h>
#include "vrfobjcore/taskMessageDescriptor.h"
#include "vrfobjcore/simObject.h"
#include <readerWriter/rwBoolean.h>
#include <readerWriter/rwInt.h>
#include "vrfutil/rwTemplatedList.h"
#include "vrfobjcore/vrfobjcoreDefines.h"
#include <readerWriter/rwString.h>
#include <vrfobjcore/rwSimObjectReference.h>

class DtTaskMessage;

typedef DtRwTemplatedIntList DtSubtaskIdList;

class DT_DLL_vrfobjcore DtSubtaskStatusEntry : public DtReaderWriter
{
public:
   DtSubtaskStatusEntry(const DtString& name,
      DtReaderWriterRegistry* parentRegistry = 0);

   virtual ~DtSubtaskStatusEntry();

   DtSubtaskStatusEntry(const DtString & name, const DtSubtaskStatusEntry & orig, 
      DtReaderWriterRegistry * parentRegistry = 0);

   DtSubtaskStatusEntry(const DtSubtaskStatusEntry & orig, 
      DtReaderWriterRegistry * parentRegistry = 0);

   DtSubtaskStatusEntry& operator=(const DtSubtaskStatusEntry& orig);


   virtual void setTaskId(int id);
   virtual int taskId() const;


   virtual void setComplete(bool v);
   virtual bool complete() const;


   virtual void setResult(bool v);
   virtual bool result() const;


   virtual void setCanceled(bool v);
   virtual bool canceled() const;


   virtual void setExecutingEntity(const DtUUID& entityName);
   virtual DtSimObjectReference executingEntity() const;

protected:
   DtRwInt myTaskId;
   DtRwBoolean myComplete;
   DtRwBoolean myResult;
   DtRwBoolean myCanceled;
   DtRwSimObjectReference myExecutingEntity;
};

typedef DtRwTemplatedListPtr<DtSubtaskStatusEntry, true> DtSubtaskStatusList;

class DT_DLL_vrfobjcore DtTaskStatusEntry : public DtReaderWriter
{
public:

   DtTaskStatusEntry(const DtString& name,
      DtReaderWriterRegistry* parentRegistry = 0);

   virtual ~DtTaskStatusEntry();

   DtTaskStatusEntry(const DtString & name, const DtTaskStatusEntry & orig, 
      DtReaderWriterRegistry * parentRegistry = 0);

   DtTaskStatusEntry& operator=(const DtTaskStatusEntry& orig);

   virtual void setControllerName(const DtString& name);
   virtual const DtString& controllerName() const;

   virtual void setTaskMessage(const DtTaskMessage& taskMessage);
   virtual DtTaskMessage* taskMessage() const;

   virtual void setTasked(bool flag);
   virtual bool tasked() const;

   virtual void addPendingSubtaskId(int subtaskId);
   virtual void removePendingSubtaskId(int subtaskId);
   virtual bool findPendingSubtaskId(int subtaskId) const;
   virtual const DtSubtaskStatusEntry* findSubtaskStatus(int subtaskId) const;
   virtual DtSubtaskStatusEntry* findSubtaskStatus(int subtaskId);
   virtual void removeAllPendingSubtaskIds();
   virtual void printPendingSubtaskIds() const;
   virtual void removeInactiveSubtaskStatus(int olderThanTaskId = -1);

   virtual const DtSubtaskStatusList& subtaskStatusList() const;
   virtual DtSubtaskStatusList& subtaskStatusList();

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


protected:

   DtRwString myControllerName;
   DtTaskMessageDescriptor myTaskMessageDescriptor;
   DtRwBoolean myTasked;
   DtSubtaskStatusList mySubtaskStatusList;
};