simComponentManager.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2014 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: compMgr.h,v $ $Revision: 1.27 $ $State: Exp $
*******************************************************************************/



#ifndef DtSimComponentManager_H_
#define DtSimComponentManager_H_

#include "vrfobjcore/vrfObject.h"
#include "vrfobjcore/simComponentManagerFactory.h"
#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfobjcore/componentSystem.h"
#include <vrftasks/vrfObjectMessageTypeTemplate.h>

class DtSimComponent;
class DtSimComponentList;
class DtControllerComponentList;
class DtComponentDescriptorList;
class DtConnectionDescriptorList;
class DtPortConnection;
class DtPortGroupConnection;
class DtSimComponentNetwork;
class DtComponentSystemDescriptor;
class DtCriticalSection;
class DtSystemListRequestAdmin;
class DtSimMessage;

class DT_DLL_vrfobjcore DtSimComponentManager
{
private:

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

public:

   DtSimComponentManager(DtVrfObject * vrfObject);

   virtual ~DtSimComponentManager();

   virtual bool init();

   virtual void tick();

   virtual DtVrfObject * vrfObject() const;

   virtual bool addComponents();

   virtual bool addSensorComponent(DtSimComponent * component);
   virtual bool addControllerComponent(DtSimComponent * component);
   virtual bool addActuatorComponent(DtSimComponent * component);

   virtual bool removeSensorComponent(DtSimComponent * component);
   virtual bool removeControllerComponent(DtSimComponent * component);
   virtual bool removeActuatorComponent(DtSimComponent * component);

   virtual bool hasComponents() const;

   virtual std::list<DtSimComponent*> lookupComponentsByType(const DtString& typeString) const;

   virtual DtSimComponent * lookupComponent(const DtString& name) const;

   virtual DtComponentSystem* lookupSystem(const std::string& printName);
   virtual const DtComponentSystem* lookupSystem(const std::string& printName) const;

   virtual DtComponentSystem* lookupSystemFromFullName(const std::string& fullName);


   virtual void setAllSystemEnabled(bool enableDisable);

   virtual void setSystemEnabled(const std::string& systemName, bool enableDisable, bool sendSystemUpdate);

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

   virtual DtString systemCategory(DtString& systemName) const;

   virtual DtSimComponentList * sensorComponentList() const;
   virtual DtControllerComponentList * controllerComponentList() const;
   virtual DtSimComponentList * actuatorComponentList() const;


   virtual DtComponentSystem* baseSystem();
   virtual const DtComponentSystem* baseSystem() const;

   virtual DtString type() const;

   virtual DtList* connectionList();
   virtual DtList* groupConnectionList();

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

   static void addSimComponentManagerCreatorFcn(const DtString & type, 
      DtSimComponentManagerCreatorFcn fcn);

   static DtSimComponentManager * creator(DtVrfObject * vrfObject);

   static DtSimComponentManager * createComponentManager(const DtString & type, 
      DtVrfObject * vrfObject);

   virtual void allSystems(DtComponentSystemList&) const;

   virtual bool hasSystemThatCanBeDisabled();


   static void systemListRequestCallback(const DtVrfObjectMessage* msg, void* usr);
   virtual void processSystemListRequest(const DtVrfObjectMessage* msg);


   static void genericSetRwRequestCallback(const DtVrfObjectMessage* msg, void* usr);
   virtual void processGenericSetRwRequest(const DtVrfObjectMessage* msg);

   static void notifySetDataSubscriberCallback(DtSimMessage * msg, void * usr);
   virtual void notifySetDataSubscriber(DtSimMessage * msg);
   virtual void sendGenericSetRwStateSubscribersUpdate(const DtSetMessageType& type, const DtUUID& uuid = DtUUID::nullUUID());

   virtual void sendSystemStateUpdated(const std::vector<DtComponentSystem*>& system);
   virtual void sendSystemStateUpdated(DtComponentSystem* system);
protected:
   virtual void allSystems(DtComponentSystemList&, DtComponentSystem*) const;


protected:
   DtVrfObject * myVrfObject;
   DtComponentSystem* myComponentSystem;

   DtList myConnectionList;
   DtList myGroupConnectionList;
   std::set<DtUUID> mySystemStateSubscribers;
   std::map< DtString, std::set< DtUUID > > myGenericSetRwStateSubscribers;
   static DtSimComponentManagerFactory *   theFactory;
};

#endif