CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4x3_add2::IfcObjectPlacement Class Reference

#include <IfcObjectPlacementAutoImpl.h>

Inheritance diagram for OdIfc4x3_add2::IfcObjectPlacement:
OdIfc4x3_add2::OdIfc4x3Instance OdIfc::OdIfcInstance OdIfc4x3_add2::IfcGridPlacement OdIfc4x3_add2::IfcLinearPlacement OdIfc4x3_add2::IfcLocalPlacement

Public Member Functions

const OdDAIObjectId & getPlacementRelTo () const
 
void setPlacementRelTo (const OdDAIObjectId &PlacementRelTo)
 
void getInvPlacesObject (OdDAIObjectIds &PlacesObject) const
 
void getInvReferencedByPlacements (OdDAIObjectIds &ReferencedByPlacements) const
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler) override
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler) override
 
virtual void setInverseCounterParts () override
 
virtual OdDAI::Entity * getInstanceType () const override
 
virtual OdRxValue getAttr (const char *attrName) const override
 
virtual bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) 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 OdIfc4x3_add2::OdIfc4x3Instance
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

OdDAIObjectId m_PlacementRelTo
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Friends

class IfcProduct
 

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

IfcObjectPlacement is an abstract supertype for the special types defining the object coordinate system. The IfcObjectPlacement has to be provided for each product that has a shape representation.

The object placement can be specified: Absolute: by an axis2 placement, relative to the world coordinate system Relative: by an axis2 placement, relative to the object placement of another product By grid reference: by the virtual intersection and reference direction specified by two axes of a design grid Linear placement: by distance along a curve, with possible offsets

Object placement has to unambiguously define the object coordinate system as either two-dimensional axis placement (IfcAxis2Placement2D) or three-dimensional axis placement (IfcAxis2Placement3D).

Remarks
This definition may not be instantiated

\changes

IFC4 changes: Type of the inverse attribute PlacesObject changed from "SET OF [1:1] IfcProduct FOR ObjectPlacement" to "SET OF [0:?] IfcProduct FOR ObjectPlacement" IFC4X3_RC1 changes: Type of the inverse attribute ReferencedByPlacements changed from "SET OF [0:?] IfcLocalPlacement FOR PlacementRelTo" to "SET OF [0:?] IfcObjectPlacement FOR PlacementRelTo"

Definition at line 64 of file Ifc4x3/IfcObjectPlacementAutoImpl.h.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x3_add2::IfcObjectPlacement::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.
Remarks
If the method returns true, the ordering parameter can receive one of the following statuses:
Value Description kLessThan -1 This object < Other Object. kEqual 0 This object = Other Object. kGreaterThan 1 This object > Other Object. kNotOrderable 2 This class is not orderable.

Reimplemented in OdIfc4x3_add2::IfcGridPlacement, OdIfc4x3_add2::IfcLinearPlacement, and OdIfc4x3_add2::IfcLocalPlacement.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x3_add2::IfcObjectPlacement::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.

Reimplemented in OdIfc4x3_add2::IfcGridPlacement, OdIfc4x3_add2::IfcLinearPlacement, and OdIfc4x3_add2::IfcLocalPlacement.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x3_add2::IfcObjectPlacement::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.

Reimplemented in OdIfc4x3_add2::IfcGridPlacement, OdIfc4x3_add2::IfcLinearPlacement, and OdIfc4x3_add2::IfcLocalPlacement.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x3_add2::IfcObjectPlacement::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 in OdIfc4x3_add2::IfcGridPlacement, OdIfc4x3_add2::IfcLinearPlacement, and OdIfc4x3_add2::IfcLocalPlacement.

◆ getInvPlacesObject()

void OdIfc4x3_add2::IfcObjectPlacement::getInvPlacesObject ( OdDAIObjectIds & PlacesObject) const

Returns the value of PlacesObject attribute. This attribute represents a set of IfcObjectPlacement instances that provide a placement and an object coordinate system for instances of IfcProduct. If an IfcObjectPlacement is shared by many instances of IfcProduct it does not apply a semantic meaning of being a shared placement that needs to be maintained. The same instance of IfcObjectPlacement could be used to reduce exchange file size.

Parameters
PlacesObject[out] Receives the value of PlacesObject attribute.

◆ getInvReferencedByPlacements()

void OdIfc4x3_add2::IfcObjectPlacement::getInvReferencedByPlacements ( OdDAIObjectIds & ReferencedByPlacements) const

Returns the value of ReferencedByPlacements attribute. This attribute represents placements that are specified relative to this placement of an object.

Parameters
ReferencedByPlacements[out] Receives the value of ReferencedByPlacements attribute.

◆ getPlacementRelTo()

const OdDAIObjectId & OdIfc4x3_add2::IfcObjectPlacement::getPlacementRelTo ( ) const

Returns the value of PlacementRelTo attribute. This attribute represents reference to object placement that provides the relative placement with its placement in a grid, local coordinate system or linear referenced placement. If it is omitted, then in the case of linear placement it is established by the origin of horizontal alignment of the referenced IfcAlignment Axis. In the case of local placement it is established by the geometric representation context.

Returns
Returns the value of PlacementRelTo attribute.

◆ inFields()

virtual OdResult OdIfc4x3_add2::IfcObjectPlacement::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 in OdIfc4x3_add2::IfcGridPlacement, OdIfc4x3_add2::IfcLinearPlacement, and OdIfc4x3_add2::IfcLocalPlacement.

◆ isKindOf()

virtual bool OdIfc4x3_add2::IfcObjectPlacement::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.

Reimplemented in OdIfc4x3_add2::IfcGridPlacement, OdIfc4x3_add2::IfcLinearPlacement, and OdIfc4x3_add2::IfcLocalPlacement.

◆ outFields()

virtual OdResult OdIfc4x3_add2::IfcObjectPlacement::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 in OdIfc4x3_add2::IfcGridPlacement, OdIfc4x3_add2::IfcLinearPlacement, and OdIfc4x3_add2::IfcLocalPlacement.

◆ putAttr() [1/2]

virtual bool OdIfc4x3_add2::IfcObjectPlacement::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.

Reimplemented in OdIfc4x3_add2::IfcGridPlacement, OdIfc4x3_add2::IfcLinearPlacement, and OdIfc4x3_add2::IfcLocalPlacement.

◆ putAttr() [2/2]

virtual bool OdIfc4x3_add2::IfcObjectPlacement::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.

Reimplemented in OdIfc4x3_add2::IfcGridPlacement, OdIfc4x3_add2::IfcLinearPlacement, and OdIfc4x3_add2::IfcLocalPlacement.

◆ setInverseCounterParts()

virtual void OdIfc4x3_add2::IfcObjectPlacement::setInverseCounterParts ( )
overridevirtual

Sets the object ID of this instance to inverse attributes of related instances according to schema specification of inverse attributes.

◆ setPlacementRelTo()

void OdIfc4x3_add2::IfcObjectPlacement::setPlacementRelTo ( const OdDAIObjectId & PlacementRelTo)

Sets the value of PlacementRelTo attribute. This attribute represents reference to object placement that provides the relative placement with its placement in a grid, local coordinate system or linear referenced placement. If it is omitted, then in the case of linear placement it is established by the origin of horizontal alignment of the referenced IfcAlignment Axis. In the case of local placement it is established by the geometric representation context.

Parameters
PlacementRelTo[in] PlacementRelTo attribute to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x3_add2::IfcObjectPlacement::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.

Reimplemented in OdIfc4x3_add2::IfcGridPlacement, OdIfc4x3_add2::IfcLinearPlacement, and OdIfc4x3_add2::IfcLocalPlacement.

◆ testAttr() [2/2]

virtual bool OdIfc4x3_add2::IfcObjectPlacement::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.

Reimplemented in OdIfc4x3_add2::IfcGridPlacement, OdIfc4x3_add2::IfcLinearPlacement, and OdIfc4x3_add2::IfcLocalPlacement.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x3_add2::IfcObjectPlacement::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.

Reimplemented in OdIfc4x3_add2::IfcGridPlacement, OdIfc4x3_add2::IfcLinearPlacement, and OdIfc4x3_add2::IfcLocalPlacement.

◆ unsetAttr() [1/2]

virtual void OdIfc4x3_add2::IfcObjectPlacement::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.

Reimplemented in OdIfc4x3_add2::IfcGridPlacement, OdIfc4x3_add2::IfcLinearPlacement, and OdIfc4x3_add2::IfcLocalPlacement.

◆ unsetAttr() [2/2]

virtual void OdIfc4x3_add2::IfcObjectPlacement::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.

Reimplemented in OdIfc4x3_add2::IfcGridPlacement, OdIfc4x3_add2::IfcLinearPlacement, and OdIfc4x3_add2::IfcLocalPlacement.

Friends And Related Symbol Documentation

◆ IfcProduct

friend class IfcProduct
friend

Definition at line 247 of file Ifc4x3/IfcObjectPlacementAutoImpl.h.

Member Data Documentation

◆ m_PlacementRelTo

OdDAIObjectId OdIfc4x3_add2::IfcObjectPlacement::m_PlacementRelTo
protected

Definition at line 244 of file Ifc4x3/IfcObjectPlacementAutoImpl.h.


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