FxBIMProperty.h

Go to the documentation of this file.

//
// (C) Copyright 2020-2025 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted, 
// provided that the above copyright notice appears in all copies and 
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting 
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS. 
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH 
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#pragma once
 
#include "FxBIM.h"
 
class CFxBIMPropertyImpl;
class CFxBIMProperty;
typedef std::shared_ptr< CFxBIMProperty > CFxBIMPropertyPtr;
 
#include <RxVariant.h>
#include <DbObjectId.h>
 
#include <vector>
 
enum class PropertyType : OdInt8
{
    eDimensionless = 5,
 
    eLength = 1,
    eArea = 2,
    eVolume = 3,
 
    eCount = 6,
    eWeight = 7,
    eTime = 8,
};
 
class FXBIM_COMMON_CODE_API CFxBIMProperty : public CFxBIMObject
{
    friend class CFxBIMPropertyImpl;
public:
    virtual ~CFxBIMProperty();
 
    static CFxBIMPropertyPtr Create( OdDbDatabase* pDb,
                                     const OdString& group,
                                     const OdString& label,
                                     const OdVariant& value,
                                     const PropertyType type = PropertyType::eDimensionless );
    
    static CFxBIMPropertyPtr Create( OdDbDatabase* pDb,
                                     const OdString& group,
                                     const OdString& label,
                                     const OdVariant& value,
                                     const bool bReadOnly,
                                     const PropertyType type = PropertyType::eDimensionless );
 
public:
    static OdString ToString( const OdVariant& value );
 
    OdString Group() const;
    OdString Label() const;
 
    OdVariant Value() const;
    void SetValue( const OdVariant& value );
 
    const PropertyType& PropertyTypeValue() const;
 
    OdString Description() const;
    void SetDescription( const OdString& description );
 
    bool IsReadOnly() const;
 
protected:
    CFxBIMProperty();
 
protected:
    std::shared_ptr< CFxBIMPropertyImpl > m_pImpl;
};
 
class FXBIM_API CFxBIMPropertiesContainter
{
public:
    virtual ~CFxBIMPropertiesContainter() = default;
    virtual OdDbObjectId OwnerId() const = 0;
    virtual std::vector< CFxBIMPropertyPtr >& Properties() = 0;
    virtual std::map< OdString, CFxBIMPropertyPtr >& DerivedProperties() = 0;
 
    virtual OdVariant Property( const OdString& group, const OdString& label ) const = 0;
    virtual CFxBIMPropertyPtr GetProperty( const OdString& group, const OdString& label ) const = 0;
 
protected:
    CFxBIMPropertiesContainter() = default;
};