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 "vrfutil/rwVariableBindings.h"
#include "vrfutil/rwString.h"

#include <vrftasks/stringRepHelper.h>


class DT_DLL_vrftasks DtScriptedTaskTask : public 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 DtSimTask * clone(const DtString & name, DtReaderWriterRegistry * 
      parentRegistry = 0) const;

   virtual DtString stringRep() const;

   virtual int netRepSize() const;

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

   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 int scriptPriority() const;

   virtual void setScriptPriority(int);

   virtual bool scriptEnabled() const;

   virtual void setScriptEnabled(bool);

   virtual bool scriptActive() const;

   virtual void setScriptActive(bool);

   static DtSimTask * creator();

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

protected:
   virtual void upgradeVariables();

protected:
   DtRwString myScriptId;
   DtRwVariableBindings myVariables;
   DtRwVariableBindings myVariableDataTypes;
   mutable DtSimTaskMessageType myType;
};

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