CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Types | Protected Attributes | List of all members
AECPropertyDef Class Reference

#include <AECPropertyDef.h>

Inheritance diagram for AECPropertyDef:
AECImpObj OdRxObjectImpl< OdRxObject, AECImpObj > OdRxObject AECPropertyDefAnchor AECPropertyDefClassification AECPropertyDefFormula AECPropertyDefGraphic AECPropertyDefLocation AECPropertyDefMaterial AECPropertyDefProject

Public Types

enum  Type {
  eInteger = 0 , eReal = 1 , eText = 2 , eBool = 3 ,
  eAutoIncrement = 4 , eCharIncrement = 5 , eList = 6 , eGraphics = 7
}
 

Public Member Functions

OdUInt32 GetIndex () const
 DOM.
 
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)
 
- Public Member Functions inherited from AECImpObj
const OdString & GetDescription () const
 
void SetDescription (const OdString &strDescription)
 
virtual void onObjectLoaded ()
 
virtual void SubClose ()
 DOM.
 
OdRxObject * GetOwner () const
 
OdRxObject * GetOwner (OdRxClass *pClass) const
 
void addRefSubPtr ()
 
void releaseSubPtr ()
 
void assertReadEnabled () const
 
void assertWriteEnabled (bool autoUndo=true, bool recordModified=true)
 
bool isReadEnabled () const
 
bool isWriteEnabled () const
 
OdDbDatabase * database () const
 
void copyFrom (const OdRxObject *pOther)
 
virtual OdUInt16 minSupportedVersion () const
 
void SetOwner (OdDbObject *pOwner)
 DOM.
 
void SetOwner (AECImpObj *pOwner)
 DOM.
 
class AECSIBase * GetImpl () const
 DOM.
 
virtual OdResult dwgInFieldsEx20 (AECDbDwgFiler *pFiler)
 DOM.
 
virtual OdResult dwgInFieldsEx1 (AECDbDwgFiler *pFiler)
 DOM.
 
- Public Member Functions inherited from OdRxObjectImpl< OdRxObject, AECImpObj >
 OdRxObjectImpl ()
 
void addRef ()
 
void release ()
 
long numRefs () const
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObject * queryX (const OdRxClass *pClass) const
 
virtual OdRxObject * x (const OdRxClass *pClass) const
 
virtual OdRxClass * isA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Protected Types

enum  Flags { kLocked = 1 , kVisible = 2 , kReadOnly = 4 }
 

Protected Attributes

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
 
OdUInt8 m_flags
 
OdUInt32 m_iOrder
 
OdUInt8 m_flags2
 
bool m_bAppended
 
- Protected Attributes inherited from AECImpObj
class AECSIBase * m_pImp
 DOM.
 
OdUInt16 m_iMinSupportedVersion
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObjectImpl< OdRxObject, AECImpObj >
static OdSmartPtr< AECImpObj > createObject ()
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClass * desc ()
 
- Protected Member Functions inherited from OdRxObjectImpl< OdRxObject, AECImpObj >
 ODRX_HEAP_OPERATORS ()
 

Detailed Description

AEC Property Definition.

<group TA_API_Subobjects_Property>

Definition at line 36 of file AECPropertyDef.h.

Member Enumeration Documentation

◆ Flags

enum AECPropertyDef::Flags
protected
Enumerator
kLocked 
kVisible 
kReadOnly 

Definition at line 282 of file AECPropertyDef.h.

◆ Type

enum AECPropertyDef::Type

Property type.

Enumerator
eInteger 
eReal 
eText 
eBool 
eAutoIncrement 
eCharIncrement 
eList 
eGraphics 

Definition at line 44 of file AECPropertyDef.h.

Member Function Documentation

◆ AddQueryInfo() [1/2]

void AECPropertyDef::AddQueryInfo ( const AECQueryInfo &  cQueryInfo)

Adds query information object.

◆ AddQueryInfo() [2/2]

void AECPropertyDef::AddQueryInfo ( OdRxClass *  pDesc,
const OdString &  strPropertyName 
)

Adds query info for given class and property name.

◆ ClearQueryInfos()

void AECPropertyDef::ClearQueryInfos ( )

Removes all query informations.

◆ GetDataFormat()

OdDbObjectId AECPropertyDef::GetDataFormat ( ) const

Returns Object ID of data format (AECDbScheduleDataFormat) for this property definition.

◆ GetDefaultValue()

const AECVariant & AECPropertyDef::GetDefaultValue ( ) const

Returns the default value.

◆ GetGlobalName()

const OdString & AECPropertyDef::GetGlobalName ( ) const

Returns global property name.

◆ GetIndex()

OdUInt32 AECPropertyDef::GetIndex ( ) const

DOM.

Returns index of property definition.

◆ GetInitialValue()

AECVariant AECPropertyDef::GetInitialValue ( ) const

Returns initial property value.

Remarks
Initial value may differ from default value for eAutoIncrement and eCharIncrement property types.

◆ GetName()

const OdString & AECPropertyDef::GetName ( ) const

Returns property name.

◆ GetOrder()

OdUInt32 AECPropertyDef::GetOrder ( ) const

Returns order.

◆ GetQueryInfoByIndex()

const AECQueryInfo & AECPropertyDef::GetQueryInfoByIndex ( OdUInt32  iIndex) const

Returns query information object by index.

Remarks
Throws aecInvalidCall exception if property is not automatic.

Throws eInvalidIndex in case of invalid index.

◆ GetQueryInfoCount()

OdUInt32 AECPropertyDef::GetQueryInfoCount ( ) const

Returns the number of query information objects.

◆ GetType()

Type AECPropertyDef::GetType ( ) const

Returns type of property value.

◆ GetUseNameAsDesctiption()

bool AECPropertyDef::GetUseNameAsDesctiption ( ) const

Returns whether the name from some certain source should be used as description.

Remarks
The source depends on the type of property definition.

◆ IsAppliedTo()

bool AECPropertyDef::IsAppliedTo ( const OdString &  strClassName,
AECQueryInfo *  rQueryInfo 
) const

Returns whether property definition is applicable for entity with specified name.

◆ IsAutomatic()

bool AECPropertyDef::IsAutomatic ( ) const

Returns whether property is automatically queried.

◆ IsDefaultUnspecified()

bool AECPropertyDef::IsDefaultUnspecified ( ) const

◆ IsLocked()

bool AECPropertyDef::IsLocked ( ) const

◆ IsReadOnly()

bool AECPropertyDef::IsReadOnly ( ) const

◆ IsVisible()

bool AECPropertyDef::IsVisible ( ) const

◆ RemoveQueryInfoByIndex()

void AECPropertyDef::RemoveQueryInfoByIndex ( OdUInt32  iIndex)

Removes query information object by index.

Remarks
Throws aecInvalidCall exception if property is not automatic.

Throws eInvalidIndex in case of invalid index.

◆ SetDataFormat()

void AECPropertyDef::SetDataFormat ( OdDbObjectId  idDataFormat)

Sets Object ID of data format (AECDbScheduleDataFormat) for this property definition.

◆ SetDefaultIsUnspecified()

void AECPropertyDef::SetDefaultIsUnspecified ( bool  bUnspec)

◆ SetDefaultValue()

void AECPropertyDef::SetDefaultValue ( const AECVariant &  vtValue)

Sets the default value.

◆ SetGlobalName()

void AECPropertyDef::SetGlobalName ( const OdString &  gname)

Sets global property name.

◆ SetIndex()

void AECPropertyDef::SetIndex ( OdUInt32  iIndex)

Sets index of property definition.

◆ SetIsAutomatic()

void AECPropertyDef::SetIsAutomatic ( bool  bIsAutomatic)

Sets whether property is automatically queried.

◆ SetLocked()

void AECPropertyDef::SetLocked ( bool  bLocked)

◆ SetName()

void AECPropertyDef::SetName ( const OdString &  strName)

Sets property name.

◆ SetOrder()

void AECPropertyDef::SetOrder ( OdUInt32  iOrder)

Sets order.

◆ SetReadOnly()

void AECPropertyDef::SetReadOnly ( bool  bReadOnly)

◆ SetType()

void AECPropertyDef::SetType ( Type  eType)

Sets type of property value.

◆ SetUseNameAsDesctiption()

void AECPropertyDef::SetUseNameAsDesctiption ( bool  bUseNameAsDesctiption)

Sets whether the name from some certain source should be used as description.

Remarks
The source depends on the type of property definition.

◆ SetVisible()

void AECPropertyDef::SetVisible ( bool  bVisible)

Member Data Documentation

◆ m_aQueryInformation

std::vector<AECQueryInfo> AECPropertyDef::m_aQueryInformation
protected

Definition at line 261 of file AECPropertyDef.h.

◆ m_bAppended

bool AECPropertyDef::m_bAppended
protected

Definition at line 297 of file AECPropertyDef.h.

◆ m_bAutomatic

bool AECPropertyDef::m_bAutomatic
protected

Definition at line 258 of file AECPropertyDef.h.

◆ m_bDefIsUnspecified

bool AECPropertyDef::m_bDefIsUnspecified
protected

Definition at line 270 of file AECPropertyDef.h.

◆ m_eType

Type AECPropertyDef::m_eType
protected

Definition at line 255 of file AECPropertyDef.h.

◆ m_flags

OdUInt8 AECPropertyDef::m_flags
protected

Definition at line 288 of file AECPropertyDef.h.

◆ m_flags2

OdUInt8 AECPropertyDef::m_flags2
protected

Definition at line 294 of file AECPropertyDef.h.

◆ m_hpidList

OdDbHardPointerId AECPropertyDef::m_hpidList
protected

Definition at line 276 of file AECPropertyDef.h.

◆ m_hpidListItem

OdDbHardPointerId AECPropertyDef::m_hpidListItem
protected

Definition at line 277 of file AECPropertyDef.h.

◆ m_hpidScheduleDataFormat

OdDbHardPointerId AECPropertyDef::m_hpidScheduleDataFormat
protected

Definition at line 264 of file AECPropertyDef.h.

◆ m_iIndex

OdUInt32 AECPropertyDef::m_iIndex
protected

Definition at line 249 of file AECPropertyDef.h.

◆ m_iOrder

OdUInt32 AECPropertyDef::m_iOrder
protected

Definition at line 291 of file AECPropertyDef.h.

◆ m_sGlobalName

OdString AECPropertyDef::m_sGlobalName
protected

Definition at line 280 of file AECPropertyDef.h.

◆ m_strName

OdString AECPropertyDef::m_strName
protected

Definition at line 252 of file AECPropertyDef.h.

◆ m_unitType

AECUnitType AECPropertyDef::m_unitType
protected

Definition at line 273 of file AECPropertyDef.h.

◆ m_vDefaultValue

AECVariant AECPropertyDef::m_vDefaultValue
protected

Definition at line 267 of file AECPropertyDef.h.

The documentation for this class was generated from the following file:
Generated on Wed Apr 5 2023 17:30:39