#include <IfcConstraintRelationshipAutoImpl.h>
An IfcConstraintRelationship is an objectified relationship that enables instances of IfcConstraint and its subtypes to be associated to each other.
Definition at line 45 of file Ifc2x3/IfcConstraintRelationshipAutoImpl.h.
◆ IfcConstraintRelationship()
| OdIfc2x3::IfcConstraintRelationship::IfcConstraintRelationship |
( |
| ) |
|
◆ comparedToEarlyImpl()
| virtual bool OdIfc2x3::IfcConstraintRelationship::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 OdIfc2x3::IfcConstraintRelationship::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 & OdIfc2x3::IfcConstraintRelationship::getDescription |
( |
| ) |
const |
Returns the value of Description attribute. This attribute represents a description that can apply additional information about the constraint relationship.
- Returns
- Returns the value of Description attribute.
◆ getInstanceType()
| virtual OdDAI::Entity * OdIfc2x3::IfcConstraintRelationship::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 & OdIfc2x3::IfcConstraintRelationship::getName |
( |
| ) |
const |
Returns the value of Name attribute. This attribute represents a name used to identify or qualify the constraint relationship.
- Returns
- Returns the value of Name attribute.
◆ getRelatedConstraints()
| void OdIfc2x3::IfcConstraintRelationship::getRelatedConstraints |
( |
OdDAIObjectIds & | RelatedConstraints | ) |
const |
Sets the value of RelatedConstraints attribute. This attribute represents constraints that are related with the RelatingConstraint.
- Parameters
-
| RelatedConstraints | [out] Receives the RelatedConstraints attribute. |
◆ getRelatingConstraint()
| const OdDAIObjectId & OdIfc2x3::IfcConstraintRelationship::getRelatingConstraint |
( |
| ) |
const |
Returns the value of RelatingConstraint attribute. This attribute represents constraint with which the other constraints referenced by attribute RelatedConstraints are related.
- Returns
- Returns the value of RelatingConstraint attribute.
◆ inFields()
| virtual OdResult OdIfc2x3::IfcConstraintRelationship::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 OdIfc2x3::IfcConstraintRelationship::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 OdIfc2x3::IfcConstraintRelationship::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.
◆ relatedConstraints()
| OdDAI::SetOfOdDAIObjectId & OdIfc2x3::IfcConstraintRelationship::relatedConstraints |
( |
| ) |
|
Returns the value of RelatedConstraints attribute. This attribute represents constraints that are related with the RelatingConstraint.
- Returns
- Returns the value of RelatedConstraints attribute.
◆ setDescription()
| void OdIfc2x3::IfcConstraintRelationship::setDescription |
( |
const OdAnsiString & | Description | ) |
|
Sets the value of Description attribute. This attribute represents a description that can apply additional information about the constraint relationship.
- Parameters
-
| Description | [in] Description attribute to set. |
◆ setInverseCounterParts()
| virtual void OdIfc2x3::IfcConstraintRelationship::setInverseCounterParts |
( |
| ) |
|
|
overridevirtual |
Sets the object ID of this instance to inverse attributes of related instances according to schema specification of inverse attributes.
◆ setName()
| void OdIfc2x3::IfcConstraintRelationship::setName |
( |
const OdAnsiString & | Name | ) |
|
Sets the value of Name attribute. This attribute represents a name used to identify or qualify the constraint relationship.
- Parameters
-
| Name | [in] Name attribute to set. |
◆ setRelatingConstraint()
| void OdIfc2x3::IfcConstraintRelationship::setRelatingConstraint |
( |
const OdDAIObjectId & | RelatingConstraint | ) |
|
Sets the value of RelatingConstraint attribute. TThis attribute represents constraint with which the other constraints referenced by attribute RelatedConstraints are related.
- Parameters
-
| RelatingConstraint | [in] RelatingConstraint attribute to set. |
◆ testAttr() [1/2]
| virtual bool OdIfc2x3::IfcConstraintRelationship::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 OdIfc2x3::IfcConstraintRelationship::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()
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.
◆ unsetAttr() [1/2]
| virtual void OdIfc2x3::IfcConstraintRelationship::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 OdIfc2x3::IfcConstraintRelationship::m_Description |
|
protected |
◆ m_Name
| OdAnsiString OdIfc2x3::IfcConstraintRelationship::m_Name |
|
protected |
◆ m_RelatedConstraints
| OdDAI::SetOfOdDAIObjectId OdIfc2x3::IfcConstraintRelationship::m_RelatedConstraints |
|
protected |
◆ m_RelatingConstraint
| OdDAIObjectId OdIfc2x3::IfcConstraintRelationship::m_RelatingConstraint |
|
protected |
The documentation for this class was generated from the following file: