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

#include <IfcDamperAutoImpl.h>

Inheritance diagram for OdIfc2x_final::IfcDamper:
OdIfc2x_final::IfcFlowController OdIfc2x_final::IfcDistributionFlowElement OdIfc2x_final::IfcDistributionElement OdIfc2x_final::IfcElement OdIfc2x_final::IfcProduct OdIfc2x_final::IfcObject OdIfc2x_final::IfcRoot OdIfc2x_final::OdIfc2x_FinalInstance OdIfc::OdIfcInstance

Public Member Functions

IfcDamperTypeEnum getPredefinedType () const
 
void setPredefinedType (IfcDamperTypeEnum PredefinedType)
 
double getFrameDepth () const
 
void setFrameDepth (double FrameDepth)
 
IfcDamperSizingMethodEnum getSizingMethod () const
 
void setSizingMethod (IfcDamperSizingMethodEnum SizingMethod)
 
double getCloseOffRating () const
 
void setCloseOffRating (double CloseOffRating)
 
double getLeakageAirFlowRate () const
 
void setLeakageAirFlowRate (double LeakageAirFlowRate)
 
double getPercentOpen () const
 
void setPercentOpen (double PercentOpen)
 
 IfcDamper ()
 
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::IfcDistributionFlowElement
IfcDistributionFlowElementTypeEnum getFlowElementType () const
 
void setFlowElementType (IfcDistributionFlowElementTypeEnum FlowElementType)
 
void getInvHasControlElements (OdDAIObjectIds &HasControlElements) const
 
 IfcDistributionFlowElement ()
 
- 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

OdDAI::Enum m_PredefinedType
 
double m_FrameDepth
 
OdDAI::Enum m_SizingMethod
 
double m_CloseOffRating
 
double m_LeakageAirFlowRate
 
IfcPositiveRatioMeasure m_PercentOpen
 
- Protected Attributes inherited from OdIfc2x_final::IfcDistributionFlowElement
OdDAI::Enum m_FlowElementType
 
- 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
 

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

A damper typically participates in an HVAC duct distribution system and is used to control or modulate the flow of air.

  • Material Set - This concept can be applied to the following resources: Blade - The material from which the damper blades are constructed. Frame - The material from which the damper frame is constructed. Seal - The material from which the damper seals are constructed.
  • Object Typing - This concept can be applied to the following resources: IfcDamperType
  • Port Nesting - This concept can be applied with the following combinations:

PortName Flow PredefinedType AirIn SINK AIRCONDITIONING AirOut SOURCE AIRCONDITIONING

Definition at line 58 of file Ifc2x_Final/IfcDamperAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcDamper()

OdIfc2x_final::IfcDamper::IfcDamper ( )

Default constructor for the IfcDamper class.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x_final::IfcDamper::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::IfcDistributionFlowElement.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x_final::IfcDamper::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::IfcDistributionFlowElement.

◆ getCloseOffRating()

double OdIfc2x_final::IfcDamper::getCloseOffRating ( ) const

Returns the value of CloseOffRating attribute. This attribute represents the maximum pressure drop that a valve can withstand without leakage while in the fully closed position.

Returns
Returns the value of CloseOffRating attribute.

◆ getFrameDepth()

double OdIfc2x_final::IfcDamper::getFrameDepth ( ) const

Returns the value of FrameDepth attribute. This attribute represents the length (or depth) of the damper frame.

Returns
Returns the value of FrameDepth attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x_final::IfcDamper::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::IfcFlowController.

◆ getLeakageAirFlowRate()

double OdIfc2x_final::IfcDamper::getLeakageAirFlowRate ( ) const

Returns the value of LeakageAirFlowRate attribute. This attribute represents the volume of air that still passes through a fully closed damper.

Returns
Returns the value of LeakageAirFlowRate attribute.

◆ getPercentOpen()

double OdIfc2x_final::IfcDamper::getPercentOpen ( ) const

Returns the value of PercentOpen attribute. This attribute represents the percentage open position for the damper blades. This value varies for dampers under automatic control, but typically remain fixed for dampers used for balancing purposes.

Returns
Returns the value of PercentOpen attribute.

◆ getPredefinedType()

IfcDamperTypeEnum OdIfc2x_final::IfcDamper::getPredefinedType ( ) const

Returns the value of PredefinedType attribute. This attribute represents 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.

◆ getSizingMethod()

IfcDamperSizingMethodEnum OdIfc2x_final::IfcDamper::getSizingMethod ( ) const

Returns the value of SizingMethod attribute. This attribute indicates whether the damper is sized nominally or with exact measurements.

Returns
Returns the value of SizingMethod attribute.

◆ inFields()

virtual OdResult OdIfc2x_final::IfcDamper::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::IfcDistributionFlowElement.

◆ isKindOf()

virtual bool OdIfc2x_final::IfcDamper::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::IfcFlowController.

◆ outFields()

virtual OdResult OdIfc2x_final::IfcDamper::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::IfcDistributionFlowElement.

◆ putAttr() [1/2]

virtual bool OdIfc2x_final::IfcDamper::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::IfcDistributionFlowElement.

◆ putAttr() [2/2]

virtual bool OdIfc2x_final::IfcDamper::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::IfcDistributionFlowElement.

◆ setCloseOffRating()

void OdIfc2x_final::IfcDamper::setCloseOffRating ( double CloseOffRating)

Sets the value of CloseOffRating attribute. This attribute represents the maximum pressure drop that a valve can withstand without leakage while in the fully closed position.

Parameters
CloseOffRating[in] CloseOffRating attribute to set.

◆ setFrameDepth()

void OdIfc2x_final::IfcDamper::setFrameDepth ( double FrameDepth)

Sets the value of FrameDepth attribute. This attribute represents the length (or depth) of the damper frame.

Parameters
FrameDepth[in] Frame depth to set.

◆ setLeakageAirFlowRate()

void OdIfc2x_final::IfcDamper::setLeakageAirFlowRate ( double LeakageAirFlowRate)

Sets the value of LeakageAirFlowRate attribute. This attribute represents the volume of air that still passes through a fully closed damper.

Parameters
LeakageAirFlowRate[in] LeakageAirFlowRate attribute to set.

◆ setPercentOpen()

void OdIfc2x_final::IfcDamper::setPercentOpen ( double PercentOpen)

Sets the value of PercentOpen attribute. This attribute represents the percentage open position for the damper blades. This value varies for dampers under automatic control, but typically remain fixed for dampers used for balancing purposes.

Parameters
PercentOpen[in] PercentOpen attribute to set.

◆ setPredefinedType()

void OdIfc2x_final::IfcDamper::setPredefinedType ( IfcDamperTypeEnum PredefinedType)

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

Parameters
PredefinedType[in] PredefinedType to set.

◆ setSizingMethod()

void OdIfc2x_final::IfcDamper::setSizingMethod ( IfcDamperSizingMethodEnum SizingMethod)

Sets the value of SizingMethod attribute. This attribute indicates whether the damper is sized nominally or with exact measurements.

Parameters
SizingMethod[in] Sizing method to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x_final::IfcDamper::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::IfcDistributionFlowElement.

◆ testAttr() [2/2]

virtual bool OdIfc2x_final::IfcDamper::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::IfcDistributionFlowElement.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x_final::IfcDamper::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::IfcFlowController.

◆ unsetAttr() [1/2]

virtual void OdIfc2x_final::IfcDamper::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::IfcDistributionFlowElement.

◆ unsetAttr() [2/2]

virtual void OdIfc2x_final::IfcDamper::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::IfcDistributionFlowElement.

Member Data Documentation

◆ m_CloseOffRating

double OdIfc2x_final::IfcDamper::m_CloseOffRating
protected

Definition at line 281 of file Ifc2x_Final/IfcDamperAutoImpl.h.

◆ m_FrameDepth

double OdIfc2x_final::IfcDamper::m_FrameDepth
protected

Definition at line 279 of file Ifc2x_Final/IfcDamperAutoImpl.h.

◆ m_LeakageAirFlowRate

double OdIfc2x_final::IfcDamper::m_LeakageAirFlowRate
protected

Definition at line 282 of file Ifc2x_Final/IfcDamperAutoImpl.h.

◆ m_PercentOpen

IfcPositiveRatioMeasure OdIfc2x_final::IfcDamper::m_PercentOpen
protected

Definition at line 283 of file Ifc2x_Final/IfcDamperAutoImpl.h.

◆ m_PredefinedType

OdDAI::Enum OdIfc2x_final::IfcDamper::m_PredefinedType
protected

Definition at line 278 of file Ifc2x_Final/IfcDamperAutoImpl.h.

◆ m_SizingMethod

OdDAI::Enum OdIfc2x_final::IfcDamper::m_SizingMethod
protected

Definition at line 280 of file Ifc2x_Final/IfcDamperAutoImpl.h.


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