dtk_metadata.hpp

Go to the documentation of this file.

#ifndef __DTK_METADATA_HPP__
#define __DTK_METADATA_HPP__
 
#include "util/BaseTypes/dtk_string.hpp"
#include "util/BaseTypes/dtk_object.hpp"
#include "def/define.h" 
#include "util/error_dtk.hpp"
 
class Dtk_Properties;
typedef Dtk_SmartPtr<Dtk_Properties>            Dtk_PropertiesPtr;
class Dtk_MetaData;
typedef Dtk_SmartPtr<Dtk_MetaData>                Dtk_MetaDataPtr;
 
class Dtk_MetaData : public Dtk_Object
{
public:
    enum MetaDataTypeEnum
    {
        TypeUnknown         = 0,
          TypeProperty,
          TypeFileProperty,
          TypeConfigurationProperty,
          TypeSheetMetal,
          TypeParameter,
          TypeMassProperty,
        TypeElectricalProperty,
        TypeAttributeSet,
          TypeUserAttribute,
          TypeUserExpression
     };
    static inline Dtk_string MetaDataTypeEnumToString(const MetaDataTypeEnum& inEnum)
    {
        switch( inEnum )
        {
          case TypeProperty:                 return L"TypeProperty";
          case TypeFileProperty:             return L"TypeFileProperty";
          case TypeConfigurationProperty:    return L"TypeConfigurationProperty";
          case TypeSheetMetal:               return L"TypeSheetMetal";
          case TypeParameter:                return L"TypeParameter";
          case TypeMassProperty:             return L"TypeMassProperty";
          case TypeElectricalProperty:       return L"TypeElectricalProperty";
        case TypeAttributeSet:             return L"TypeAttributeSet";
          case TypeUserAttribute:            return L"TypeUserAttribute";
          case TypeUserExpression:           return L"TypeUserExpression";
        default:                            
        case TypeUnknown:                  return L"Unknown";
        }
    }
protected:
    enum { _typeID = DTK_TYPE_METADATA }; 
    struct Dtk_Handle;
    Dtk_Handle *_Private;
 
    Dtk_MetaData(const Dtk_MetaData& inToBeCopied);
    Dtk_MetaData( Dtk_MetaData&& inToBeMoved) DTK_NOEXCEPT;
    
    Dtk_MetaData(const MetaDataTypeEnum& inType);
   
    virtual ~Dtk_MetaData();
    friend class Dtk_SmartPtr<Dtk_MetaData>;
 
    void _Init();
    void _Copy(const Dtk_MetaData& inToBeCopied);
    void _Reset();
 
 
public:
    static Dtk_MetaDataPtr CreatePropertiesMetaData(const Dtk_PropertiesPtr& inObject);
//   //! \brief Create a parameter Dtk_MetaDataPtr from a Dtk_PropertiesPtr.
//   //! \param inObject Parameter data.
//   //! \return the constructed Dtk_MetaDataPtr.
//   static Dtk_MetaDataPtr CreateParameterMetaData(const Dtk_PropertiesPtr& inObject);
 
    static Dtk_MetaDataPtr CreateMetaData(const MetaDataTypeEnum &inEnumType, Dtk_string inTitle, Dtk_string inValue, Dtk_string inValueType = Dtk_string(L"STRING"));
    static Dtk_MetaDataPtr CreateMetaDataWithUnits(const MetaDataTypeEnum &inEnumType, Dtk_string inTitle, Dtk_string inValue, Dtk_string inUnits, Dtk_string inValueType = Dtk_string(L"STRING"));
 
    inline Dtk_Int32 DtkDynamicType(const Dtk_Int32 &inId)
    { 
        if (inId == _typeID) return 1; 
        return Dtk_Object::DtkDynamicType(inId); 
    }
    
    inline static Dtk_MetaData* DtkDynamicCast(Dtk_Object *s)
    { 
        if (s->DtkDynamicType(_typeID)) return static_cast<Dtk_MetaData*>(s); 
        return NULL; 
    } 
 
    Dtk_PropertiesPtr ToProperty();
 
    Dtk_PropertiesPtr ToParameter();
 
    Dtk_PropertiesPtr ToMassProperty();
 
    Dtk_PropertiesPtr ToElectricalProperty();
 
    Dtk_PropertiesPtr ToUserAttribute();
 
     Dtk_PropertiesPtr ToUserExpression();
 
//DTK_TOREMOVE_START
#ifdef AF51BDA7E49648f8AB95949F4CA52EF8
     Dtk_PropertiesPtr ToSheetMetal();
#endif
//DTK_TOREMOVE_END
     Dtk_PropertiesPtr ToFileProperty();
     Dtk_PropertiesPtr ToConfigurationProperty();
    const MetaDataTypeEnum& MetaDataType() const;
     void SetMetaDataType( const MetaDataTypeEnum& inType );
 
     SetAsDeprecated("2022.1", "Use GetUnits(Dtk_string& outUnits) method instead.")
     Dtk_string GetUnits() const;
 
     Dtk_ErrorStatus GetUnits( Dtk_string& outUnits ) const;
 
     const Dtk_string& GetType() const;
 
     void SetType( Dtk_string in) ;
 
     const Dtk_string& GetTitle() const;
     void SetTitle( Dtk_string in) ;
 
     const Dtk_string& GetValue() const;
     void SetValue( Dtk_string in) ;
 
 
     const Dtk_string& GetCategory() const;
     void SetCategory( Dtk_string in) ;
 
 
 
 
     Dtk_ErrorStatus GetFormula(Dtk_string& outFormula,Dtk_string& outEstimatedValue,Dtk_string& outTitle,Dtk_string& outResultType) ;
 
     Dtk_string GetFormula(Dtk_string& outEstimatedValue) ;
 
     void SetFormula( Dtk_string inFormula, Dtk_string inEstimatedValue, Dtk_string inTitle, Dtk_string inResultType);
 
 
     Dtk_bool IsReal() const;
     Dtk_bool IsInteger() const;
     Dtk_bool IsBoolean() const;
     Dtk_bool IsFormula() const;
     Dtk_bool IsReference() const;
     Dtk_bool IsDate() const;
     Dtk_bool IsString() const;
     Dtk_bool IsNull() const;
};
 
struct Dtk_MetaData::Dtk_Handle
{
    MetaDataTypeEnum        _MetaDataType;
 
     Dtk_string                    _Type;
     Dtk_string                    _Title;
     Dtk_string                    _Value;
     Dtk_string                    _Category;
 
};
 
class Dtk_MetaDataWithUnit;
 
typedef Dtk_SmartPtr<Dtk_MetaDataWithUnit> Dtk_MetaDataWithUnitPtr;
 
class Dtk_MetaDataWithUnit : public Dtk_MetaData
{
private:
     void _Init();
     void _Reset();
     friend class Dtk_SmartPtr<Dtk_MetaDataWithUnit>;
 
protected :
     enum { _typeID = DTK_TYPE_METADATAWITHUNIT }; 
     Dtk_string          _Units;
 
 
public:
     Dtk_string GetUnits();
     Dtk_MetaDataWithUnit(const MetaDataTypeEnum &inEnumType, Dtk_string inType, Dtk_string inTitle, Dtk_string inValue, Dtk_string inUnit);
     virtual ~Dtk_MetaDataWithUnit();
 
     inline Dtk_Int32 DtkDynamicType(const Dtk_Int32 &inId)
     { 
          if (inId == _typeID) return 1; 
          return Dtk_MetaData::DtkDynamicType(inId); 
     }
 
     inline static Dtk_MetaDataWithUnit* DtkDynamicCast(Dtk_Object *s)
     { 
          if (s->DtkDynamicType(_typeID)) return static_cast<Dtk_MetaDataWithUnit*>(s); 
          return NULL; 
     } 
};
 
class Dtk_MetaDataGroup;
 
typedef Dtk_SmartPtr<Dtk_MetaDataGroup> Dtk_MetaDataGroupPtr;
 
class Dtk_MetaDataGroup : public Dtk_Object
{
protected :
     enum { _typeID = DTK_TYPE_METADATA_GROUP };
private:
     Dtk_string _GroupName;
 
     Dtk_tab< Dtk_MetaDataPtr > _MetadataChildren;
 
     void _Init();
     void _Reset();
 
     friend class Dtk_SmartPtr<Dtk_MetaDataGroup>;
 
public:
 
     Dtk_MetaDataGroup( Dtk_string inGroupName);
 
     virtual ~Dtk_MetaDataGroup();
 
     inline Dtk_Int32 DtkDynamicType(const Dtk_Int32 &inId)
     {
          if( inId == _typeID ) return 1;
          return Dtk_MetaDataGroup::DtkDynamicType(inId);
     }
 
     inline static Dtk_MetaDataGroup* DtkDynamicCast(Dtk_Object *s)
     {
          if( s->DtkDynamicType(_typeID) ) return static_cast<Dtk_MetaDataGroup*>( s );
          return NULL;
     }
 
     static Dtk_MetaDataGroupPtr CreateMetaDataGroup( Dtk_string inGroupName, Dtk_tab< Dtk_MetaDataPtr > inMetadataChildren = Dtk_tab<Dtk_MetaDataPtr>());
 
     const Dtk_tab< Dtk_MetaDataPtr >& GetListOfMetadatas() const;
     
     void AddMetadata(Dtk_MetaDataPtr inChild);
 
     void SetName( Dtk_string inGroupName);
 
     const Dtk_string GetGroupName();
 
     const Dtk_Size_t GetNumMetaData() const;
     
     Dtk_MetaDataPtr GetMetaData(const Dtk_Size_t& inPos);
};
 
class Dtk_Properties : public Dtk_Object
{
public:
 
     Dtk_Properties(const Dtk_Properties& p);
     Dtk_Properties& operator=(const Dtk_Properties& p);
 
 
 
     const Dtk_string& GetType() const;
 
     void SetType( Dtk_string in) ;
 
     const Dtk_string& GetTitle() const;
 
     void SetTitle( Dtk_string) ;
 
     const Dtk_string& GetValue() const;
 
     void SetValue( Dtk_string) ;
 
 
     Dtk_ErrorStatus GetFormula(Dtk_string& outFormula,Dtk_string& outEstimatedValue,Dtk_string& outTitle,Dtk_string& outResultType) ;
 
     Dtk_string GetFormula(Dtk_string& outEstimatedValue) ;
     void SetFormula( Dtk_string inFormula, Dtk_string inEstimatedValue, Dtk_string inTitle, Dtk_string inResultType);
 
 
     static Dtk_PropertiesPtr create();
     virtual void conv_ptr(Dtk_Properties ** s){*s = this;}
     int DtkDynamicType(const int& inId);
     static Dtk_Properties* DtkDynamicCast(Dtk_Object * s);
 
     void SetAsReal();
     void SetAsInteger();
     void SetAsBoolean();
 
     Dtk_bool IsReal() const;
     Dtk_bool IsInteger() const;
     Dtk_bool IsBoolean() const;
     Dtk_bool IsFormula() const;
     Dtk_bool IsReference() const;
     Dtk_bool IsDate() const;
     Dtk_bool IsString() const;
     Dtk_bool IsNull() const;
 
protected:
     struct Dtk_Handle;
     Dtk_Handle *_Private;
     Dtk_Properties();
     virtual ~Dtk_Properties();
 
     void _Init();
     void _copy(const Dtk_Properties& s);
     void _reset();
     friend class Dtk_SmartPtr<Dtk_Properties>;
 
};
 
 
#endif