CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4x4::IfcShapeAspect Class Reference

#include <IfcShapeAspectAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcShapeAspect:
OdIfc4x4::OdIFC4X4Instance OdIfc::OdIfcInstance

Public Member Functions

void getShapeRepresentations (OdDAIObjectIds &ShapeRepresentations) const
 
OdDAI::ListOfOdDAIObjectId & shapeRepresentations ()
 
const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
const OdAnsiString & getDescription () const
 
void setDescription (const OdAnsiString &Description)
 
OdDAI::Logical getProductDefinitional () const
 
void setProductDefinitional (OdDAI::Logical ProductDefinitional)
 
IfcProductRepresentationSelect partOfProductDefinitionShape ()
 
void getInvHasExternalReferences (OdDAIObjectIds &HasExternalReferences) const
 
 IfcShapeAspect ()
 
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 OdIfc4x4::OdIFC4X4Instance
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

OdDAI::ListOfOdDAIObjectId m_ShapeRepresentations
 
OdAnsiString m_Name
 
OdAnsiString m_Description
 
OdDAI::Logical m_ProductDefinitional
 
OdDAI::Select m_PartOfProductDefinitionShape
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Friends

class IfcExternalReferenceRelationship
 

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

IfcShapeAspect provides grouping of shape representation items that represent aspects (or components) of the shape of a product. Thereby shape representations of components of the product shape represent a distinctive part to a product that can be explicitly addressed.

The IfcShapeAspect's can have distinct material information or other distinct characteristics that differs from other parts of the product shape representation. The image below indicates the association of material characteristics to shape aspects.

<IMAGE ifcshapeaspect_fig1>

\changes

IFC4 changes: Attribute PartOfProductDefinitionShape is now optional Type of the PartOfProductDefinitionShape attribute changed from "IfcProductDefinitionShape" to "IfcProductRepresentationSelect" Type of the ProductDefinitional attribute changed from "logical" to "IfcLogical"

Definition at line 57 of file IFC4X4/IfcShapeAspectAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcShapeAspect()

OdIfc4x4::IfcShapeAspect::IfcShapeAspect ( )

Default constructor for the IfcShapeAspect class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x4::IfcShapeAspect::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.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x4::IfcShapeAspect::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 OdIfc4x4::IfcShapeAspect::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 & OdIfc4x4::IfcShapeAspect::getDescription ( ) const

Returns the value of Description attribute. This attribute represents the word or group of words that characterize the shape aspect. It can be used to add additional meaning to the name of the aspect.

Returns
Returns the value of Description attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcShapeAspect::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.

◆ getInvHasExternalReferences()

void OdIfc4x4::IfcShapeAspect::getInvHasExternalReferences ( OdDAIObjectIds & HasExternalReferences) const

Returns the value of HasExternalReferences attribute. This attribute represents external references (e.g. classification) associated with the shape aspect.

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

◆ getName()

const OdAnsiString & OdIfc4x4::IfcShapeAspect::getName ( ) const

Returns the value of Name attribute. This attribute represents the word or group of words by which the shape aspect is known. It is a tag to indicate the particular semantic of a component within the product definition shape, used to provide meaning. Example: use the tag "Glazing" to define which component of a window shape defines the glazing area.

Returns
Returns the value of Name attribute.

◆ getProductDefinitional()

OdDAI::Logical OdIfc4x4::IfcShapeAspect::getProductDefinitional ( ) const

Returns the value of ProductDefinitional attribute. This attribute indicates whether the shape aspect is on the physical boundary of the product definition shape. If the value of this attribute is TRUE, it is asserted that the shape aspect being identified is on such a boundary. If the value is FALSE, it is asserted that the shape aspect being identified is not on such a boundary. If the value is UNKNOWN, it is asserted that it is not known whether the shape aspect being identified is on such a boundary.

Returns
Returns the value of ProductDefinitional attribute.
Remarks
EXAMPLE: Would be FALSE for a center line, identified as shape aspect; would be TRUE for a cantilever.

◆ getShapeRepresentations()

void OdIfc4x4::IfcShapeAspect::getShapeRepresentations ( OdDAIObjectIds & ShapeRepresentations) const

Gets the value of ShapeRepresentations attribute. This attribute represents list of shape representations. Each member defines a valid representation of a particular type within a particular representation context as being an aspect (or part) of a product definition.

Parameters
ShapeRepresentations[out] Receives the ShapeRepresentations attribute.

◆ inFields()

virtual OdResult OdIfc4x4::IfcShapeAspect::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 OdIfc4x4::IfcShapeAspect::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 OdIfc4x4::IfcShapeAspect::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.

◆ partOfProductDefinitionShape()

IfcProductRepresentationSelect OdIfc4x4::IfcShapeAspect::partOfProductDefinitionShape ( )

Returns the value of PartOfProductDefinitionShape attribute. This attribute represents reference to the IfcProductDefinitionShape or the IfcRepresentationMap of which this shape is an aspect.

Returns
Returns the value of PartOfProductDefinitionShape attribute.

◆ putAttr() [1/2]

virtual bool OdIfc4x4::IfcShapeAspect::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 OdIfc4x4::IfcShapeAspect::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 OdIfc4x4::IfcShapeAspect::setDescription ( const OdAnsiString & Description)

Sets the value of Description attribute. This attribute represents the word or group of words that characterize the shape aspect. It can be used to add additional meaning to the name of the aspect.

Parameters
Description[in] Description to set.

◆ setInverseCounterParts()

virtual void OdIfc4x4::IfcShapeAspect::setInverseCounterParts ( )
overridevirtual

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

◆ setName()

void OdIfc4x4::IfcShapeAspect::setName ( const OdAnsiString & Name)

Sets the value of Name attribute. This attribute represents the word or group of words by which the shape aspect is known. It is a tag to indicate the particular semantic of a component within the product definition shape, used to provide meaning. Example: use the tag "Glazing" to define which component of a window shape defines the glazing area.

Parameters
Name[in] Name to set.

◆ setProductDefinitional()

void OdIfc4x4::IfcShapeAspect::setProductDefinitional ( OdDAI::Logical ProductDefinitional)

Sets the value of ProductDefinitional attribute. This attribute indicates whether the shape aspect is on the physical boundary of the product definition shape. If the value of this attribute is TRUE, it is asserted that the shape aspect being identified is on such a boundary. If the value is FALSE, it is asserted that the shape aspect being identified is not on such a boundary. If the value is UNKNOWN, it is asserted that it is not known whether the shape aspect being identified is on such a boundary.

Parameters
ProductDefinitional[in] ProductdDefinitional attribute to set.
Remarks
EXAMPLE: Would be FALSE for a center line, identified as shape aspect; would be TRUE for a cantilever.

◆ shapeRepresentations()

OdDAI::ListOfOdDAIObjectId & OdIfc4x4::IfcShapeAspect::shapeRepresentations ( )

Returns the value of ShapeRepresentations attribute. This attribute represents list of shape representations. Each member defines a valid representation of a particular type within a particular representation context as being an aspect (or part) of a product definition.

Returns
Returns the value of ShapeRepresentations attribute.

◆ testAttr() [1/2]

virtual bool OdIfc4x4::IfcShapeAspect::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 OdIfc4x4::IfcShapeAspect::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 OdIfc4x4::IfcShapeAspect::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.

◆ unsetAttr() [1/2]

virtual void OdIfc4x4::IfcShapeAspect::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 OdIfc4x4::IfcShapeAspect::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.

Friends And Related Symbol Documentation

◆ IfcExternalReferenceRelationship

friend class IfcExternalReferenceRelationship
friend

Definition at line 305 of file IFC4X4/IfcShapeAspectAutoImpl.h.

Member Data Documentation

◆ m_Description

OdAnsiString OdIfc4x4::IfcShapeAspect::m_Description
protected

Definition at line 300 of file IFC4X4/IfcShapeAspectAutoImpl.h.

◆ m_Name

OdAnsiString OdIfc4x4::IfcShapeAspect::m_Name
protected

Definition at line 299 of file IFC4X4/IfcShapeAspectAutoImpl.h.

◆ m_PartOfProductDefinitionShape

OdDAI::Select OdIfc4x4::IfcShapeAspect::m_PartOfProductDefinitionShape
protected

Definition at line 302 of file IFC4X4/IfcShapeAspectAutoImpl.h.

◆ m_ProductDefinitional

OdDAI::Logical OdIfc4x4::IfcShapeAspect::m_ProductDefinitional
protected

Definition at line 301 of file IFC4X4/IfcShapeAspectAutoImpl.h.

◆ m_ShapeRepresentations

OdDAI::ListOfOdDAIObjectId OdIfc4x4::IfcShapeAspect::m_ShapeRepresentations
protected

Definition at line 298 of file IFC4X4/IfcShapeAspectAutoImpl.h.


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