AECPropertyExtensionBase.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 __AECPROPERTYEXTENSIONBASE_H__
#define __AECPROPERTYEXTENSIONBASE_H__
 
#include "AECBase.h"
#include "DbObject/AECDbPropertySet.h"
#include "Common/AECVariant.h"
#include "Common/AECQueryInfo.h"
#include "Common/AECSmartReference.h"
#include <DbObject.h>
 
class AECSCHEDULEDATA_API AECPropertyExtensionBase : public OdRxObject
{
    ODRX_DECLARE_MEMBERS( AECPropertyExtensionBase );
 
    public:
        static void GetPropertyNames( OdRxClass* pDesc,
            std::vector<OdString>& aNames );
 
        static void GetQueryInfos( OdRxClass* pDesc,
            std::vector<AECQueryInfo>& aQueryInfos );
 
        static bool GetQueryInfoByPropertyName( OdRxClass* pDesc,
            const OdString& strName, AECQueryInfo& cQueryInfo );
 
        static bool GetQueryInfoByPropertyIndex( OdRxClass* pDesc,
            OdUInt32 iIndex, AECQueryInfo& cQueryInfo );
 
        static OdDbObjectId GetPropertySet( OdDbObject* pObject,
            const OdDbObjectId& idPropertySetDef, bool bCreateIfNotFound = false );
 
        static void RemovePropertySet( OdDbObject* pObject,
            const OdDbObjectId& idPropertySetDef );
 
        static OdDbObjectId GetReferencePropertySet( const OdDbObjectId& idReference, const AECSmartReference& rRef,
            const OdDbObjectId& idPropertySetDef, bool bCreateIfNotFound = false );
 
        static void RemoveReferencePropertySet( const OdDbObjectId& idReference, const AECSmartReference& rRef,
            const OdDbObjectId& idPropertySetDef );
 
        virtual AECVariant GetAutomaticProperty( OdDbObject* pObject,
            const OdString& strPropertyName, const OdDbObjectId& idDataFormat = OdDbObjectId::kNull ) = 0;
 
        AECVariant GetProperty( OdDbObject* pObject, const OdDbObjectId& idPropertySetDef,
            OdUInt32 iPropertyIndex, const OdDbObjectId& idDataFormat = OdDbObjectId::kNull,
            AECVariant* pRawValue = 0 );
 
        AECVariant GetProperty( OdDbObject* pObject, const OdDbObjectId& idPropertySetDef,
            const OdString& strPropertyName, const OdDbObjectId& idDataFormat = OdDbObjectId::kNull,
            AECVariant* pRawValue = 0 );
 
        AECVariant GetProperty( OdDbObject* pObject, AECPropertyDefPtr pPropertyDef,
          const OdDbObjectId& idDataFormat = OdDbObjectId::kNull, AECVariant* pRawValue = 0 );
 
        static AECVariant GetReferenceProperty( const OdDbObjectId& idReference, const AECSmartReference& rRef,
            const OdDbObjectId& idPropertySetDef, OdUInt32 iPropertyIndex, 
            const OdDbObjectId& idDataFormat = OdDbObjectId::kNull,
            AECVariant* pRawValue = 0 );
 
        static AECVariant GetReferenceProperty( const OdDbObjectId& idReference, const AECSmartReference& rRef,
            const OdDbObjectId& idPropertySetDef, const OdString& strPropertyName, 
            const OdDbObjectId& idDataFormat = OdDbObjectId::kNull,
            AECVariant* pRawValue = 0 );
 
        static OdDbObjectId GetPropertySetOverrideContainer(
            const OdDbObjectId& idReference, bool bCreateIfNotFound = false );
};
 
typedef OdSmartPtr<AECPropertyExtensionBase> AECPropertyExtensionBasePtr;
 
#endif //__AECPROPERTYEXTENSIONBASE_H__