componentSystem.h

Go to the documentation of this file.

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

#pragma once

#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfobjcore/platformLocalObjectFacade.h"
#include <boost/signals2.hpp>
#include <list>
#include <map>
#include <string>

#include <matrix/vlVector.h>

class DtSimulationServices;
class DtComponentSystemDescriptor;
class DtSimComponentNetwork;
class DtString;
class DtSimComponent;
class DtComponentSystemPSR;
class DtVrfProcessStateRepositoryManager;
class DtReaderWriter;
class DtSimComponentList;
class DtLocalObject;

typedef DtReaderWriter* (*genericAttributeProviderFunctionType)(void*);
typedef bool (*genericAttributeSetterFunctionType)(void*, DtReaderWriter*);

class DT_DLL_vrfobjcore DtComponentSystem
{
private:

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

public:
   DtComponentSystem(DtLocalObject* owner, 
      DtSimulationServices* simManager, 
      const DtComponentSystemDescriptor* desc,
      DtComponentSystem* parentSystem);

   virtual ~DtComponentSystem();

   virtual bool init();

   virtual bool initializeFromDescriptor(int& priority, bool remoteOnly);

   virtual bool postAddComponentsInit();

   virtual void tick();

   virtual DtString name() const;

   virtual DtString fullName() const;

   virtual DtString systemName() const;

   virtual DtString printName() const;

   virtual void setPrintName(const DtString& name);


   virtual DtSimComponentNetwork* componentNetwork();
   virtual const DtSimComponentNetwork* componentNetwork() const;

   virtual DtComponentSystem* lookupSystem(const DtString& printName);

   virtual DtComponentSystem* lookupSystemFromRwName(const DtString& rwName);

   virtual DtComponentSystem* lookupSystemFromFullName(const DtString& fullName);

   virtual void getSystemNames(std::list<std::string>& nameList) const;


   virtual DtVrfProcessStateRepositoryManager* processStateRepositoryManager();

   typedef std::list< std::pair<DtSimComponent*, DtString> > DtComponentPortList;

   

   virtual void resolveSystemOutput(const DtString& outputName, DtComponentPortList& componentOutputs);

   virtual void resolveSystemInput(const DtString& inputName, DtComponentPortList& componentInputs);




   virtual void enable();
   virtual void disable();

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

   virtual bool canBeDisabled() const;

   virtual bool addAttributeProviderFunction(const DtString & attributeName,
      genericAttributeProviderFunctionType attributeFunction,
      void* controller);

   virtual bool addAttributeSetFunction(const DtString& attributeName,
      genericAttributeSetterFunctionType attributeFunction,
      void* controller);

   virtual DtReaderWriter* getAttribute(const DtString& attributeName,
       bool& error) const;

   virtual bool setAttribute(const DtString& attributeName,
      DtReaderWriter* value);

   virtual std::list<std::string> getAllAttributeNames() const;

   virtual DtComponentSystemPSR* processStateRepository();

   virtual void updateImgui();

   mutable boost::signals2::signal<void ()> signal_destroyed;
protected:
   virtual bool createPsr();

   void removeCompatibilityPsrs();

   virtual void restore(DtSimComponentList*);

protected:
   const DtComponentSystemDescriptor* mySystemDescriptor;
   DtSimulationServices* mySimManager;
   DtLocalObject* myVrfObject;
   DtSimComponentNetwork* myComponentNetwork;
   DtComponentSystemPSR* myProcessStateRepository;
   DtComponentSystem* myParentSystem;

   DtString myPrintName;

   std::map<DtString, std::pair<genericAttributeProviderFunctionType, void*> > 
      myReadableAttributes;
   std::map<DtString, std::pair<genericAttributeSetterFunctionType, void*> > 
      myWritableAttributes;

   std::list< std::pair<DtString, DtVrfProcessStateRepositoryManager*> > 
      myAddedCompatibilityPsrs;

   DtPlatformLocalObjectFacade myPlatformLocalObjectFacade;
};

typedef std::list<DtComponentSystem*> DtComponentSystemList;