componentSystemMetaData.h

Go to the documentation of this file.

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



#pragma once

#include "vrfobjparam/vrfobjparamDefines.h"
#include <readerWriter/readerWriter.h>
#include <readerWriter/rwString.h>
#include "vrfutil/rwNLengthStringVector.h"
#include "vrfobjparam/systemParameterDataList.h"
#include "vrfobjparam/systemMetaDataEntryList.h"
#include <readerWriter/rwStringAttributeList.h>

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

public:

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

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

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

   virtual ~DtComponentSystemMetaData() override;


   virtual DtString systemName() const;
   virtual void setSystemName(const DtString& name);


   virtual const DtString& uiFilename() const;
   virtual void setUiFilename(const DtString& name);


   virtual const DtString& promotedFrom() const;
   virtual void setPromotedFrom(const DtString& name);


   virtual const DtRwNLengthStringVector& onlySupportsHealthChecks() const;
   virtual void setOnlySupportsHealthChecks(const DtRwNLengthStringVector& name);


   virtual DtString systemDescription() const;
   virtual void setSystemDescription(const DtString& desc);


   virtual const DtRwNLengthStringVector& allowedStateRepositoryTypes() const;
   virtual DtRwNLengthStringVector& allowedStateRepositoryTypes();

   virtual bool allowedForStateRepositoryType(const DtString& srTypeString) const;


   virtual const DtRwNLengthStringVector& systemCategories() const;
   virtual DtRwNLengthStringVector& systemCategories();


   virtual const DtSystemParameterDataList& parameterDataList() const;
   virtual DtSystemParameterDataList& parameterDataList();


   virtual bool mergeWithSubSystems() const;
   virtual void setMergeWithSubSystems(bool);


   virtual const DtSystemMetaDataEntryList& metaDataEntryList() const;
   virtual DtSystemMetaDataEntryList& metaDataEntryList();


   virtual const DtRwNLengthStringVector& deprecatedVariableBindings() const;
   virtual DtRwNLengthStringVector& deprecatedVariableBindings();


   virtual const DtRwNLengthStringVector& additionalData() const;
   virtual DtRwNLengthStringVector& additionalData();

   virtual std::map<DtString, DtString> attributeList() const;

   virtual const DtSystemMetaDataEntry* lookupMetaDataEntry(const DtString& dataType) const;

   virtual bool inSystemCategory(const DtString& category) const;

   bool operator==(const DtComponentSystemMetaData&) const;

   virtual void merge(const DtComponentSystemMetaData&);

   virtual bool canCheckHealthOf(const DtString&) const;

   virtual void mergeAllowedStateRepositoryTypes(const DtRwNLengthStringVector&);
   virtual void mergeSystemCategories(const DtRwNLengthStringVector&);
   virtual void mergeOnlySupportsHealthChecks(const DtRwNLengthStringVector&);
   virtual void mergeParameterDataList(const DtSystemParameterDataList&);
   virtual void mergeMetaDataEntryList(const DtSystemMetaDataEntryList&);
   virtual void mergeAttributeList(const std::map<DtString, DtString>&);
   virtual void mergeDeprecatedVariableBindings(const DtRwNLengthStringVector&);
   virtual void mergeAdditionalData(const DtRwNLengthStringVector&);

protected:

   DtRwString mySystemName;

   DtRwString mySystemDescription;

   DtRwNLengthStringVector myAllowedStateRepositoryTypes;

   DtRwNLengthStringVector mySystemCategories;

   DtSystemParameterDataList myParameterDataList;

   DtSystemMetaDataEntryList myMetaDataEntryList;

   DtRwStringAttributeList myAttributeList;

   DtRwString myUiFilename;

   DtRwString myPromotedFrom;

   DtRwBoolean myMergeWithSubSystems;

   DtRwNLengthStringVector myOnlySupportsHealthChecks;

   DtRwNLengthStringVector myDeprecatedVariableBindings;

   DtRwNLengthStringVector myAdditionalData;
};