AECPropertyDef.h

Go to the documentation of this file.

// Copyright (C) 2002-2017, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2017 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef __AECPROPERTYDEF_H__
#define __AECPROPERTYDEF_H__
 
#include "Subobjects/AECUnitType.h"
#include "Common/AECQueryInfo.h"
#include "Common/AECVariant.h"
 
class AECSCHEDULEDATA_API AECPropertyDef : public AECImpObj
{
    AEC_DECLARE_MEMBERS( AECPropertyDef );
 
    public:
        enum Type
        {
            eInteger       = 0,
            eReal          = 1,
            eText          = 2,
            eBool          = 3,
            eAutoIncrement = 4,
            eCharIncrement = 5,
            eList          = 6,
            eGraphics      = 7
        };
 
        // Common property definition flags
        // structure.
 
    public:
        OdUInt32 GetIndex() const;
 
        void SetIndex( OdUInt32 iIndex );
 
        const OdString& GetName() const;
 
        void SetName( const OdString& strName );
 
        const OdString& GetGlobalName() const;
 
        void SetGlobalName(const OdString& gname);
 
        Type GetType() const;
 
        void SetType( Type eType );
 
        bool IsAutomatic() const;
 
        void SetIsAutomatic( bool bIsAutomatic );
 
        OdUInt32 GetQueryInfoCount() const;
 
        const AECQueryInfo& GetQueryInfoByIndex( OdUInt32 iIndex ) const;
 
        void AddQueryInfo( const AECQueryInfo& cQueryInfo );
 
        void AddQueryInfo( OdRxClass* pDesc, const OdString& strPropertyName );
 
        void RemoveQueryInfoByIndex( OdUInt32 iIndex );
 
        void ClearQueryInfos();
 
        OdDbObjectId GetDataFormat() const;
 
        void SetDataFormat( OdDbObjectId idDataFormat );
 
        const AECVariant& GetDefaultValue() const;
 
        void SetDefaultValue( const AECVariant& vtValue );
 
        AECVariant GetInitialValue() const;
 
        bool GetUseNameAsDesctiption() const;
 
        void SetUseNameAsDesctiption( bool bUseNameAsDesctiption );
 
        bool IsReadOnly() const;
 
        void SetReadOnly( bool bReadOnly );
 
        bool IsVisible() const;
 
        void SetVisible( bool bVisible );
 
        bool IsLocked() const;
 
        void SetLocked( bool bLocked );
 
        OdUInt32 GetOrder() const;
 
        void SetOrder( OdUInt32 iOrder );
 
        bool IsAppliedTo( const OdString& strClassName, AECQueryInfo* rQueryInfo ) const;
 
        bool IsDefaultUnspecified() const;
 
        void SetDefaultIsUnspecified( bool bUnspec );
    protected:
        //
        OdUInt32 m_iIndex;
 
        //
        OdString m_strName;
 
        //
        Type m_eType;
 
        //
        bool m_bAutomatic;
 
        //
        std::vector<AECQueryInfo> m_aQueryInformation;
 
        //
        OdDbHardPointerId m_hpidScheduleDataFormat;
 
        //
        AECVariant m_vDefaultValue;
 
        //
        bool m_bDefIsUnspecified;
 
        //
        AECUnitType m_unitType;
 
        //
        OdDbHardPointerId m_hpidList;
        OdDbHardPointerId m_hpidListItem;
 
        //
        OdString m_sGlobalName;
 
        enum Flags
        {
            kLocked     = 1,
            kVisible    = 2,
            kReadOnly   = 4,
        };
        OdUInt8 m_flags;
 
        //
        OdUInt32 m_iOrder;
 
        // Dev.note: Serialized in derived classes
        OdUInt8 m_flags2;
 
        // For internal use.
        bool m_bAppended;
};
 
typedef OdSmartPtr<AECPropertyDef> AECPropertyDefPtr;
typedef AECSubPtr<AECPropertyDef> AECPropertyDefSubPtr;
 
#endif // __AECPROPERTYDEF_H__