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

#include <IfcValveAutoImpl.h>

Inheritance diagram for OdIfc2x_final::IfcValve:
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

double getCloseOffRating () const
 
void setCloseOffRating (double CloseOffRating)
 
const OdDAIObjectId & getValveFlowCoefficient () const
 
void setValveFlowCoefficient (const OdDAIObjectId &ValveFlowCoefficient)
 
IfcValveEnum getValveType () const
 
void setValveType (IfcValveEnum ValveType)
 
 IfcValve ()
 
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

double m_CloseOffRating
 
OdDAIObjectId m_ValveFlowCoefficient
 
OdDAI::Enum m_ValveType
 
- 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 valve is used in a building services piping distribution system to control or modulate the flow of the fluid.

  • Material Set - This concept can be applied to the following resources: Casing - Material from which the casing is constructed. Operation - Material from which the operating mechanism (such as gate, globe, plug, needle, or clack) of the valve is constructed.
  • Object Typing - This concept can be applied to the following resources: IfcValveType
  • Port Nesting - This concept can be applied with the following combinations:
    PortName

Flow PredefinedType Inlet SOURCE AIRHANDLER Outlet SINK NOTDEFINED Inlet SINK CHANGEOVER Outlet#1 SINK CHANGEOVER Outlet#2 SINK NOTDEFINED Inlet SINK NOTDEFINED Outlet SINK NOTDEFINED Outlet SOURCE COMMISSIONING Inlet SINK DIVERTING Outlet#1 SINK NOTDEFINED Outlet#2 SINK NOTDEFINED Inlet SINK DOUBLECHECK Outlet SINK DOUBLECHECK Inlet SINK DOUBLEREGULATING Outlet SINK DOUBLEREGULATING Inlet SINK FAUCET Inlet SINK GAS Inlet SINK GASTAP Inlet SINK ISOLATING Outlet SOURCE ISOLATING Inlet#1 SINK MIXING Inlet#2 SINK NOTDEFINED Outlet SOURCE MIXING Inlet SINK PRESSUREREDUCING Outlet SOURCE PRESSUREREDUCING Inlet SINK PRESSURERELIEF Inlet SINK REGULATING Inlet SOURCE REGULATING Outlet SOURCE SAFETYCUTOFF Inlet SINK STEAMTRAP Inlet SOURCE STEAMTRAP Inlet SINK STOPCOCK

  • Property Sets for Objects - This concept can be applied to the following resources: Pset_ValveTypeCommon Pset_ValveTypeAirRelease (only applies to AIRRELEASE) Pset_ValveTypeDrawOffCock (only applies to DRAWOFFCOCK) Pset_ValveTypeFaucet (only applies to FAUCET) Pset_ValveTypeFlushing (only applies to FLUSHING) Pset_ValveTypeGasTap (only applies to GASTAP) Pset_ValveTypeIsolating (only applies to ISOLATING) Pset_ValveTypeMixing (only applies to MIXING) Pset_ValveTypePressureReducing (only applies to PRESSUREREDUCING) Pset_ValveTypePressureRelief (only applies to PRESSURERELIEF)
  • Quantity Sets - This concept can be applied to the following resources: Qto_ValveBaseQuantities
  • Property Sets for Performance - This concept can be applied to the following resources: Pset_ValvePHistory

Definition at line 109 of file Ifc2x_Final/IfcValveAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcValve()

OdIfc2x_final::IfcValve::IfcValve ( )

Default constructor for the IfcValve class.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x_final::IfcValve::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::IfcValve::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::IfcValve::getCloseOffRating ( ) const

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

Returns
Returns the value of CloseOffRating attribute.

◆ getInstanceType()

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

◆ getValveFlowCoefficient()

const OdDAIObjectId & OdIfc2x_final::IfcValve::getValveFlowCoefficient ( ) const

Returns the value of ValveFlowCoefficient attribute. This attribute represents flow coefficient (the quantity of fluid that passes through a fully open valve at unit pressure drop), typically expressed as the Kv or Cv value for the valve.

Returns
Returns the value of ValveFlowCoefficient attribute.

◆ getValveType()

IfcValveEnum OdIfc2x_final::IfcValve::getValveType ( ) const

Returns the value of ValveType attribute. This attribute represents type of a valve.

Returns
Returns the value of ValveType attribute.

◆ inFields()

virtual OdResult OdIfc2x_final::IfcValve::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::IfcValve::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::IfcValve::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::IfcValve::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::IfcValve::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::IfcValve::setCloseOffRating ( double CloseOffRating)

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

Parameters
CloseOffRating[in] CloseOffRating attribute to set.

◆ setValveFlowCoefficient()

void OdIfc2x_final::IfcValve::setValveFlowCoefficient ( const OdDAIObjectId & ValveFlowCoefficient)

Sets the value of ValveFlowCoefficient attribute. This attribute represents flow coefficient (the quantity of fluid that passes through a fully open valve at unit pressure drop), typically expressed as the Kv or Cv value for the valve.

Parameters
ValveFlowCoefficient[in] ValveFlowCoefficient attribute to set.

◆ setValveType()

void OdIfc2x_final::IfcValve::setValveType ( IfcValveEnum ValveType)

Sets the value of ValveType attribute. This attribute represents type of a valve.

Parameters
ValveType[in] Valve type to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x_final::IfcValve::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::IfcValve::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::IfcValve::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::IfcValve::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::IfcValve::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::IfcValve::m_CloseOffRating
protected

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

◆ m_ValveFlowCoefficient

OdDAIObjectId OdIfc2x_final::IfcValve::m_ValveFlowCoefficient
protected

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

◆ m_ValveType

OdDAI::Enum OdIfc2x_final::IfcValve::m_ValveType
protected

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


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