VR-Forces 4.0.4 Class Documentation: include/vrfobjparam/compSystemMetaData.h Source File

Go to the documentation of this file.
00001 /*******************************************************************************
00002 ** Copyright (c) 2007 MAK Technologies, Inc.
00003 ** All rights reserved.
00004 *******************************************************************************/
00005 /*******************************************************************************
00006 ** $RCSfile: compSystemMetaData.h,v $ $Revision: 1.3 $ $State: Exp $
00007 *******************************************************************************/
00008 
00011 
00013 
00014 #ifndef compSystemMetaData_h
00015 #define compSystemMetaData_h
00016 
00017 #include "vrfobjparam/vrfobjparamDefines.h"
00018 #include "vrfutil/rdrWritr.h"
00019 #include "vrfutil/rwString.h"
00020 #include "vrfutil/rwNLengthStringVector.h"
00021 #include "vrfobjparam/systemParameterDataList.h"
00022 #include "vrfobjparam/systemMetaDataEntryList.h"
00023 
00029 class DT_DLL_vrfobjparam DtComponentSystemMetaData : public DtReaderWriter
00030 {
00031 private:
00033    DtComponentSystemMetaData();
00034 
00035 public:
00036 
00038    DtComponentSystemMetaData(const DtString & name, 
00039       DtReaderWriterRegistry * parentRegistry = 0);
00040 
00042    DtComponentSystemMetaData(const DtComponentSystemMetaData & orig, 
00043       DtReaderWriterRegistry * parentRegistry = 0);
00044 
00046    const DtComponentSystemMetaData & operator=(const DtComponentSystemMetaData & 
00047       orig);
00048 
00050    virtual ~DtComponentSystemMetaData();
00051 
00053 
00054    virtual DtString systemName() const;
00055    virtual void setSystemName(const DtString& name);
00057 
00059 
00060    virtual DtString systemDescription() const;
00061    virtual void setSystemDescription(const DtString& desc);
00063 
00065 
00066    virtual const DtRwNLengthStringVector& allowedStateRepositoryTypes() const;
00067    virtual DtRwNLengthStringVector& allowedStateRepositoryTypes();
00069 
00071    virtual bool allowedForStateRepositoryType(const DtString& srTypeString) const;
00072 
00074 
00075    virtual const DtRwNLengthStringVector& systemCategories() const;
00076    virtual DtRwNLengthStringVector& systemCategories();
00078 
00080 
00081    virtual const DtSystemParameterDataList& paramterDataList() const;
00082    virtual DtSystemParameterDataList& paramterDataList();
00084 
00087 
00088    virtual const DtSystemMetaDataEntryList& metaDataEntryList() const;
00089    virtual DtSystemMetaDataEntryList& metaDataEntryList();
00091 
00094    virtual const DtSystemMetaDataEntry* lookupMetaDataEntry(const DtString& dataType) const;
00095 
00097    virtual bool inSystemCategory(const DtString& category) const;
00098 
00099 protected:
00101    DtRwString mySystemName;
00103    DtRwString mySystemDescription;
00106    DtRwNLengthStringVector myAllowedStateRepositoryTypes;
00108    DtRwNLengthStringVector mySystemCategories;
00109 
00111    DtSystemParameterDataList myParameterDataList;
00112 
00116    DtSystemMetaDataEntryList myMetaDataEntryList;
00117 };
00118 
00119 #endif