CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc2x3::IfcRepresentation Class Reference

#include <IfcRepresentationAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcRepresentation:
OdIfc2x3::OdIfc2x3Instance OdIfc::OdIfcInstance OdIfc2x3::IfcShapeModel OdIfc2x3::IfcStyleModel OdIfc2x3::IfcShapeRepresentation OdIfc2x3::IfcTopologyRepresentation OdIfc2x3::IfcStyledRepresentation

Public Member Functions

const OdDAIObjectId & getContextOfItems () const
 
void setContextOfItems (const OdDAIObjectId &ContextOfItems)
 
const OdAnsiString & getRepresentationIdentifier () const
 
void setRepresentationIdentifier (const OdAnsiString &RepresentationIdentifier)
 
const OdAnsiString & getRepresentationType () const
 
void setRepresentationType (const OdAnsiString &RepresentationType)
 
void getItems (OdDAIObjectIds &Items) const
 
OdDAI::SetOfOdDAIObjectId & items ()
 
void getInvRepresentationMap (OdDAIObjectIds &RepresentationMap) const
 
void getInvLayerAssignments (OdDAIObjectIds &LayerAssignments) const
 
void getInvOfProductRepresentation (OdDAIObjectIds &OfProductRepresentation) const
 
 IfcRepresentation ()
 
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 OdIfc2x3::OdIfc2x3Instance
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_ContextOfItems
 
OdAnsiString m_RepresentationIdentifier
 
OdAnsiString m_RepresentationType
 
OdDAI::SetOfOdDAIObjectId m_Items
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Friends

class IfcRepresentationMap
 
class IfcPresentationLayerAssignment
 
class IfcProductRepresentation
 

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

The IfcRepresentation defines the general concept of representing product properties and in particular the product shape.

  • Representation Use Definition - Each representation, either IfcShapeRepresentation, or IfcTopologyRepresentation have a well defined attributes: ContextOfItems: Reference to an IfcGeometricRepresentationContext as agreed for this representation. RepresentationIdentifier: Name of the representation, for example, 'Body' for 3D shape, 'FootPrint' for 2D ground view, 'Axis' for reference axis. RepresentationType: Name for the geometric, or topological representation type, for example, 'SweptSolid' for 3D swept solids, 'Brep' for boundary representation.
Remarks
This definition may not be instantiated.

Definition at line 54 of file Ifc2x3/IfcRepresentationAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcRepresentation()

OdIfc2x3::IfcRepresentation::IfcRepresentation ( )

Default constructor for the IfcRepresentation class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc2x3::IfcRepresentation::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 OdIfc2x3::IfcShapeModel, OdIfc2x3::IfcShapeRepresentation, OdIfc2x3::IfcStyledRepresentation, OdIfc2x3::IfcStyleModel, and OdIfc2x3::IfcTopologyRepresentation.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x3::IfcRepresentation::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 OdIfc2x3::IfcShapeModel.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x3::IfcRepresentation::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 OdIfc2x3::IfcShapeModel.

◆ getContextOfItems()

const OdDAIObjectId & OdIfc2x3::IfcRepresentation::getContextOfItems ( ) const

Returns the value of ContextOfItems attribute. This attribute represents definition of the representation context for which the different subtypes of representation are valid.

Returns
Returns the value of ContextOfItems attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcRepresentation::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 OdIfc2x3::IfcShapeModel, OdIfc2x3::IfcShapeRepresentation, OdIfc2x3::IfcStyledRepresentation, OdIfc2x3::IfcStyleModel, and OdIfc2x3::IfcTopologyRepresentation.

◆ getInvLayerAssignments()

void OdIfc2x3::IfcRepresentation::getInvLayerAssignments ( OdDAIObjectIds & LayerAssignments) const

Returns the value of LayerAssignments attribute. This attribute represents assignment of the whole representation to a single or multiple layer(s). The LayerAssigments can be overridden by LayerAssigments of the IfcRepresentationItem's within the list of Items.

Parameters
LayerAssignments[out] Receives the value of LayerAssignments attribute.
Remarks
Implementation agreements can restrict the maximum number of layer assignments to 1.

◆ getInvOfProductRepresentation()

void OdIfc2x3::IfcRepresentation::getInvOfProductRepresentation ( OdDAIObjectIds & OfProductRepresentation) const

Returns the value of OfProductRepresentation attribute. This attribute represents reference to the product representations to which this individual representation applies. In most cases it is the reference to one or many product shapes, to which this shape representation is applicable.

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

◆ getInvRepresentationMap()

void OdIfc2x3::IfcRepresentation::getInvRepresentationMap ( OdDAIObjectIds & RepresentationMap) const

Returns the value of RepresentationMap attribute. This attribute represents use of the representation within an IfcRepresentationMap. If used, this IfcRepresentation can be assigned to many representations as one of its Items using an IfcMappedItem. Using IfcRepresentationMap is the way to share one representation (often of type IfcShapeRepresentation) by many products.

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

◆ getItems()

void OdIfc2x3::IfcRepresentation::getItems ( OdDAIObjectIds & Items) const

Gets the value of Items attribute. This attribute represents set of geometric representation items that are defined for this representation.

Parameters
Items[out] Receives the Items attribute.

◆ getRepresentationIdentifier()

const OdAnsiString & OdIfc2x3::IfcRepresentation::getRepresentationIdentifier ( ) const

Returns the value of RepresentationIdentifier attribute. This attribute represents the optional identifier of the representation as used within a project.

Returns
Returns the value of RepresentationIdentifier attribute.

◆ getRepresentationType()

const OdAnsiString & OdIfc2x3::IfcRepresentation::getRepresentationType ( ) const

Returns the value of RepresentationType attribute. This attribute represents the description of the type of a representation context. The representation type defines the type of geometry or topology used for representing the product representation. More information is given at the subtypes IfcShapeRepresentation and IfcTopologyRepresentation. The supported values for context type are to be specified by implementers agreements.

Returns
Returns the value of RepresentationType attribute.

◆ inFields()

virtual OdResult OdIfc2x3::IfcRepresentation::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 OdIfc2x3::IfcShapeModel.

◆ isKindOf()

virtual bool OdIfc2x3::IfcRepresentation::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 OdIfc2x3::IfcShapeModel, OdIfc2x3::IfcShapeRepresentation, OdIfc2x3::IfcStyledRepresentation, OdIfc2x3::IfcStyleModel, and OdIfc2x3::IfcTopologyRepresentation.

◆ items()

OdDAI::SetOfOdDAIObjectId & OdIfc2x3::IfcRepresentation::items ( )

Returns the value of Items attribute. This attribute represents set of geometric representation items that are defined for this representation.

Returns
Returns the value of Items attribute.

◆ outFields()

virtual OdResult OdIfc2x3::IfcRepresentation::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 OdIfc2x3::IfcShapeModel.

◆ putAttr() [1/2]

virtual bool OdIfc2x3::IfcRepresentation::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 OdIfc2x3::IfcShapeModel.

◆ putAttr() [2/2]

virtual bool OdIfc2x3::IfcRepresentation::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 OdIfc2x3::IfcShapeModel.

◆ setContextOfItems()

void OdIfc2x3::IfcRepresentation::setContextOfItems ( const OdDAIObjectId & ContextOfItems)

Sets the value of ContextOfItems attribute. This attribute represents definition of the representation context for which the different subtypes of representation are valid.

Parameters
ContextOfItems[in] ContextOfItems attribute to set.

◆ setInverseCounterParts()

virtual void OdIfc2x3::IfcRepresentation::setInverseCounterParts ( )
overridevirtual

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

◆ setRepresentationIdentifier()

void OdIfc2x3::IfcRepresentation::setRepresentationIdentifier ( const OdAnsiString & RepresentationIdentifier)

Sets the value of RepresentationIdentifier attribute. This attribute represents the optional identifier of the representation as used within a project.

Parameters
RepresentationIdentifier[in] Representation identifier to set.

◆ setRepresentationType()

void OdIfc2x3::IfcRepresentation::setRepresentationType ( const OdAnsiString & RepresentationType)

Sets the value of RepresentationType attribute. This attribute represents the description of the type of a representation context. The representation type defines the type of geometry or topology used for representing the product representation. More information is given at the subtypes IfcShapeRepresentation and IfcTopologyRepresentation. The supported values for context type are to be specified by implementers agreements.

Parameters
RepresentationType[in] Representation type to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcRepresentation::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 OdIfc2x3::IfcShapeModel.

◆ testAttr() [2/2]

virtual bool OdIfc2x3::IfcRepresentation::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 OdIfc2x3::IfcShapeModel.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcRepresentation::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 OdIfc2x3::IfcShapeModel, OdIfc2x3::IfcShapeRepresentation, OdIfc2x3::IfcStyledRepresentation, OdIfc2x3::IfcStyleModel, and OdIfc2x3::IfcTopologyRepresentation.

◆ unsetAttr() [1/2]

virtual void OdIfc2x3::IfcRepresentation::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 OdIfc2x3::IfcShapeModel.

◆ unsetAttr() [2/2]

virtual void OdIfc2x3::IfcRepresentation::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 OdIfc2x3::IfcShapeModel.

Friends And Related Symbol Documentation

◆ IfcPresentationLayerAssignment

friend class IfcPresentationLayerAssignment
friend

Definition at line 302 of file Ifc2x3/IfcRepresentationAutoImpl.h.

◆ IfcProductRepresentation

friend class IfcProductRepresentation
friend

Definition at line 303 of file Ifc2x3/IfcRepresentationAutoImpl.h.

◆ IfcRepresentationMap

friend class IfcRepresentationMap
friend

Definition at line 301 of file Ifc2x3/IfcRepresentationAutoImpl.h.

Member Data Documentation

◆ m_ContextOfItems

OdDAIObjectId OdIfc2x3::IfcRepresentation::m_ContextOfItems
protected

Definition at line 295 of file Ifc2x3/IfcRepresentationAutoImpl.h.

◆ m_Items

OdDAI::SetOfOdDAIObjectId OdIfc2x3::IfcRepresentation::m_Items
protected

Definition at line 298 of file Ifc2x3/IfcRepresentationAutoImpl.h.

◆ m_RepresentationIdentifier

OdAnsiString OdIfc2x3::IfcRepresentation::m_RepresentationIdentifier
protected

Definition at line 296 of file Ifc2x3/IfcRepresentationAutoImpl.h.

◆ m_RepresentationType

OdAnsiString OdIfc2x3::IfcRepresentation::m_RepresentationType
protected

Definition at line 297 of file Ifc2x3/IfcRepresentationAutoImpl.h.


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