#include <IfcDistributionPortAutoImpl.h>

Inheritance diagram for OdIfc4::IfcDistributionPort:

Public Member Functions
IfcFlowDirectionEnum	getFlowDirection () const

void	setFlowDirection (IfcFlowDirectionEnum FlowDirection)

IfcDistributionPortTypeEnum	getPredefinedType () const

void	setPredefinedType (IfcDistributionPortTypeEnum PredefinedType)

IfcDistributionSystemEnum	getSystemType () const

void	setSystemType (IfcDistributionSystemEnum SystemType)

	IfcDistributionPort ()

virtual OdResult	inFields (OdDAI::OdSpfFilerBase *rdFiler) override

virtual OdResult	outFields (OdDAI::OdSpfFilerBase *wrFiler) 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 OdIfc4::IfcPort
void	getInvContainedIn (OdDAIObjectIds &ContainedIn) const

void	getInvConnectedFrom (OdDAIObjectIds &ConnectedFrom) const

void	getInvConnectedTo (OdDAIObjectIds &ConnectedTo) const

Public Member Functions inherited from OdIfc4::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 OdIfc4::IfcObject
const OdAnsiString &	getObjectType () const

void	setObjectType (const OdAnsiString &ObjectType)

void	getInvIsDeclaredBy (OdDAIObjectIds &IsDeclaredBy) const

void	getInvDeclares (OdDAIObjectIds &Declares) const

void	getInvIsTypedBy (OdDAIObjectIds &IsTypedBy) const

void	getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const

	IfcObject ()

Public Member Functions inherited from OdIfc4::IfcObjectDefinition
void	getInvHasAssignments (OdDAIObjectIds &HasAssignments) const

void	getInvNests (OdDAIObjectIds &Nests) const

void	getInvIsNestedBy (OdDAIObjectIds &IsNestedBy) const

void	getInvHasContext (OdDAIObjectIds &HasContext) const

void	getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const

void	getInvDecomposes (OdDAIObjectIds &Decomposes) const

void	getInvHasAssociations (OdDAIObjectIds &HasAssociations) const

Public Member Functions inherited from OdIfc4::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 OdIfc4::OdIfc4Instance
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 OdGsCache *	gsNode () const

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *traits) const

virtual bool	subWorldDraw (OdGiWorldDraw *wd) const

virtual OdDbStub *	ownerId () const

Protected Attributes
OdDAI::Enum	m_FlowDirection

OdDAI::Enum	m_PredefinedType

OdDAI::Enum	m_SystemType

Protected Attributes inherited from OdIfc4::IfcProduct
OdDAIObjectId	m_ObjectPlacement

OdDAIObjectId	m_Representation

Protected Attributes inherited from OdIfc4::IfcObject
OdAnsiString	m_ObjectType

Protected Attributes inherited from OdIfc4::IfcRoot
OdDAI::CompressedGUID	m_GlobalId

OdDAIObjectId	m_OwnerHistory

OdAnsiString	m_Name

OdAnsiString	m_Description

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

Additional Inherited Members
Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3d *	asPoint3d (const OdIfcInstance *inst)

static const OdGePoint2d *	asPoint2d (const OdIfcInstance *inst)

static const OdGeVector3d *	asVector3d (const OdIfcInstance *inst)

static const OdGeVector2d *	asVector2d (const OdIfcInstance *inst)

static const OdGeMatrix2d *	asMatrix2d (const OdIfcInstance *inst)

static const OdGeMatrix3d *	asMatrix3d (const OdIfcInstance *inst)

static OdIfcCompoundPtr	asCompound (OdSmartPtr< OdIfcInstance > inst)

static const OdCmEntityColor *	asRgbColor (const OdIfcInstance *inst)

Protected Member Functions inherited from OdIfc4::IfcPort
virtual OdRxValue	getAttr (const char *attrName) const override

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

Detailed Description

A distribution port is an inlet or outlet of a product through which a particular substance can flow.

Distribution ports are used for passage of solid, liquid, or gas substances, as well as electricity for power or communications. Flow segments (pipes, ducts, cables) can be used to connect ports across products. Distribution ports are defined by system type and flow direction such that for two ports to be connected, they must share the same system type and have opposite flow directions (one side being a SOURCE and the other being a SINK). Ports are similar to openings in that they do not have any visible geometry; such geometry is captured at the shape representation of the enclosing element or element type. Ports can have placement that indicates the position and orientation of the connection.

Ports are assigned the distribution systems in order to indicate its role in a particular system, e.g. cold water inlet.

Product Local Placement - The placement of a port indicates the position and orientation of how it can connect to a compatible port on another product. The placement is relative to the nesting IfcDistributionElement, IfcDistributionElementType, or enclosing IfcDistributionPort. The Location is the midpoint of the physical connection, unless otherwise indicated by cardinal point on a material profile. The Axis points in the direction of the physical connection away from the product if FlowDirection equals SOURCE (or SOURCEANDSINK or NOTDEFINED), or points opposite direction (to the product) if the FlowDirection equals SINK.
Port Nesting - Distribution ports are indicated on products and product types using the IfcRelNests relationship where RelatingObject refers to the enclosing IfcDistributionElement or IfcDistributionElementType respectively. The order of ports indicates logical ordering such within outlets, junction boxes, or communications equipment. Ports can be further nested into sub-ports, for indicating specific connections on components or pins.
Port Connectivity - IfcDistributionPort can be connected to other objects as follows using the indicated relationship: IfcDistributionPort (IfcRelConnectsPorts) : Indicates a connection to another port having the same type and opposite flow direction. For port connections between elements, the RelatingPort is set to a port having FlowDirection=SOURCE and the RelatedPort is set to a port having FlowDirection=SINK. For aggregation scenarios, ports on a device can be mapped to aggregated devices within, in which case ports on the outer device indicate a single FlowDirection but have an additional connection internally to a port on an aggregated inner device. Refer to IfcUnitaryEquipment for an example. IfcDistributionElement (through IfcRelConnectsPortToElement): For dynamic ports, indicates the containing element.

The next image illustrates distribution port connectivity.

Product Assignment - The IfcDistributionPort can be assigned to the following entities using relationships as indicated: IfcDistributionSystem (through IfcRelAssignsToGroup): Indicates a system containing interconnected devices. IfcPerformanceHistory (through IfcRelAssignsToControl): Indicates real time or historical information captured for the device.

\changes

IFC4 changes: Ports are now related to products and product types using the IfcRelNests relationship; use of IfcRelConnectsPortToElement is now reserved for dynamically attached ports (such as drilling a hole in a tank).

Definition at line 85 of file Ifc4/IfcDistributionPortAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcDistributionPort()

OdIfc4::IfcDistributionPort::IfcDistributionPort ( )

Default constructor for the IfcDistributionPort class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4::IfcDistributionPort::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 OdIfc4::IfcPort.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4::IfcDistributionPort::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 from OdIfc4::IfcProduct.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4::IfcDistributionPort::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 OdIfc4::IfcPort.

◆ getFlowDirection()

IfcFlowDirectionEnum OdIfc4::IfcDistributionPort::getFlowDirection ( ) const

Returns the value of FlowDirection attribute. This attribute represents enumeration that identifies if this port is a Sink (inlet), a Source (outlet) or both a SinkAndSource.

Returns: Returns the value of FlowDirection attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcDistributionPort::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 OdIfc4::IfcPort.

◆ getPredefinedType()

IfcDistributionPortTypeEnum OdIfc4::IfcDistributionPort::getPredefinedType ( ) const

Returns the value of PredefinedType attribute. This attribute represents a list of types to further identify the object. Some property sets can be specifically applicable to one of these types.

Returns: Returns the value of PredefinedType attribute.

Remarks: If the object has an associated IfcTypeObject with a PredefinedType, then this attribute is not used.

◆ getSystemType()

IfcDistributionSystemEnum OdIfc4::IfcDistributionPort::getSystemType ( ) const

Returns the value of SystemType attribute. This attribute represents enumeration that identifies the system type. If a system type is defined, the port can only be connected to other ports having the same system type.

Returns: Returns the value of SystemType attribute.

◆ inFields()

virtual OdResult OdIfc4::IfcDistributionPort::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 OdIfc4::IfcPort.

◆ isKindOf()

virtual bool OdIfc4::IfcDistributionPort::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 OdIfc4::IfcPort.

◆ outFields()

virtual OdResult OdIfc4::IfcDistributionPort::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 OdIfc4::IfcPort.

◆ putAttr() [1/2]

virtual bool OdIfc4::IfcDistributionPort::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 OdIfc4::IfcProduct.

◆ putAttr() [2/2]

virtual bool OdIfc4::IfcDistributionPort::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 OdIfc4::IfcPort.

◆ setFlowDirection()

void OdIfc4::IfcDistributionPort::setFlowDirection ( IfcFlowDirectionEnum FlowDirection )

Sets the value of FlowDirection attribute. This attribute represents enumeration that identifies if this port is a Sink (inlet), a Source (outlet) or both a SinkAndSource.

Parameters

FlowDirection [in] Flow direction to set.

◆ setPredefinedType()

void OdIfc4::IfcDistributionPort::setPredefinedType ( IfcDistributionPortTypeEnum PredefinedType )

Sets the value of PredefinedType attribute. This attribute represents a list of types to further identify the object. Some property sets can be specifically applicable to one of these types.

Parameters

PredefinedType [in] Predefined type to set.

Remarks: If the object has an associated IfcTypeObject with a PredefinedType, then this attribute is not used.

◆ setSystemType()

void OdIfc4::IfcDistributionPort::setSystemType ( IfcDistributionSystemEnum SystemType )

Sets the value of SystemType attribute. This attribute represents enumeration that identifies the system type. If a system type is defined, the port can only be connected to other ports having the same system type.

Parameters

SystemType [in] System type to set.

◆ testAttr() [1/2]

virtual bool OdIfc4::IfcDistributionPort::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 OdIfc4::IfcPort.

◆ testAttr() [2/2]

virtual bool OdIfc4::IfcDistributionPort::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 OdIfc4::IfcPort.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcDistributionPort::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 OdIfc4::IfcPort.

◆ unsetAttr() [1/2]

virtual void OdIfc4::IfcDistributionPort::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc4::IfcPort.

◆ unsetAttr() [2/2]

virtual void OdIfc4::IfcDistributionPort::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 OdIfc4::IfcPort.

Member Data Documentation

◆ m_FlowDirection

OdDAI::Enum OdIfc4::IfcDistributionPort::m_FlowDirection

protected

Definition at line 281 of file Ifc4/IfcDistributionPortAutoImpl.h.

◆ m_PredefinedType

OdDAI::Enum OdIfc4::IfcDistributionPort::m_PredefinedType

protected

Definition at line 282 of file Ifc4/IfcDistributionPortAutoImpl.h.

◆ m_SystemType

OdDAI::Enum OdIfc4::IfcDistributionPort::m_SystemType

protected

Definition at line 283 of file Ifc4/IfcDistributionPortAutoImpl.h.

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

Ifc4/IfcDistributionPortAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcDistributionPort()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getFlowDirection()

◆ getInstanceType()

◆ getPredefinedType()

◆ getSystemType()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setFlowDirection()

◆ setPredefinedType()

◆ setSystemType()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_FlowDirection

◆ m_PredefinedType

◆ m_SystemType