#include <IfcTableColumnAutoImpl.h>
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 Ifc4x3_RC1/IfcTableColumnAutoImpl.h.
◆ IfcTableColumn()
| OdIfc4x3_rc1::IfcTableColumn::IfcTableColumn |
( |
| ) |
|
◆ comparedToEarlyImpl()
| virtual bool OdIfc4x3_rc1::IfcTableColumn::comparedToEarlyImpl |
( |
const OdDAI::ApplicationInstance * | pOther, |
|
|
OdRx::Ordering & | ordering ) const |
|
overridevirtual |
Early-bound version of instances comparison.
- Parameters
-
| pOther | [in] Other application instance. |
| ordering | [out] Receives the ordering (comparison) status. |
- Returns
- true if comparison was performed, false if method has no implementation, so late-bound version could be applied.
◆ getAttr() [1/2]
| virtual OdRxValue OdIfc4x3_rc1::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]
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 & OdIfc4x3_rc1::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 & OdIfc4x3_rc1::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 * OdIfc4x3_rc1::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 & OdIfc4x3_rc1::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 & OdIfc4x3_rc1::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 OdIfc4x3_rc1::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()
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 OdIfc4x3_rc1::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 OdIfc4x3_rc1::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]
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 OdIfc4x3_rc1::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 OdIfc4x3_rc1::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 OdIfc4x3_rc1::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
-
◆ setReferencePath()
| void OdIfc4x3_rc1::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 OdIfc4x3_rc1::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]
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()
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 OdIfc4x3_rc1::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 OdIfc4x3_rc1::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]
Resets a value for the specified attribute.
- Parameters
-
| explicitAttrDef | [in] Explicit definition that represents an attribute to reset. |
Reimplemented from OdIfc::OdIfcInstance.
◆ m_Description
| OdAnsiString OdIfc4x3_rc1::IfcTableColumn::m_Description |
|
protected |
◆ m_Identifier
| OdAnsiString OdIfc4x3_rc1::IfcTableColumn::m_Identifier |
|
protected |
◆ m_Name
| OdAnsiString OdIfc4x3_rc1::IfcTableColumn::m_Name |
|
protected |
◆ m_ReferencePath
| OdDAIObjectId OdIfc4x3_rc1::IfcTableColumn::m_ReferencePath |
|
protected |
◆ m_Unit
| OdDAI::Select OdIfc4x3_rc1::IfcTableColumn::m_Unit |
|
protected |
The documentation for this class was generated from the following file: