#include <IfcLinearPlacementAutoImpl.h>
IfcLinearPlacement provides a specialization of IfcObjectPlacement in which the placement and axis direction of the object coordinate system is defined by a reference to a curve. RelativePlacement is therefore restricted to IfcAxis2PlacementLinear.
Definition at line 46 of file Ifc4x1/IfcLinearPlacementAutoImpl.h.
◆ getAttr() [1/2]
| virtual OdRxValue OdIfc4x1::IfcLinearPlacement::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 OdIfc4x1::IfcObjectPlacement.
◆ getCartesianPosition()
| const OdDAIObjectId & OdIfc4x1::IfcLinearPlacement::getCartesianPosition |
( |
| ) |
const |
Returns the value of CartesianPosition attribute. This attribute represents the calculated global location and orientation in Cartesian coordinates as a fallback which can be used by applications that do not support linear placement.
- Returns
- Returns the value of CartesianPosition attribute.
◆ getDistance()
| const OdDAIObjectId & OdIfc4x1::IfcLinearPlacement::getDistance |
( |
| ) |
const |
Returns the value of Distance attribute. This attribute represents the position relative to the referenced curve.
- Returns
- Returns the value of Distance attribute.
◆ getInstanceType()
| virtual OdDAI::Entity * OdIfc4x1::IfcLinearPlacement::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.
Reimplemented from OdIfc4x1::IfcObjectPlacement.
◆ getOrientation()
| const OdDAIObjectId & OdIfc4x1::IfcLinearPlacement::getOrientation |
( |
| ) |
const |
Returns the value of Orientation attribute. This attribute represents rotation of the object in the horizontal plane and vertical axis (after applying DistanceAlong, OffsetLateral, OffsetVertical, and OffsetLongitudinal).
- Returns
- Returns the value of Orientation attribute.
◆ getPlacementRelTo()
| const OdDAIObjectId & OdIfc4x1::IfcLinearPlacement::getPlacementRelTo |
( |
| ) |
const |
Returns the value of PlacementRelTo attribute. This attribute represents the curve used as the basis for positioning parameters.
- Returns
- Returns the value of PlacementRelTo attribute.
◆ inFields()
| virtual OdResult OdIfc4x1::IfcLinearPlacement::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.
Reimplemented from OdIfc4x1::IfcObjectPlacement.
◆ 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 OdIfc4x1::IfcObjectPlacement.
◆ outFields()
| virtual OdResult OdIfc4x1::IfcLinearPlacement::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.
Reimplemented from OdIfc4x1::IfcObjectPlacement.
◆ putAttr() [1/2]
| virtual bool OdIfc4x1::IfcLinearPlacement::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 OdIfc4x1::IfcObjectPlacement.
◆ setCartesianPosition()
| void OdIfc4x1::IfcLinearPlacement::setCartesianPosition |
( |
const OdDAIObjectId & | CartesianPosition | ) |
|
Sets the value of CartesianPosition attribute. This attribute represents the calculated global location and orientation in Cartesian coordinates as a fallback which can be used by applications that do not support linear placement.
- Parameters
-
| CartesianPosition | [in] Cartesian position to set. |
◆ setDistance()
| void OdIfc4x1::IfcLinearPlacement::setDistance |
( |
const OdDAIObjectId & | Distance | ) |
|
Sets the value of Distance attribute. This attribute represents the position relative to the referenced curve.
- Parameters
-
| Distance | [in] Distance to set. |
◆ setOrientation()
| void OdIfc4x1::IfcLinearPlacement::setOrientation |
( |
const OdDAIObjectId & | Orientation | ) |
|
Sets the value of Orientation attribute. This attribute represents rotation of the object in the horizontal plane and vertical axis (after applying DistanceAlong, OffsetLateral, OffsetVertical, and OffsetLongitudinal).
- Parameters
-
◆ setPlacementRelTo()
| void OdIfc4x1::IfcLinearPlacement::setPlacementRelTo |
( |
const OdDAIObjectId & | PlacementRelTo | ) |
|
Sets the value of PlacementRelTo attribute. This attribute represents the curve used as the basis for positioning parameters.
- Parameters
-
| PlacementRelTo | [in] PlacementRelTo attribute to set. |
◆ testAttr() [1/2]
| virtual bool OdIfc4x1::IfcLinearPlacement::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 OdIfc4x1::IfcObjectPlacement.
◆ 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 OdIfc4x1::IfcObjectPlacement.
◆ 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 OdIfc4x1::IfcObjectPlacement.
◆ unsetAttr() [1/2]
| virtual void OdIfc4x1::IfcLinearPlacement::unsetAttr |
( |
const char * | explicitAttrName | ) |
|
|
overridevirtual |
Resets a value for the specified attribute.
- Parameters
-
| explicitAttrName | [in] Explicit name of the attribute to reset. |
Reimplemented from OdIfc4x1::IfcObjectPlacement.
◆ unsetAttr() [2/2]
Resets a value for the specified attribute.
- Parameters
-
| explicitAttrDef | [in] Explicit definition that represents an attribute to reset. |
Reimplemented from OdIfc4x1::IfcObjectPlacement.
◆ m_CartesianPosition
| OdDAIObjectId OdIfc4x1::IfcLinearPlacement::m_CartesianPosition |
|
protected |
◆ m_Distance
| OdDAIObjectId OdIfc4x1::IfcLinearPlacement::m_Distance |
|
protected |
◆ m_Orientation
| OdDAIObjectId OdIfc4x1::IfcLinearPlacement::m_Orientation |
|
protected |
◆ m_PlacementRelTo
| OdDAIObjectId OdIfc4x1::IfcLinearPlacement::m_PlacementRelTo |
|
protected |
The documentation for this class was generated from the following file: