CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc2x_final::IfcControlElement Class Reference

#include <IfcControlElementAutoImpl.h>

Inheritance diagram for OdIfc2x_final::IfcControlElement:
OdIfc2x_final::IfcDistributionElement OdIfc2x_final::IfcElement OdIfc2x_final::IfcProduct OdIfc2x_final::IfcObject OdIfc2x_final::IfcRoot OdIfc2x_final::OdIfc2x_FinalInstance OdIfc::OdIfcInstance OdIfc2x_final::IfcActuator OdIfc2x_final::IfcController OdIfc2x_final::IfcSensor

Public Member Functions

const OdAnsiString & getControlElementId () const
 
void setControlElementId (const OdAnsiString &ControlElementId)
 
void getInvAssignedToFlowElement (OdDAIObjectIds &AssignedToFlowElement) const
 
 IfcControlElement ()
 
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 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 OdIfc2x_final::IfcElement
const OdAnsiString & getTag () const
 
void setTag (const OdAnsiString &Tag)
 
void getInvConnectedTo (OdDAIObjectIds &ConnectedTo) const
 
void getInvConnectedFrom (OdDAIObjectIds &ConnectedFrom) const
 
void getInvContainedInStructure (OdDAIObjectIds &ContainedInStructure) const
 
 IfcElement ()
 
- Public Member Functions inherited from OdIfc2x_final::IfcProduct
const OdDAIObjectId & getObjectPlacement () const
 
void setObjectPlacement (const OdDAIObjectId &ObjectPlacement)
 
const OdDAIObjectId & getRepresentation () const
 
void setRepresentation (const OdDAIObjectId &Representation)
 
void getInvReferencedBy (OdDAIObjectIds &ReferencedBy) const
 
- Public Member Functions inherited from OdIfc2x_final::IfcObject
const OdAnsiString & getObjectType () const
 
void setObjectType (const OdAnsiString &ObjectType)
 
void getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
void getInvHasAssignments (OdDAIObjectIds &HasAssignments) const
 
void getInvDecomposes (OdDAIObjectIds &Decomposes) const
 
void getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const
 
 IfcObject ()
 
- Public Member Functions inherited from OdIfc2x_final::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 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 Attributes

OdAnsiString m_ControlElementId
 
- Protected Attributes inherited from OdIfc2x_final::IfcElement
OdAnsiString m_Tag
 
- Protected Attributes inherited from OdIfc2x_final::IfcProduct
OdDAIObjectId m_ObjectPlacement
 
OdDAIObjectId m_Representation
 
- Protected Attributes inherited from OdIfc2x_final::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc2x_final::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
 

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)
 

Detailed Description

This class defines elements of a building automation control system that are used to impart control over elements of a distribution system. This class defines elements of a building automation control system. These are typically used to control distribution system elements to maintain temperature, humidity, pressure, flow, power, lighting levels, etc., through the modulation, staging or sequencing of mechanical or electrical devices. The three general functional categories of ControlElements as defined for this release of the IFC model are as follows: Impart control over flow control elements (IfcFlowController) in a distribution system such as dampers, valves, relays, etc., typically through the use of actuation (IfcActuator: See IfcHvacDomain schema). Sensing elements (IfcSensor: See IfcHvacDomain schema) that measure changes in the controlled variable (e.g., temperature, humidity, pressure, flow, etc.). Controllers (IfcController: See IfcHvacDomain schema) typically classified according to the control action they seek to perform and generally responsible for making decisions about the elements under control.

Definition at line 50 of file IfcControlElementAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcControlElement()

OdIfc2x_final::IfcControlElement::IfcControlElement ( )

Default constructor for the IfcControlElement class.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x_final::IfcControlElement::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 OdIfc2x_final::IfcElement.

Reimplemented in OdIfc2x_final::IfcActuator, and OdIfc2x_final::IfcSensor.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x_final::IfcControlElement::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 OdIfc2x_final::IfcElement.

Reimplemented in OdIfc2x_final::IfcActuator, and OdIfc2x_final::IfcSensor.

◆ getControlElementId()

const OdAnsiString & OdIfc2x_final::IfcControlElement::getControlElementId ( ) const

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

Returns
Returns the value of ControlElementId attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x_final::IfcControlElement::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 OdIfc2x_final::IfcDistributionElement.

Reimplemented in OdIfc2x_final::IfcActuator, OdIfc2x_final::IfcController, and OdIfc2x_final::IfcSensor.

◆ getInvAssignedToFlowElement()

void OdIfc2x_final::IfcControlElement::getInvAssignedToFlowElement ( OdDAIObjectIds & AssignedToFlowElement) const

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

Returns
Returns the value of AssignedToFlowElement attribute.

◆ inFields()

virtual OdResult OdIfc2x_final::IfcControlElement::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 OdIfc2x_final::IfcElement.

Reimplemented in OdIfc2x_final::IfcActuator, and OdIfc2x_final::IfcSensor.

◆ isKindOf()

virtual bool OdIfc2x_final::IfcControlElement::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 OdIfc2x_final::IfcDistributionElement.

Reimplemented in OdIfc2x_final::IfcActuator, OdIfc2x_final::IfcController, and OdIfc2x_final::IfcSensor.

◆ outFields()

virtual OdResult OdIfc2x_final::IfcControlElement::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 OdIfc2x_final::IfcElement.

Reimplemented in OdIfc2x_final::IfcActuator, and OdIfc2x_final::IfcSensor.

◆ putAttr() [1/2]

virtual bool OdIfc2x_final::IfcControlElement::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 OdIfc2x_final::IfcElement.

Reimplemented in OdIfc2x_final::IfcActuator, and OdIfc2x_final::IfcSensor.

◆ putAttr() [2/2]

virtual bool OdIfc2x_final::IfcControlElement::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 OdIfc2x_final::IfcElement.

Reimplemented in OdIfc2x_final::IfcActuator, and OdIfc2x_final::IfcSensor.

◆ setControlElementId()

void OdIfc2x_final::IfcControlElement::setControlElementId ( const OdAnsiString & ControlElementId)

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

Parameters
ControlElementId[in] ControlElementId attribute to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x_final::IfcControlElement::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 OdIfc2x_final::IfcElement.

Reimplemented in OdIfc2x_final::IfcActuator, and OdIfc2x_final::IfcSensor.

◆ testAttr() [2/2]

virtual bool OdIfc2x_final::IfcControlElement::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 OdIfc2x_final::IfcElement.

Reimplemented in OdIfc2x_final::IfcActuator, and OdIfc2x_final::IfcSensor.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x_final::IfcControlElement::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 OdIfc2x_final::IfcDistributionElement.

Reimplemented in OdIfc2x_final::IfcActuator, OdIfc2x_final::IfcController, and OdIfc2x_final::IfcSensor.

◆ unsetAttr() [1/2]

virtual void OdIfc2x_final::IfcControlElement::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc2x_final::IfcElement.

Reimplemented in OdIfc2x_final::IfcActuator, and OdIfc2x_final::IfcSensor.

◆ unsetAttr() [2/2]

virtual void OdIfc2x_final::IfcControlElement::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 OdIfc2x_final::IfcElement.

Reimplemented in OdIfc2x_final::IfcActuator, and OdIfc2x_final::IfcSensor.

Friends And Related Symbol Documentation

◆ IfcRelFlowControlElements

friend class IfcRelFlowControlElements
friend

Definition at line 202 of file IfcControlElementAutoImpl.h.

Member Data Documentation

◆ m_ControlElementId

OdAnsiString OdIfc2x_final::IfcControlElement::m_ControlElementId
protected

Definition at line 199 of file IfcControlElementAutoImpl.h.


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