#include <IfcPortAutoImpl.h>

Inheritance diagram for OdIfc4::IfcPort:

Public Member Functions
void	getInvContainedIn (OdDAIObjectIds &ContainedIn) const

void	getInvConnectedFrom (OdDAIObjectIds &ConnectedFrom) const

void	getInvConnectedTo (OdDAIObjectIds &ConnectedTo) 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 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 Member Functions
virtual OdRxValue	getAttr (const char *attrName) const override

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

Friends
class	IfcRelConnectsPortToElement

class	IfcRelConnectsPorts

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 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

Detailed Description

A port provides the means for an element to connect to other elements.

An IfcPort is associated with an IfcElement, it belongs to through the objectified relationship IfcRelNests if such port is fixed, or IfcRelConnectsPortToElement if such port is dynamically attached. Exactly two ports, belonging to two different elements, are connected with each other through the objectified relationship IfcRelConnectsPorts.

An instance of IfcElement can have one or more points at which it connects to other instances of IfcElement. An instance of IfcPort is located at a point where a connection can occur. The location of the port is determined in the context of the local coordinate system of the element to which it belongs.

The local placement for IfcPort is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations. The PlacementRelTo relationship of IfcLocalPlacement points to the local placement of the master IfcElement or IfcElementType (relevant subtypes), which is related to the IfcPort by the relationship object IfcRelNests for fixed ports, or IfcRelConnectsPortToElement for dynamic ports.

\changes

IFC4 changes: Type of the inverse attribute ContainedIn changed from "IfcRelConnectsPortToElement FOR RelatingPort" to "SET OF [0:1] IfcRelConnectsPortToElement FOR RelatingPort".

Definition at line 57 of file Ifc4/IfcPortAutoImpl.h.

Member Function Documentation

◆ comparedToEarlyImpl()

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

Reimplemented in OdIfc4::IfcDistributionPort.

◆ getAttr() [1/2]

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

◆ getAttr() [2/2]

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

Reimplemented in OdIfc4::IfcDistributionPort.

◆ getInstanceType()

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

Reimplemented in OdIfc4::IfcDistributionPort.

◆ getInvConnectedFrom()

void OdIfc4::IfcPort::getInvConnectedFrom ( OdDAIObjectIds & ConnectedFrom ) const

Returns the value of ConnectedFrom attribute. This attribute represents reference to a port that is connected by the objectified relationship.

Parameters

ConnectedFrom [out] Receives the value of ConnectedFrom attribute.

◆ getInvConnectedTo()

void OdIfc4::IfcPort::getInvConnectedTo ( OdDAIObjectIds & ConnectedTo ) const

Returns the value of ConnectedTo attribute. This attribute represents reference to the port connection relationship. The relationship then refers to the other port to which this port is connected.

Parameters

ConnectedTo [out] Receives the value of ConnectedTo attribute.

◆ getInvContainedIn()

void OdIfc4::IfcPort::getInvContainedIn ( OdDAIObjectIds & ContainedIn ) const

Returns the value of ContainedIn attribute. This attribute represents reference to the element to port connection relationship. The relationship then refers to the element in which this port is contained.

Parameters

ContainedIn [out] Receives the value of ContainedIn attribute.

Remarks: IFC4 CHANGE: The cardinality has been changed from 1:1 to 0:1. IFC4 DEPRECATION: The inverse relationship is deprecated for fixed ports due to deprecation of IfcRelConnectsPortToElement for this usage. Use inverse relationship Nests instead.

◆ inFields()

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

Reimplemented in OdIfc4::IfcDistributionPort.

◆ isKindOf()

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

Reimplemented in OdIfc4::IfcDistributionPort.

◆ outFields()

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

Reimplemented in OdIfc4::IfcDistributionPort.

◆ putAttr() [1/2]

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

◆ putAttr() [2/2]

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

Reimplemented in OdIfc4::IfcDistributionPort.

◆ testAttr() [1/2]

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

Reimplemented in OdIfc4::IfcDistributionPort.

◆ testAttr() [2/2]

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

Reimplemented in OdIfc4::IfcDistributionPort.

◆ type()

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

Reimplemented in OdIfc4::IfcDistributionPort.

◆ unsetAttr() [1/2]

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

Reimplemented in OdIfc4::IfcDistributionPort.

◆ unsetAttr() [2/2]

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

Reimplemented in OdIfc4::IfcDistributionPort.

Friends And Related Symbol Documentation

◆ IfcRelConnectsPorts

IfcRelConnectsPorts

friend

Definition at line 211 of file Ifc4/IfcPortAutoImpl.h.

◆ IfcRelConnectsPortToElement

friend class IfcRelConnectsPortToElement

friend

Definition at line 210 of file Ifc4/IfcPortAutoImpl.h.

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

Ifc4/IfcPortAutoImpl.h

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getInstanceType()

◆ getInvConnectedFrom()

◆ getInvConnectedTo()

◆ getInvContainedIn()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Friends And Related Symbol Documentation

◆ IfcRelConnectsPorts

◆ IfcRelConnectsPortToElement