#include <IfcDistributionSystemAutoImpl.h>

Inheritance diagram for OdIfc4::IfcDistributionSystem:

Public Member Functions
const OdAnsiString &	getLongName () const

void	setLongName (const OdAnsiString &LongName)

IfcDistributionSystemEnum	getPredefinedType () const

void	setPredefinedType (IfcDistributionSystemEnum PredefinedType)

	IfcDistributionSystem ()

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::IfcSystem
void	getInvServicesBuildings (OdDAIObjectIds &ServicesBuildings) const

Public Member Functions inherited from OdIfc4::IfcGroup
void	getInvIsGroupedBy (OdDAIObjectIds &IsGroupedBy) const

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

OdDAI::Enum	m_PredefinedType

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::IfcSystem
virtual OdRxValue	getAttr (const char *attrName) const override

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

Detailed Description

A distribution system is a network designed to receive, store, maintain, distribute, or control the flow of a distribution media. A common example is a heating hot water system that consists of a pump, a tank, and an interconnected piping system for distributing hot water to terminals.

The group IfcDistributionSystem defines the occurrence of a specialized system for use within the context of building services or utilities for built facilities. Important functionalities for the description of a distribution system are derived from existing IFC entities: From IfcSystem it inherits the ability to couple the built system via IfcRelReferencedInSpatialStructure to one or more IfcSpatialElement subtypes as necessary. From IfcGroup it inherits the inverse attribute IsGroupedBy, pointing to the relationship class IfcRelAssignsToGroup. This allows the grouping of distribution elements (instances of IfcDistributionElement subtypes). From IfcObjectDefinition it inherits the inverse attribute IsDecomposedBy pointing to the relationship class IfcRelAggregates. It provides the hierarchy between the separate (partial) distribution systems. For example, an electrical main circuit can be aggregated into branch circuits.

Property Sets for Objects - The Property Sets for Objects concept template applies to this entity under Pset_DistributionSystemCommon name as shown in table below:

Template

PropertyName Value Single value AssetAccountingType IfcBoolean

Group Assignment - The Group Assignment concept template applies to this entity as shown in table below.

IsGrouped

RelatedObjects Description Physical elements that comprise the asset.

For the most common case of an IfcDistributionElement subtype containing ports of a particular PredefinedType that all belong to the same distribution system, the IfcDistributionElement is assigned to the IfcDistributionSystem via the IfcRelAssignsToGroup relationship, where IfcDistributionPort's are implied as part of the corresponding system based on their PredefinedType. An IfcDistributionElement can belong to multiple systems, however only one IfcDistributionSystem of a particular PredefinedType.

EXAMPLE: A gas-powered hot water heater can have three ports: GAS, DOMESTICCOLDWATER, and DOMESTICHOTWATER. The heater is a member of two systems (GAS and DOMESTICCOLDWATER), and hosts one system (DOMESTICHOTWATER) at the corresponding port.

The next image illustrates a distribution system for an electrical circuit.

\changes

IFC4 changes: For electrical power systems, IfcElectricalCircuit has been used for low-voltage (12-1000 V) power circuits and has been replaced by IfcDistributionCircuit in IFC4; IfcDistributionSystem with PredefinedType 'ELECTRICAL' should be used for overall power systems, and IfcDistributionCircuit with PredefinedType 'ELECTRICAL' should be used for each switched circuit.

Definition at line 82 of file Ifc4/IfcDistributionSystemAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcDistributionSystem()

OdIfc4::IfcDistributionSystem::IfcDistributionSystem ( )

Default constructor for the IfcDistributionSystem class.

Member Function Documentation

◆ comparedToEarlyImpl()

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

Reimplemented in OdIfc4::IfcDistributionCircuit.

◆ getAttr() [1/2]

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

◆ getAttr() [2/2]

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

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcDistributionSystem::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::IfcSystem.

Reimplemented in OdIfc4::IfcDistributionCircuit.

◆ getLongName()

const OdAnsiString & OdIfc4::IfcDistributionSystem::getLongName ( ) const

Returns the value of LongName attribute. This attribute represents long name for a distribution system, used for informal purposes. It should be used, if available, in conjunction with the inherited Name attribute.

Returns: Returns the value of LongName attribute.

Remarks: In many scenarios the Name attribute refers to the short name or number of a distribution system or branch circuit, and the LongName refers to a descriptive name.

◆ getPredefinedType()

IfcDistributionSystemEnum OdIfc4::IfcDistributionSystem::getPredefinedType ( ) const

Returns the value of PredefinedType attribute. This attribute represents predefined types of distribution systems.

Returns: Returns the value of PredefinedType attribute.

◆ inFields()

virtual OdResult OdIfc4::IfcDistributionSystem::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::IfcSystem.

◆ isKindOf()

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

Reimplemented in OdIfc4::IfcDistributionCircuit.

◆ outFields()

virtual OdResult OdIfc4::IfcDistributionSystem::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::IfcSystem.

◆ putAttr() [1/2]

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

◆ putAttr() [2/2]

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

◆ setLongName()

void OdIfc4::IfcDistributionSystem::setLongName ( const OdAnsiString & LongName )

Sets the value of LongName attribute. This attribute represents long name for a distribution system, used for informal purposes. It should be used, if available, in conjunction with the inherited Name attribute.

Parameters

LongName [in] Long name to set.

Remarks: In many scenarios the Name attribute refers to the short name or number of a distribution system or branch circuit, and the LongName refers to a descriptive name.

◆ setPredefinedType()

void OdIfc4::IfcDistributionSystem::setPredefinedType ( IfcDistributionSystemEnum PredefinedType )

Sets the value of PredefinedType attribute. This attribute represents predefined types of distribution systems.

Parameters

PredefinedType [in] Predefined type to set.

◆ testAttr() [1/2]

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

◆ testAttr() [2/2]

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

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcDistributionSystem::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::IfcSystem.

Reimplemented in OdIfc4::IfcDistributionCircuit.

◆ unsetAttr() [1/2]

virtual void OdIfc4::IfcDistributionSystem::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::IfcSystem.

◆ unsetAttr() [2/2]

virtual void OdIfc4::IfcDistributionSystem::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::IfcSystem.

Member Data Documentation

◆ m_LongName

OdAnsiString OdIfc4::IfcDistributionSystem::m_LongName

protected

Definition at line 263 of file Ifc4/IfcDistributionSystemAutoImpl.h.

◆ m_PredefinedType

OdDAI::Enum OdIfc4::IfcDistributionSystem::m_PredefinedType

protected

Definition at line 264 of file Ifc4/IfcDistributionSystemAutoImpl.h.

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

Ifc4/IfcDistributionSystemAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcDistributionSystem()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getInstanceType()

◆ getLongName()

◆ getPredefinedType()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setLongName()

◆ setPredefinedType()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_LongName

◆ m_PredefinedType