CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4x1::IfcTableColumn Class Reference

#include <IfcTableColumnAutoImpl.h>

Inheritance diagram for OdIfc4x1::IfcTableColumn:
OdIfc4x1::OdIfc4x1Instance OdIfc::OdIfcInstance

Public Member Functions

const OdAnsiString & getIdentifier () const
 
void setIdentifier (const OdAnsiString &Identifier)
 
const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
const OdAnsiString & getDescription () const
 
void setDescription (const OdAnsiString &Description)
 
IfcUnit unit ()
 
const OdDAIObjectId & getReferencePath () const
 
void setReferencePath (const OdDAIObjectId &ReferencePath)
 
 IfcTableColumn ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler) override
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler) override
 
virtual OdDAI::Entity * getInstanceType () const override
 
virtual OdRxValue getAttr (const char *attrName) const override
 
virtual void unsetAttr (const char *explicitAttrName) override
 
virtual bool testAttr (const char *explicitAttrName) const override
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val) override
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const override
 
virtual OdIfc::OdIfcEntityType type () const override
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const override
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef) override
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const override
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val) override
 
- Public Member Functions inherited from OdIfc4x1::OdIfc4x1Instance
void setInverseCounterParts () override
 
- Public Member Functions inherited from OdIfc::OdIfcInstance
 ODRX_DECLARE_MEMBERS (OdIfcInstance)
 
 OdIfcInstance ()
 
 ~OdIfcInstance ()
 
bool isInstanceOf (OdIfcEntityType entityType) const
 
IfcOpResult resolved ()
 
void resolve (IfcOpResult resolved, void *resPtr)
 
void unresolve ()
 
virtual void setGsNode (OdGsCache *pGsNode)
 
virtual OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Protected Attributes

OdAnsiString m_Identifier
 
OdAnsiString m_Name
 
OdAnsiString m_Description
 
OdDAI::Select m_Unit
 
OdDAIObjectId m_ReferencePath
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Additional Inherited Members

- Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3dasPoint3d (const OdIfcInstance *inst)
 
static const OdGePoint2dasPoint2d (const OdIfcInstance *inst)
 
static const OdGeVector3dasVector3d (const OdIfcInstance *inst)
 
static const OdGeVector2dasVector2d (const OdIfcInstance *inst)
 
static const OdGeMatrix2dasMatrix2d (const OdIfcInstance *inst)
 
static const OdGeMatrix3dasMatrix3d (const OdIfcInstance *inst)
 
static OdIfcCompoundPtr asCompound (OdSmartPtr< OdIfcInstance > inst)
 
static const OdCmEntityColorasRgbColor (const OdIfcInstance *inst)
 

Detailed Description

An IfcTableColumn is a data structure that captures column information for use in an IfcTable. Each instance defines the identifier, name, description, and units of measure that are applicable to the columnar data associated with the IfcTableRow objects.

Definition at line 46 of file Ifc4x1/IfcTableColumnAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcTableColumn()

OdIfc4x1::IfcTableColumn::IfcTableColumn ( )

Default constructor for the IfcTableColumn class.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x1::IfcTableColumn::getAttr ( const char * attrName) const
overridevirtual

Returns an attribute value for the specified attribute name.

Parameters
attrName[in] Name of an attribute to query.
Returns
OdRxValue object that represents a generic variant type value.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x1::IfcTableColumn::getAttr ( const OdIfc::OdIfcAttribute attrDef) const
overridevirtual

Returns an attribute value for the specified attribute definition.

Parameters
attrDef[in] Attribute definition to query.
Returns
OdRxValue object that represents a generic variant type value.

Reimplemented from OdIfc::OdIfcInstance.

◆ getDescription()

const OdAnsiString & OdIfc4x1::IfcTableColumn::getDescription ( ) const

Returns the value of Description attribute. This attribute represents the human-readable text describing the table column.

Returns
Returns the value of Description attribute.

◆ getIdentifier()

const OdAnsiString & OdIfc4x1::IfcTableColumn::getIdentifier ( ) const

Returns the value of Identifier attribute. This attribute represents the identification of the column within the table. If provided, it must be unique within the table. Columns can be cross-referenced across multiple tables by sharing the same column identifier.

Returns
Returns the value of Identifier attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x1::IfcTableColumn::getInstanceType ( ) const
overridevirtual

Returns a type of a class instance.

Returns
Pointer to the <exref target=https://docs.opendesign.com/tkernel_api_cpp/OdDAI__Entity.html>>OdDAI::Entity</exref> type that determines an entity definition within a schema.

◆ getName()

const OdAnsiString & OdIfc4x1::IfcTableColumn::getName ( ) const

Returns the value of Name attribute. This attribute represents the name that is a human-readable caption for the table column. It is not necessarily unique.

Returns
Returns the value of Name attribute.

◆ getReferencePath()

const OdDAIObjectId & OdIfc4x1::IfcTableColumn::getReferencePath ( ) const

Returns the value of ReferencePath attribute. This attribute represents a relative path to the object and attribute for which data within this column is to be applied. For constraints, such path is relative to the IfcObjectDefinition associated by IfcRelAssociatesConstraint.RelatedObjects. For a constraint to be satisfied, exactly one row of the table must match the referenced object for all columns where the ReferencePath attribute is set.

Returns
Returns the value of ReferencePath attribute.

◆ inFields()

virtual OdResult OdIfc4x1::IfcTableColumn::inFields ( OdDAI::OdSpfFilerBase * rdFiler)
overridevirtual

Reads object's data from the specified filer.

Parameters
rdFiler[in] Pointer to a filer from which to read the data.
Returns
A value of OdResult type that contains the result of the method execution.

◆ isKindOf()

virtual bool OdIfc4x1::IfcTableColumn::isKindOf ( OdIfc::OdIfcEntityType entityType) const
overridevirtual

Checks whether the specified instance is the object derived from or belongs to this class.

Parameters
entityType[in] Entity to check.
Returns
true if the specified instance is the object derived from or belongs to this class, false otherwise.

Reimplemented from OdIfc::OdIfcInstance.

◆ outFields()

virtual OdResult OdIfc4x1::IfcTableColumn::outFields ( OdDAI::OdSpfFilerBase * wrFiler)
overridevirtual

Writes object's data the the specified filer.

Parameters
wrFiler[in] Pointer to a filer to which to write the data.
Returns
A value of OdResult type that contains the result of the method execution.

◆ putAttr() [1/2]

virtual bool OdIfc4x1::IfcTableColumn::putAttr ( const char * explicitAttrName,
const OdRxValue & val )
overridevirtual

Sets the specified attribute with a given value.

Parameters
explicitAttrName[in] Explicit name of the attribute to set.
val[in] Value to set.
Returns
true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc::OdIfcInstance.

◆ putAttr() [2/2]

virtual bool OdIfc4x1::IfcTableColumn::putAttr ( const OdIfc::OdIfcAttribute explicitAttrDef,
const OdRxValue & val )
overridevirtual

Sets the specified attribute with a given value.

Parameters
explicitAttrDef[in] Explicit attribute definition to set.
val[in] Value to set.
Returns
true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc::OdIfcInstance.

◆ setDescription()

void OdIfc4x1::IfcTableColumn::setDescription ( const OdAnsiString & Description)

Sets the value of Description attribute. This attribute represents the human-readable text describing the table column.

Parameters
Description[in] Description to set.

◆ setIdentifier()

void OdIfc4x1::IfcTableColumn::setIdentifier ( const OdAnsiString & Identifier)

Sets the value of Identifier attribute. This attribute represents the identification of the column within the table. If provided, it must be unique within the table. Columns can be cross-referenced across multiple tables by sharing the same column identifier.

Parameters
Identifier[in] Identifier to set.

◆ setName()

void OdIfc4x1::IfcTableColumn::setName ( const OdAnsiString & Name)

Sets the value of Name attribute. This attribute represents the name that is a human-readable caption for the table column. It is not necessarily unique.

Parameters
Name[in] Name to set.

◆ setReferencePath()

void OdIfc4x1::IfcTableColumn::setReferencePath ( const OdDAIObjectId & ReferencePath)

Sets the value of ReferencePath attribute. This attribute represents the ReferencePath indicates a relative path to the object and attribute for which data within this column is to be applied. For constraints, such path is relative to the IfcObjectDefinition associated by IfcRelAssociatesConstraint.RelatedObjects. For a constraint to be satisfied, exactly one row of the table must match the referenced object for all columns where the ReferencePath attribute is set.

Parameters
ReferencePath[in] Reference path to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x1::IfcTableColumn::testAttr ( const char * explicitAttrName) const
overridevirtual

Checks whether the specified attribute is set.

Parameters
explicitAttrName[in] Explicit name of the attribute to test.
Returns
true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc::OdIfcInstance.

◆ testAttr() [2/2]

virtual bool OdIfc4x1::IfcTableColumn::testAttr ( const OdIfc::OdIfcAttribute explicitAttrDef) const
overridevirtual

Checks whether the specified attribute is set.

Parameters
explicitAttrDef[in] Attribute definition to test.
Returns
true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc::OdIfcInstance.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x1::IfcTableColumn::type ( ) const
overridevirtual

Returns the type of this entity.

Returns
A value of the <exref target=https://docs.opendesign.com/tkernel_api_cpp/OdIfc__OdIfcEntityType.html>>OdIfc::OdIfcEntityType</exref> type that represents type of this entity.

Reimplemented from OdIfc::OdIfcInstance.

◆ unit()

IfcUnit OdIfc4x1::IfcTableColumn::unit ( )

Returns the value of Unit attribute. This attribute represents the unit of measure to be used for this column's data. If not provided, then project default units are assumed. If ReferencePath is provided, the the unit must be of the same measure as the referenced attribute.

Returns
Returns the value of Unit attribute.

◆ unsetAttr() [1/2]

virtual void OdIfc4x1::IfcTableColumn::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

Parameters
explicitAttrName[in] Explicit name of the attribute to reset.

Reimplemented from OdIfc::OdIfcInstance.

◆ unsetAttr() [2/2]

virtual void OdIfc4x1::IfcTableColumn::unsetAttr ( const OdIfc::OdIfcAttribute explicitAttrDef)
overridevirtual

Resets a value for the specified attribute.

Parameters
explicitAttrDef[in] Explicit definition that represents an attribute to reset.

Reimplemented from OdIfc::OdIfcInstance.

Member Data Documentation

◆ m_Description

OdAnsiString OdIfc4x1::IfcTableColumn::m_Description
protected

Definition at line 248 of file Ifc4x1/IfcTableColumnAutoImpl.h.

◆ m_Identifier

OdAnsiString OdIfc4x1::IfcTableColumn::m_Identifier
protected

Definition at line 246 of file Ifc4x1/IfcTableColumnAutoImpl.h.

◆ m_Name

OdAnsiString OdIfc4x1::IfcTableColumn::m_Name
protected

Definition at line 247 of file Ifc4x1/IfcTableColumnAutoImpl.h.

◆ m_ReferencePath

OdDAIObjectId OdIfc4x1::IfcTableColumn::m_ReferencePath
protected

Definition at line 250 of file Ifc4x1/IfcTableColumnAutoImpl.h.

◆ m_Unit

OdDAI::Select OdIfc4x1::IfcTableColumn::m_Unit
protected

Definition at line 249 of file Ifc4x1/IfcTableColumnAutoImpl.h.


The documentation for this class was generated from the following file: