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

#include <IfcDistributionFlowElementAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcDistributionFlowElement:
OdIfc2x3::IfcDistributionElement OdIfc2x3::IfcElement OdIfc2x3::IfcProduct OdIfc2x3::IfcObject OdIfc2x3::IfcObjectDefinition OdIfc2x3::IfcRoot OdIfc2x3::OdIfc2x3Instance OdIfc::OdIfcInstance OdIfc2x3::IfcDistributionChamberElement OdIfc2x3::IfcEnergyConversionDevice OdIfc2x3::IfcFlowController OdIfc2x3::IfcFlowFitting OdIfc2x3::IfcFlowMovingDevice OdIfc2x3::IfcFlowSegment OdIfc2x3::IfcFlowStorageDevice OdIfc2x3::IfcFlowTerminal OdIfc2x3::IfcFlowTreatmentDevice

Public Member Functions

void getInvHasControlElements (OdDAIObjectIds &HasControlElements) const
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler) override
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler) override
 
virtual OdDAI::Entity * getInstanceType () 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 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::IfcElement
const OdAnsiString & getTag () const
 
void setTag (const OdAnsiString &Tag)
 
void getInvHasStructuralMember (OdDAIObjectIds &HasStructuralMember) const
 
void getInvFillsVoids (OdDAIObjectIds &FillsVoids) const
 
void getInvConnectedTo (OdDAIObjectIds &ConnectedTo) const
 
void getInvHasCoverings (OdDAIObjectIds &HasCoverings) const
 
void getInvHasProjections (OdDAIObjectIds &HasProjections) const
 
void getInvReferencedInStructures (OdDAIObjectIds &ReferencedInStructures) const
 
void getInvHasPorts (OdDAIObjectIds &HasPorts) const
 
void getInvHasOpenings (OdDAIObjectIds &HasOpenings) const
 
void getInvIsConnectionRealization (OdDAIObjectIds &IsConnectionRealization) const
 
void getInvProvidesBoundaries (OdDAIObjectIds &ProvidesBoundaries) const
 
void getInvConnectedFrom (OdDAIObjectIds &ConnectedFrom) const
 
void getInvContainedInStructure (OdDAIObjectIds &ContainedInStructure) const
 
 IfcElement ()
 
- Public Member Functions inherited from OdIfc2x3::IfcProduct
const OdDAIObjectId & getObjectPlacement () const
 
void setObjectPlacement (const OdDAIObjectId &ObjectPlacement)
 
const OdDAIObjectId & getRepresentation () const
 
void setRepresentation (const OdDAIObjectId &Representation)
 
void getInvReferencedBy (OdDAIObjectIds &ReferencedBy) const
 
virtual void setInverseCounterParts () override
 
- Public Member Functions inherited from OdIfc2x3::IfcObject
const OdAnsiString & getObjectType () const
 
void setObjectType (const OdAnsiString &ObjectType)
 
void getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const
 
 IfcObject ()
 
- Public Member Functions inherited from OdIfc2x3::IfcObjectDefinition
void getInvHasAssignments (OdDAIObjectIds &HasAssignments) const
 
void getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const
 
void getInvDecomposes (OdDAIObjectIds &Decomposes) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
- Public Member Functions inherited from OdIfc2x3::IfcRoot
OdDAI::CompressedGUID getGlobalId () const
 
void setGlobalId (OdDAI::CompressedGUID GlobalId)
 
const OdDAIObjectId & getOwnerHistory () const
 
void setOwnerHistory (const OdDAIObjectId &OwnerHistory)
 
const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
const OdAnsiString & getDescription () const
 
void setDescription (const OdAnsiString &Description)
 
 IfcRoot ()
 
- 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 Member Functions

virtual OdRxValue getAttr (const char *attrName) const override
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val) override
 

Friends

class IfcRelFlowControlElements
 

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)
 
- Protected Attributes inherited from OdIfc2x3::IfcElement
OdAnsiString m_Tag
 
- Protected Attributes inherited from OdIfc2x3::IfcProduct
OdDAIObjectId m_ObjectPlacement
 
OdDAIObjectId m_Representation
 
- Protected Attributes inherited from OdIfc2x3::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc2x3::IfcRoot
OdDAI::CompressedGUID m_GlobalId
 
OdDAIObjectId m_OwnerHistory
 
OdAnsiString m_Name
 
OdAnsiString m_Description
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Detailed Description

The distribution element IfcDistributionFlowElement defines occurrence elements of a distribution system that facilitate the distribution of energy or matter, such as air, water or power. Examples of distribution flow elements are ducts, pipes, wires, fittings, and equipment.

  • Axis Geometry - This represents the 3D flow path of the item having IfcShapeRepresentation.RepresentationType of 'Curve3D' and containing a single IfcBoundedCurve subtype such as IfcPolyline, IfcTrimmedCurve, or IfcCompositeCurve. For elements containing directional ports (IfcDistributionPort with FlowDirection of SOURCE or SINK), the direction of the curve indicates direction of flow where a SINK port is positioned at the start of the curve and a SOURCE port is positioned at the end of the curve. This representation is most applicable to flow segments (pipes, ducts, cables), however can be used at other elements to define a primary flow path if applicable.
  • Clearance Geometry - This represents the 3D clearance volume of the item having RepresentationType of 'Surface3D'. Such clearance region indicates space that should not intersect with the 'Body' representation of other elements, though can intersect with the 'Clearance' representation of other elements. The particular use of clearance space can be for safety, maintenance, or other purposes.
  • Object Typing - This concept can be applied to the following resources: IfcDistributionFlowElementType
  • Property Sets for Objects - This concept can be applied to the following resources: Pset_SoundGeneration

Definition at line 65 of file Ifc2x3/IfcDistributionFlowElementAutoImpl.h.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc2x3::IfcDistributionFlowElement::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 from OdIfc2x3::IfcDistributionElement.

Reimplemented in OdIfc2x3::IfcDistributionChamberElement, OdIfc2x3::IfcElectricDistributionPoint, OdIfc2x3::IfcEnergyConversionDevice, OdIfc2x3::IfcFlowController, OdIfc2x3::IfcFlowFitting, OdIfc2x3::IfcFlowMovingDevice, OdIfc2x3::IfcFlowSegment, OdIfc2x3::IfcFlowStorageDevice, OdIfc2x3::IfcFlowTerminal, and OdIfc2x3::IfcFlowTreatmentDevice.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x3::IfcElement::getAttr ( const char * attrName) const
overrideprotectedvirtual

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 from OdIfc2x3::IfcElement.

Reimplemented in OdIfc2x3::IfcElectricDistributionPoint.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x3::IfcDistributionFlowElement::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 OdIfc2x3::IfcElement.

Reimplemented in OdIfc2x3::IfcElectricDistributionPoint.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcDistributionFlowElement::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 OdIfc2x3::IfcDistributionElement.

Reimplemented in OdIfc2x3::IfcDistributionChamberElement, OdIfc2x3::IfcElectricDistributionPoint, OdIfc2x3::IfcEnergyConversionDevice, OdIfc2x3::IfcFlowController, OdIfc2x3::IfcFlowFitting, OdIfc2x3::IfcFlowMovingDevice, OdIfc2x3::IfcFlowSegment, OdIfc2x3::IfcFlowStorageDevice, OdIfc2x3::IfcFlowTerminal, and OdIfc2x3::IfcFlowTreatmentDevice.

◆ getInvHasControlElements()

void OdIfc2x3::IfcDistributionFlowElement::getInvHasControlElements ( OdDAIObjectIds & HasControlElements) const

Returns the value of HasControlElements attribute. This attribute represents reference to the relationship object that relates control elements.

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

◆ inFields()

virtual OdResult OdIfc2x3::IfcDistributionFlowElement::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 OdIfc2x3::IfcElement.

Reimplemented in OdIfc2x3::IfcElectricDistributionPoint.

◆ isKindOf()

virtual bool OdIfc2x3::IfcDistributionFlowElement::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 OdIfc2x3::IfcDistributionElement.

Reimplemented in OdIfc2x3::IfcDistributionChamberElement, OdIfc2x3::IfcElectricDistributionPoint, OdIfc2x3::IfcEnergyConversionDevice, OdIfc2x3::IfcFlowController, OdIfc2x3::IfcFlowFitting, OdIfc2x3::IfcFlowMovingDevice, OdIfc2x3::IfcFlowSegment, OdIfc2x3::IfcFlowStorageDevice, OdIfc2x3::IfcFlowTerminal, and OdIfc2x3::IfcFlowTreatmentDevice.

◆ outFields()

virtual OdResult OdIfc2x3::IfcDistributionFlowElement::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 OdIfc2x3::IfcElement.

Reimplemented in OdIfc2x3::IfcElectricDistributionPoint.

◆ putAttr() [1/2]

virtual bool OdIfc2x3::IfcElement::putAttr ( const char * explicitAttrName,
const OdRxValue & val )
overrideprotectedvirtual

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 OdIfc2x3::IfcElement.

Reimplemented in OdIfc2x3::IfcElectricDistributionPoint.

◆ putAttr() [2/2]

virtual bool OdIfc2x3::IfcDistributionFlowElement::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 OdIfc2x3::IfcElement.

Reimplemented in OdIfc2x3::IfcElectricDistributionPoint.

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcDistributionFlowElement::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 OdIfc2x3::IfcElement.

Reimplemented in OdIfc2x3::IfcElectricDistributionPoint.

◆ testAttr() [2/2]

virtual bool OdIfc2x3::IfcDistributionFlowElement::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 OdIfc2x3::IfcElement.

Reimplemented in OdIfc2x3::IfcElectricDistributionPoint.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcDistributionFlowElement::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 OdIfc2x3::IfcDistributionElement.

Reimplemented in OdIfc2x3::IfcDistributionChamberElement, OdIfc2x3::IfcElectricDistributionPoint, OdIfc2x3::IfcEnergyConversionDevice, OdIfc2x3::IfcFlowController, OdIfc2x3::IfcFlowFitting, OdIfc2x3::IfcFlowMovingDevice, OdIfc2x3::IfcFlowSegment, OdIfc2x3::IfcFlowStorageDevice, OdIfc2x3::IfcFlowTerminal, and OdIfc2x3::IfcFlowTreatmentDevice.

◆ unsetAttr() [1/2]

virtual void OdIfc2x3::IfcDistributionFlowElement::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

Parameters
explicitAttrName[in] Explicit name of the attribute to reset.

Reimplemented from OdIfc2x3::IfcElement.

Reimplemented in OdIfc2x3::IfcElectricDistributionPoint.

◆ unsetAttr() [2/2]

virtual void OdIfc2x3::IfcDistributionFlowElement::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 OdIfc2x3::IfcElement.

Reimplemented in OdIfc2x3::IfcElectricDistributionPoint.

Friends And Related Symbol Documentation

◆ IfcRelFlowControlElements

friend class IfcRelFlowControlElements
friend

Definition at line 199 of file Ifc2x3/IfcDistributionFlowElementAutoImpl.h.


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