componentDescriptor.h

Go to the documentation of this file.

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



#pragma once

#include <readerWriter/readerWriter.h>
#include "vrfobjparam/componentDescriptorFactory.h"
#include "vrfobjparam/simArtPartDescriptorList.h"
#include "vrfutil/rwNLengthStringVector.h"
#include "vrfutil/rwScriptVariables.h"

#include <readerWriter/rwString.h>
#include <readerWriter/rwReal.h>
#include <readerWriter/rwBoolean.h>

class DtReaderWriterRegistry;
class DtFilename;

#include "vrfobjparam/vrfobjparamDefines.h"
class DT_DLL_vrfobjparam DtComponentDescriptor : public DtReaderWriter
{
public:
    DtComponentDescriptor(const DtString& componentName, 
      DtReaderWriterRegistry* parentRegistry = NULL);
    DtComponentDescriptor(const DtSymbolString& componentName, 
      DtReaderWriterRegistry* parentRegistry = NULL);

    DtComponentDescriptor(const DtComponentDescriptor& orig,
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtComponentDescriptor& operator=(const DtComponentDescriptor& orig);

   virtual ~DtComponentDescriptor() override;

   virtual DtString type() const;

   virtual DtComponentDescriptor* clone(
   DtReaderWriterRegistry* parentRegistry = NULL) const;

   virtual void setComponentType(const DtString& componentType);
   virtual const DtString& componentType() const;

   virtual void putData(std::string& fp, int indentLevel = 0) override;

   virtual DtlObjPtr getData(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings) override;

   virtual bool init();

   virtual void setMinTickPeriod(DtReal minTickPeriod);
   virtual DtReal minTickPeriod() const;

   virtual void setMinTickPeriodVariance(DtReal minTickPeriodVariance);
   virtual DtReal minTickPeriodVariance() const;

   virtual void setPeriodicTickWhilePaused(bool value);
   virtual bool periodicTickWhilePaused() const;

   virtual const DtString& processStateRepositoryName() const;
   virtual void setProcessStateRepositoryName(const DtString& name);

   virtual const DtString& processStateRepositoryType() const;
   virtual void setProcessStateRepositoryType(const DtString& type);

   virtual void setIsEnabled(bool yesNo);
   virtual bool isEnabled() const;

   virtual void setIsEnabledForClutterEntities(bool yesNo);
   virtual bool isEnabledForClutterEntities() const;

   virtual void setDebugActive(bool active){myDebug = active;}
   virtual bool debugActive() const {return myDebug;}

   virtual void setMinTaskVisualizationTickPeriod(DtReal minTickPeriod);
   virtual DtReal minTaskVisualizationTickPeriod() const;

   virtual void setTaskVisualizationsEnabled(bool enabled);
   virtual bool taskVisualizationsEnabled() const;

   virtual void setCreateComponent(bool yesNo);
   virtual bool createComponent() const;


   virtual void setCreateOnRemoteObject(bool yesNo);
   virtual bool createOnRemoteObject() const;

   virtual const DtRwNLengthStringVector& scriptIds() const;
   virtual DtRwNLengthStringVector& scriptIds();

   virtual const DtRwScriptVariablesList& scriptVariables() const;
   virtual DtRwScriptVariablesList& scriptVariables();

   virtual const DtRwProperties& parameterData() const;
   virtual DtRwProperties& parameterData();

   virtual const DtRwProperties& stateData() const;
   virtual DtRwProperties& stateData();

   virtual const DtString& stateAndParameterDataPrefix() const;

   virtual const DtRwProperties& internalStateData() const;
   virtual DtRwProperties& internalStateData();

   static void addComponentDescriptorCreatorFcn(const DtString& type, 
      DtComponentDescriptorCreatorFcn fcn);

   static DtComponentDescriptorFactory* factory();
   static void setFactory(DtComponentDescriptorFactory* factory);

   static DtComponentDescriptor* createComponentDescriptor(DtlObjPtr mtlStream, 
      const DtReaderWriter::SearchPaths& searchPaths, 
      const DtVariableBindingsList& variableBindings);

   static DtComponentDescriptor* createComponentDescriptor(const char* pName);

   static DtComponentDescriptor* creator();

   bool operator==(const DtComponentDescriptor&) const;

protected:
   DtComponentDescriptor();

   void addPrefixToStateAndParameterData();

protected:

   DtRwString                myComponentType;

   DtRwReal                  myMinTickPeriod;

   DtRwReal                  myMinTickPeriodVariance;

   DtRwBoolean               myPeriodicTickWhilePaused;

   DtRwString                myProcessStateRepositoryName;

   DtRwString                myProcessStateRepositoryType;

   DtRwBoolean myIsEnabled;

   DtRwBoolean myIsEnabledForClutterEntities;

   DtRwBoolean myDebug;

   DtRwReal                  myMinTaskVisualizationTickPeriod;

   DtRwBoolean               myTaskVisualizationsEnabled;

   DtRwBoolean               myCreateComponent;

   DtRwBoolean myCreateOnRemoteObject;

   DtRwProperties myParameterData;

   DtRwProperties myStateData;

   DtRwString myStateAndParameterDataPrefix;

   DtRwProperties myInternalStateData;


   DtRwNLengthStringVector   myScriptIds;

   DtRwScriptVariablesList myScriptVariables;
 
   bool myPrefixAppliedToStateAndParamData;

   static DtComponentDescriptorFactory* myFactory;
};