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

#include <IfcPumpAutoImpl.h>

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

IfcPumpTypeEnum getPumpType () const
 
void setPumpType (IfcPumpTypeEnum PumpType)
 
double getNetPositiveSuctionHead () const
 
void setNetPositiveSuctionHead (double NetPositiveSuctionHead)
 
IfcMaterialSelect impellerSealMaterial ()
 
IfcPumpBaseTypeEnum getPumpBaseType () const
 
void setPumpBaseType (IfcPumpBaseTypeEnum PumpBaseType)
 
IfcMoterConnectionTypeEnum getMotorDriveType () const
 
void setMotorDriveType (IfcMoterConnectionTypeEnum MotorDriveType)
 
 IfcPump ()
 
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::IfcFluidMovingDevice
IfcEnergySourceEnum getPrimaryEnergySource () const
 
void setPrimaryEnergySource (IfcEnergySourceEnum PrimaryEnergySource)
 
double getImpellerDiameter () const
 
void setImpellerDiameter (double ImpellerDiameter)
 
 IfcFluidMovingDevice ()
 
- 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_PumpType
 
double m_NetPositiveSuctionHead
 
OdDAI::Select m_ImpellerSealMaterial
 
OdDAI::Enum m_PumpBaseType
 
OdDAI::Enum m_MotorDriveType
 
- Protected Attributes inherited from OdIfc2x_final::IfcFluidMovingDevice
OdDAI::Enum m_PrimaryEnergySource
 
double m_ImpellerDiameter
 
- 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 pump is a device which imparts mechanical work on fluids or slurries to move them through a channel or pipeline. A typical use of a pump is to circulate chilled water or heating hot water in a building services distribution system.

  • Material Set - This concept can be applied to the following resources: Casing - Material from which the casing is constructed. Impeller - Material from which the impeller of the pump is constructed. In the case of a positive displacement pump, the piston acts as the impeller. Seal - Material from which the impeller shaft seal of the pump is constructed.
  • Object Typing - This concept can be applied to the following resources: IfcPumpType
  • Port Nesting - This concept can be applied with the following combinations:
    PortName

Flow PredefinedType Power SINK ELECTRICAL Inlet SINK NOTDEFINED Outlet SOURCE NOTDEFINED

  • Property Sets for Objects - This concept can be applied to the following resources: Pset_PumpOccurrence Pset_PumpTypeCommon
  • Property Sets for Performance - This concept can be applied to the following resources: Pset_PumpPHistory
  • Quantity Sets - This concept can be applied to the following resources: Qto_PumpBaseQuantities

Definition at line 73 of file Ifc2x_Final/IfcPumpAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcPump()

OdIfc2x_final::IfcPump::IfcPump ( )

Default constructor for the IfcPump class.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x_final::IfcPump::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::IfcFluidMovingDevice.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x_final::IfcPump::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::IfcFluidMovingDevice.

◆ getInstanceType()

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

◆ getMotorDriveType()

IfcMoterConnectionTypeEnum OdIfc2x_final::IfcPump::getMotorDriveType ( ) const

Returns the value of MotorDriveType attribute. This attribute represents the type of connection between the motor and the pump impeller.

Returns
Returns the value of MotorDriveType attribute.

◆ getNetPositiveSuctionHead()

double OdIfc2x_final::IfcPump::getNetPositiveSuctionHead ( ) const

Returns the value of NetPositiveSuctionHead attribute. This attribute represents minimum liquid pressure at pump inlet to prevent cavitation.

Returns
Returns the value of NetPositiveSuctionHead attribute.

◆ getPumpBaseType()

IfcPumpBaseTypeEnum OdIfc2x_final::IfcPump::getPumpBaseType ( ) const

Returns the value of PumpBaseType attribute. This attribute represents the type of base used for centrifugal pumps.

Returns
Returns the value of PumpBaseType attribute.

◆ getPumpType()

IfcPumpTypeEnum OdIfc2x_final::IfcPump::getPumpType ( ) const

Returns the value of PumpType attribute. This attribute represents the type of centrifugal pump typically used in building services.

Returns
Returns the value of PumpType attribute.

◆ impellerSealMaterial()

IfcMaterialSelect OdIfc2x_final::IfcPump::impellerSealMaterial ( )

Returns the value of ImpellerSealMaterial attribute. This attribute represents the material used for the impeller shaft seals.

Returns
Returns the value of ImpellerSealMaterial attribute.

◆ inFields()

virtual OdResult OdIfc2x_final::IfcPump::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::IfcFluidMovingDevice.

◆ isKindOf()

virtual bool OdIfc2x_final::IfcPump::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::IfcFluidMovingDevice.

◆ outFields()

virtual OdResult OdIfc2x_final::IfcPump::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::IfcFluidMovingDevice.

◆ putAttr() [1/2]

virtual bool OdIfc2x_final::IfcPump::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::IfcFluidMovingDevice.

◆ putAttr() [2/2]

virtual bool OdIfc2x_final::IfcPump::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::IfcFluidMovingDevice.

◆ setMotorDriveType()

void OdIfc2x_final::IfcPump::setMotorDriveType ( IfcMoterConnectionTypeEnum MotorDriveType)

Sets the value of MotorDriveType attribute. This attribute represents the type of connection between the motor and the pump impeller.

Parameters
MotorDriveType[in] Motor drive type to set.

◆ setNetPositiveSuctionHead()

void OdIfc2x_final::IfcPump::setNetPositiveSuctionHead ( double NetPositiveSuctionHead)

Sets the value of NetPositiveSuctionHead attribute. This attribute represents minimum liquid pressure at pump inlet to prevent cavitation.

Parameters
NetPositiveSuctionHead[in] NetPositiveSuctionHead attribute to set.

◆ setPumpBaseType()

void OdIfc2x_final::IfcPump::setPumpBaseType ( IfcPumpBaseTypeEnum PumpBaseType)

Sets the value of PumpBaseType attribute. This attribute represents the type of base used for centrifugal pumps.

Parameters
PumpBaseType[in] PumpBaseType attribute to set.

◆ setPumpType()

void OdIfc2x_final::IfcPump::setPumpType ( IfcPumpTypeEnum PumpType)

Sets the value of PumpType attribute. This attribute represents the type of centrifugal pump typically used in building services.

Parameters
PumpType[in] Pump type to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x_final::IfcPump::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::IfcFluidMovingDevice.

◆ testAttr() [2/2]

virtual bool OdIfc2x_final::IfcPump::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::IfcFluidMovingDevice.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x_final::IfcPump::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::IfcFluidMovingDevice.

◆ unsetAttr() [1/2]

virtual void OdIfc2x_final::IfcPump::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::IfcFluidMovingDevice.

◆ unsetAttr() [2/2]

virtual void OdIfc2x_final::IfcPump::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::IfcFluidMovingDevice.

Member Data Documentation

◆ m_ImpellerSealMaterial

OdDAI::Select OdIfc2x_final::IfcPump::m_ImpellerSealMaterial
protected

Definition at line 267 of file Ifc2x_Final/IfcPumpAutoImpl.h.

◆ m_MotorDriveType

OdDAI::Enum OdIfc2x_final::IfcPump::m_MotorDriveType
protected

Definition at line 269 of file Ifc2x_Final/IfcPumpAutoImpl.h.

◆ m_NetPositiveSuctionHead

double OdIfc2x_final::IfcPump::m_NetPositiveSuctionHead
protected

Definition at line 266 of file Ifc2x_Final/IfcPumpAutoImpl.h.

◆ m_PumpBaseType

OdDAI::Enum OdIfc2x_final::IfcPump::m_PumpBaseType
protected

Definition at line 268 of file Ifc2x_Final/IfcPumpAutoImpl.h.

◆ m_PumpType

OdDAI::Enum OdIfc2x_final::IfcPump::m_PumpType
protected

Definition at line 265 of file Ifc2x_Final/IfcPumpAutoImpl.h.


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