componentSystemMetaData.h

Go to the documentation of this file.

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



#pragma once

#include "vrfobjparam/vrfobjparamDefines.h"
#include "vrfutil/readerWriter.h"
#include "vrfutil/rwString.h"
#include "vrfutil/rwNLengthStringVector.h"
#include "vrfobjparam/systemParameterDataList.h"
#include "vrfobjparam/systemMetaDataEntryList.h"
#include "vrfutil/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();


   virtual DtString systemName() const;
   virtual void setSystemName(const DtString& 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& paramterDataList() const;
   virtual DtSystemParameterDataList& paramterDataList();


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

   virtual const 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;

protected:

   DtRwString mySystemName;

   DtRwString mySystemDescription;
   DtRwNLengthStringVector myAllowedStateRepositoryTypes;

   DtRwNLengthStringVector mySystemCategories;

   DtSystemParameterDataList myParameterDataList;

   DtSystemMetaDataEntryList myMetaDataEntryList;

   DtRwStringAttributeList myAttributeList;
};