componentSystemDefinition.h

Go to the documentation of this file.

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



#pragma once

#include "vrfobjparam/vrfobjparamDefines.h"
#include <readerWriter/readerWriter.h>
#include "vrfobjparam/componentDescriptorList.h"
#include "vrfobjparam/connectionDescriptorList.h"
#include "vrfobjparam/componentSystemDescriptorList.h"
#include "vrfobjparam/componentSystemMetaData.h"
#include "vrfobjparam/connectionDescriptor.h"
#include "vrfutil/rwStringList.h"
#include "vrfutil/simResource.h"
#include <vrfutil/simResourceManager.h>

class DT_DLL_vrfobjparam DtComponentSystemDefinition : public DtReaderWriter
{
private:
   DtComponentSystemDefinition();

public:
   typedef DtComponentSystemDefinition* (*ComponentSystemDefinitionCreatorFcn)(const DtString&, DtReaderWriterRegistry* parentRegistry);

   DtComponentSystemDefinition(const DtString & name, 
      DtReaderWriterRegistry * parentRegistry = 0);

   DtComponentSystemDefinition(const DtComponentSystemDefinition & orig, 
      DtReaderWriterRegistry * parentRegistry = 0);

   virtual const DtComponentSystemDefinition & operator=(const DtComponentSystemDefinition & 
      orig);

   virtual ~DtComponentSystemDefinition() override;


   virtual const DtComponentSystemDescriptorList& systemDescriptorList() const;
   virtual void setSystemDescriptorList(const DtComponentSystemDescriptorList& list);


   virtual const DtComponentDescriptorList& sensorDescriptorList() const;
   virtual DtComponentDescriptorList& sensorDescriptorList();
   virtual void setSensorDescriptorList(const DtComponentDescriptorList& list);


   virtual const DtComponentDescriptorList& controllerDescriptorList() const;
   virtual DtComponentDescriptorList& controllerDescriptorList();
   virtual void setControllerDescriptorList(const DtComponentDescriptorList& 
      list);


   virtual const DtComponentDescriptorList& actuatorDescriptorList() const;
   virtual DtComponentDescriptorList& actuatorDescriptorList();
   virtual void setActuatorDescriptorList(const DtComponentDescriptorList& 
      list);


   virtual const DtConnectionDescriptorList& connectionDescriptorList() const;
   virtual DtConnectionDescriptorList& connectionDescriptorList();
   virtual void setConnectionDescriptorList(const DtConnectionDescriptorList& 
      list);


   virtual const DtComponentSystemMetaData& metaData(bool merged = false) const;

   virtual DtComponentSystemMetaData& metaData(bool merged = false);


   virtual const DtSimResourceManager& resourceDefaults() const;
   virtual DtSimResourceManager& resourceDefaults();

   virtual DtSimResourceManager providedResourceDefaults() const;


   virtual const DtRwStringList& compatibilityPsrNames() const;
   virtual DtRwStringList& compatibilityPsrNames();

   bool operator==(const DtComponentSystemDefinition&) const;
   bool operator!=(const DtComponentSystemDefinition& rhs) const
   {
      return !(*this == rhs);
   }

   virtual void postGetSelf() override;

   virtual bool hasComponentByDescriptorType(const DtString&) const;

   virtual bool hasComponentByComponentType(const DtString&) const;
   

   virtual bool canBeDisabled() const;
   virtual bool canBeDisabledSpecified() const;
   virtual void setCanBeDisabled(bool yesNo);


   virtual bool isTemplate() const;
   virtual void setIsTemplate(bool yesNo);

   static ComponentSystemDefinitionCreatorFcn SetCreator(ComponentSystemDefinitionCreatorFcn);
   static DtComponentSystemDefinition* Create(const DtString& systemName, DtReaderWriterRegistry* parent);

protected:
   virtual bool hasComponentByDescriptorType(const DtRwList&, const DtString&) const;

   virtual bool hasComponentByComponentType(const DtRwList&, const DtString&) const;

protected:
   DtComponentSystemDescriptorList mySystemDescriptorList;
   DtComponentDescriptorList mySensorDescriptorList;
   DtComponentDescriptorList myControllerDescriptorList;
   DtComponentDescriptorList myActuatorDescriptorList;
   DtConnectionDescriptorList myConnectionDescriptorList;
   DtComponentSystemMetaData myMetaData;
   DtComponentSystemMetaData myMergedMetaData;
   DtRwStringList myCompatibilityPsrNames;
   DtRwBoolean myCanBeDisabled;
   DtRwBoolean myIsTemplate;

   static ComponentSystemDefinitionCreatorFcn theCreator;

   DtSimResourceManager myResourceDefaults;
};