#include <IfcDistributionControlElementAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcDistributionControlElement:

Public Member Functions
const OdAnsiString &	getControlElementId () const

void	setControlElementId (const OdAnsiString &ControlElementId)

void	getInvAssignedToFlowElement (OdDAIObjectIds &AssignedToFlowElement) const

	IfcDistributionControlElement ()

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 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 OdGsCache *	gsNode () const

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *traits) const

virtual bool	subWorldDraw (OdGiWorldDraw *wd) const

virtual OdDbStub *	ownerId () const

Protected Attributes
OdAnsiString	m_ControlElementId

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
void *	m_resPtr

IfcOpResult	m_resolved

Friends
class	IfcRelFlowControlElements

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)

Detailed Description

The distribution element IfcDistributionControlElement defines occurrence elements of a building automation control system that are used to impart control over elements of a distribution system.

IfcDistributionControlElement defines elements of a building automation control system. They are typically used to control distribution system elements to maintain variables such as temperature, humidity, pressure, flow, power, etc. The three general functional categories of control elements are as follows: Impart control over flow control elements (IfcFlowController) in a distribution system such as dampers, valves, or relays, typically through the use of actuation (IfcActuator). Sensing elements (IfcSensor) that measure changes in the controlled variable such as temperature, humidity, pressure, or flow. Controllers (IfcController) typically classified according to the control action they seek to perform and generally responsible for making decisions about the elements under control.

Since IfcDistributionControlElement and its subtypes typically relate to many different distribution flow elements (IfcDistributionFlowElement), the objectified relationship IfcRelFlowControlElements has been provided to relate control and flow elements as required.

The key distinction between IfcDistributionFlowElement and IfcDistributionControlElement is whether it is internal or external to the flow system, respectively. For example, the distinction between IfcFlowMeter (subtype of IfcDistributionFlowElement measuring a flow quantity) and IfcFlowInstrument (subtype of IfcDistributionControlElement measuring a flow quality), is based on this principal. A physical device that connects within the flow system in which it measures (having inlet/outlet pipes for the measured substance) follows the IfcDistributionFlowElement hierarchy (and therefore IfcFlowMeter which measures the flow internally). Otherwise, if it monitors/controls but does not connect inline within the flow system (it is external or is a component of another device), then it follows the IfcDistributionControlElement hierarchy (and therefore IfcFlowInstrument which can display various attributes through connected sensors).

Definition at line 60 of file Ifc2x3/IfcDistributionControlElementAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcDistributionControlElement()

OdIfc2x3::IfcDistributionControlElement::IfcDistributionControlElement ( )

Default constructor for the IfcDistributionControlElement class.

Member Function Documentation

◆ comparedToEarlyImpl()

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

◆ getAttr() [1/2]

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

◆ getAttr() [2/2]

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

◆ getControlElementId()

const OdAnsiString & OdIfc2x3::IfcDistributionControlElement::getControlElementId ( ) const

Returns the value of ControlElementId attribute. This attribute represents the identification assigned to this control element by the Building Automation System.

Returns: Returns the value of ControlElementId attribute.

◆ getInstanceType()

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

◆ getInvAssignedToFlowElement()

void OdIfc2x3::IfcDistributionControlElement::getInvAssignedToFlowElement ( OdDAIObjectIds & AssignedToFlowElement ) const

Returns the value of AssignedToFlowElement attribute. This attribute represents reference through the relationship object to related distribution flow elements.

Parameters

AssignedToFlowElement [out] Receives the value of AssignedToFlowElement attribute.

◆ inFields()

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

◆ isKindOf()

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

◆ outFields()

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

◆ putAttr() [1/2]

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

◆ putAttr() [2/2]

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

◆ setControlElementId()

void OdIfc2x3::IfcDistributionControlElement::setControlElementId ( const OdAnsiString & ControlElementId )

Sets the value of ControlElementId attribute. This attribute represents the identification assigned to this control element by the Building Automation System.

Parameters

ControlElementId [in] ControlElementId attribute to set.

◆ testAttr() [1/2]

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

◆ testAttr() [2/2]

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

◆ type()

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

◆ unsetAttr() [1/2]

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

◆ unsetAttr() [2/2]

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

Friends And Related Symbol Documentation

◆ IfcRelFlowControlElements

friend class IfcRelFlowControlElements

friend

Definition at line 228 of file Ifc2x3/IfcDistributionControlElementAutoImpl.h.

Member Data Documentation

◆ m_ControlElementId

OdAnsiString OdIfc2x3::IfcDistributionControlElement::m_ControlElementId

protected

Definition at line 225 of file Ifc2x3/IfcDistributionControlElementAutoImpl.h.

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

Ifc2x3/IfcDistributionControlElementAutoImpl.h

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcDistributionControlElement()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getControlElementId()

◆ getInstanceType()

◆ getInvAssignedToFlowElement()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setControlElementId()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Friends And Related Symbol Documentation

◆ IfcRelFlowControlElements

Member Data Documentation

◆ m_ControlElementId