scriptedTaskTask.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2012 MaK Technologies, Inc.
** All rights reserved.
*******************************************************************************/


#pragma once

#include "vrftasks/vrftasksDefines.h"
#include "vrftasks/simTask.h"
#include "vrftasks/setDataRequest.h"
#include "vrfutil/rwVariableBindings.h"
#include "vrfutil/rwString.h"
#include "vrfutil/scriptedTaskVariable.h"

#include <vrftasks/stringRepHelper.h>


class DT_DLL_vrftasks DtScriptedTask
{
public:
   class ScriptedTaskFormatter
   {
   public:
      virtual DtString stringRep(const DtScriptedTask&) const = 0;
      virtual DtString stringRep(const DtString& scriptId, const DtRwVariableBindings& variables, const DtRwVariableBindings& variableDataTypes) const = 0;
   };

   DtScriptedTask() {};
   virtual ~DtScriptedTask() {};

   virtual bool init() = 0;

   virtual const DtString& scriptId() const = 0;
   virtual void setScriptId(const DtString&) = 0;

   virtual DtRwVariableBindings& variables() = 0;
   virtual const DtRwVariableBindings& variables() const = 0;

   virtual DtRwVariableBindings& variableDataTypes() = 0;
   virtual const DtRwVariableBindings& variableDataTypes() const = 0;


   virtual int netRepSize() const = 0;

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

   virtual char* setToNet(char*) = 0;

   static void setScriptedTaskFormatter(ScriptedTaskFormatter*);
   static ScriptedTaskFormatter* scriptedTaskFormatter();

   virtual DtString allVariablesStringRep(const DtString& scriptName = "") const = 0;

protected:
   static ScriptedTaskFormatter* theScriptedTaskFormatter;
};

template<class T> class DtScriptedTaskTemplate : public T, public DtScriptedTask
{

public:

   DtScriptedTaskTemplate();

   DtScriptedTaskTemplate(const DtString & writeName, 
      DtReaderWriterRegistry * parentRegistry = 0);

   DtScriptedTaskTemplate(const DtString & writeName, const DtScriptedTaskTemplate & orig, 
      DtReaderWriterRegistry * parentRegistry = 0);

   DtScriptedTaskTemplate(const DtScriptedTaskTemplate & orig );

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

   virtual ~DtScriptedTaskTemplate();

   virtual DtString stringRep() const;

   virtual DtString allVariablesStringRep(const DtString& scriptName = "") const;

   virtual int netRepSize() const;

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

   virtual bool init();

   virtual bool setToNet();
   virtual char* setToNet(char*);

   virtual DtRwVariableBindings& variables();
   virtual const DtRwVariableBindings& variables() const;

   virtual void setVariables(const DtRwVariableBindings&);

   virtual DtRwVariableBindings& variableDataTypes();
   virtual const DtRwVariableBindings& variableDataTypes() const;

   virtual void setScriptId(const DtString&);
   virtual const DtString& scriptId() const;

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

protected:
   virtual void upgradeVariables();

protected:
   DtRwString myScriptId;
   DtRwVariableBindings myVariables;
   DtRwVariableBindings myVariableDataTypes;
};

class DT_DLL_vrftasks DtScriptedTaskStringRepHelper : public DtStringRepHelper
{
public:
   DtScriptedTaskStringRepHelper() {};
   DtScriptedTaskStringRepHelper(const std::vector<DtScriptedTaskVariable>&);

   virtual ~DtScriptedTaskStringRepHelper() {};

   virtual bool isDisplayableSymbol(const DtString& s, const DtReaderWriter* value, const DtReaderWriter* type) const;
   virtual bool isDisplayableScriptSymbol(const DtString& scriptId, const DtString& scriptVariableName) const;

protected:
   std::map<std::string, DtScriptedTaskVariable> myVariables;
};

class DT_DLL_vrftasks DtScriptedTaskTask : public DtScriptedTaskTemplate<DtSimTask>
{
public:
   DtScriptedTaskTask();

   DtScriptedTaskTask(const DtString & writeName, 
      DtReaderWriterRegistry * parentRegistry = 0);

   DtScriptedTaskTask(const DtString & writeName, const DtScriptedTaskTask & orig, 
      DtReaderWriterRegistry * parentRegistry = 0);

   DtScriptedTaskTask(const DtScriptedTaskTask & orig );

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

   virtual ~DtScriptedTaskTask();

   virtual const DtSimTaskMessageType& type() const;

   virtual int scriptPriority() const;

   virtual void setScriptPriority(int);

   virtual bool scriptEnabled() const;

   virtual void setScriptEnabled(bool);

   virtual bool scriptActive() const;

   virtual void setScriptActive(bool);

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

   static DtSimTask * creator();

protected:
   mutable DtSimTaskMessageType myType;
};

namespace DtBufferSerialize
{
   DT_DLL_vrftasks int getSize(const DtScriptedTask& list);
   DT_DLL_vrftasks char* encode(const DtScriptedTask& list, char* buffer);
   DT_DLL_vrftasks const char* decode(DtScriptedTask& list, const char* buffer);
}