CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
OdIfc2x3::IfcElectricalBaseProperties Class Reference

#include <IfcElectricalBasePropertiesAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcElectricalBaseProperties:
OdIfc2x3::IfcEnergyProperties OdIfc2x3::IfcPropertySetDefinition OdIfc2x3::IfcPropertyDefinition OdIfc2x3::IfcRoot OdIfc::OdIfcEntity

Public Member Functions

IfcElectricCurrentEnum getElectricCurrentType () const
 
void setElectricCurrentType (IfcElectricCurrentEnum ElectricCurrentType)
 
double getInputVoltage () const
 
void setInputVoltage (double InputVoltage)
 
double getInputFrequency () const
 
void setInputFrequency (double InputFrequency)
 
double getFullLoadCurrent () const
 
void setFullLoadCurrent (double FullLoadCurrent)
 
double getMinimumCircuitCurrent () const
 
void setMinimumCircuitCurrent (double MinimumCircuitCurrent)
 
double getMaximumPowerInput () const
 
void setMaximumPowerInput (double MaximumPowerInput)
 
double getRatedPowerInput () const
 
void setRatedPowerInput (double RatedPowerInput)
 
int getInputPhase () const
 
void setInputPhase (int InputPhase)
 
 IfcElectricalBaseProperties ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler)
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler)
 
virtual OdDAI::Entity * getInstanceType () const
 
virtual OdRxValue getAttr (const char *attrName) const
 
virtual bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const
 
virtual OdIfc::OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef)
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
- Public Member Functions inherited from OdIfc2x3::IfcEnergyProperties
IfcEnergySequenceEnum getEnergySequence () const
 
void setEnergySequence (IfcEnergySequenceEnum EnergySequence)
 
const OdAnsiString & getUserDefinedEnergySequence () const
 
void setUserDefinedEnergySequence (const OdAnsiString &UserDefinedEnergySequence)
 
 IfcEnergyProperties ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler)
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler)
 
virtual OdDAI::Entity * getInstanceType () const
 
virtual OdRxValue getAttr (const char *attrName) const
 
virtual bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const
 
virtual OdIfc::OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef)
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
- Public Member Functions inherited from OdIfc2x3::IfcPropertySetDefinition
void getInvPropertyDefinitionOf (OdDAIObjectIds &PropertyDefinitionOf) const
 
void getInvDefinesType (OdDAIObjectIds &DefinesType) const
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler)
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler)
 
virtual OdDAI::Entity * getInstanceType () const
 
virtual bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const
 
virtual OdIfc::OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef)
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
- Public Member Functions inherited from OdIfc2x3::IfcPropertyDefinition
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler)
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler)
 
virtual OdDAI::Entity * getInstanceType () const
 
virtual bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const
 
virtual OdIfc::OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef)
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
- Public Member Functions inherited from OdIfc2x3::IfcRoot
OdIfcGUID getGlobalId () const
 
void setGlobalId (OdIfcGUID 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 ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler)
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler)
 
virtual OdDAI::Entity * getInstanceType () const
 
virtual OdRxValue getAttr (const char *attrName) const
 
virtual bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const
 
virtual OdIfc::OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef)
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
- Public Member Functions inherited from OdIfc::OdIfcEntity
 ODRX_DECLARE_MEMBERS (OdIfcEntity)
 
 OdIfcEntity ()
 
 ~OdIfcEntity ()
 
virtual bool isKindOf (OdIfcEntityType entityType) const
 
bool isInstanceOf (OdIfcEntityType entityType) const
 
virtual OdIfcEntityType type () const
 
virtual OdRxValue getAttr (const OdIfcAttribute attrDef) const
 
virtual bool testAttr (const char *explicitAttrName) const
 
virtual bool testAttr (const OdIfcAttribute explicitAttrDef) const
 
virtual void unsetAttr (const char *explicitAttrName)
 
virtual void unsetAttr (const OdIfcAttribute explicitAttrDef)
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool putAttr (const OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
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
 

Protected Attributes

OdDAI::Enum m_ElectricCurrentType
 
double m_InputVoltage
 
double m_InputFrequency
 
double m_FullLoadCurrent
 
double m_MinimumCircuitCurrent
 
double m_MaximumPowerInput
 
double m_RatedPowerInput
 
int m_InputPhase
 
- Protected Attributes inherited from OdIfc2x3::IfcEnergyProperties
OdDAI::Enum m_EnergySequence
 
OdAnsiString m_UserDefinedEnergySequence
 
- Protected Attributes inherited from OdIfc2x3::IfcRoot
OdIfcGUID m_GlobalId
 
OdDAIObjectId m_OwnerHistory
 
OdAnsiString m_Name
 
OdAnsiString m_Description
 
- Protected Attributes inherited from OdIfc::OdIfcEntity
voidm_resPtr
 
IfcOpResult m_resolved
 

Additional Inherited Members

- Static Public Member Functions inherited from OdIfc::OdIfcEntity
static const OdGePoint3dasPoint3d (const OdIfcEntity *pEnt)
 
static const OdGePoint2dasPoint2d (const OdIfcEntity *pEnt)
 
static const OdGeVector3dasVector3d (const OdIfcEntity *pEnt)
 
static const OdGeVector2dasVector2d (const OdIfcEntity *pEnt)
 
static const OdGeMatrix2dasMatrix2d (const OdIfcEntity *pEnt)
 
static const OdGeMatrix3dasMatrix3d (const OdIfcEntity *pEnt)
 
static OdIfcCompoundPtr asCompound (OdSmartPtr< OdIfcEntity > pEnt)
 
static const OdCmEntityColorasRgbColor (const OdIfcEntity *pEnt)
 
- Protected Member Functions inherited from OdIfc2x3::IfcPropertySetDefinition
virtual OdRxValue getAttr (const char *attrName) const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 
virtual OdRxValue getAttr (const char *attrName) const
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val)
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val)
 

Detailed Description

Definition at line 37 of file Ifc2x3/IfcElectricalBasePropertiesAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcElectricalBaseProperties()

OdIfc2x3::IfcElectricalBaseProperties::IfcElectricalBaseProperties ( )

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc2x3::IfcElectricalBaseProperties::comparedToEarlyImpl ( const OdDAI::ApplicationInstance *  pOther,
OdRx::Ordering ordering 
) const
virtual

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::IfcEnergyProperties.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x3::IfcElectricalBaseProperties::getAttr ( const char *  attrName) const
virtual

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::IfcEnergyProperties.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x3::IfcElectricalBaseProperties::getAttr ( const OdIfc::OdIfcAttribute  attrDef) const
virtual

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::IfcEnergyProperties.

◆ getElectricCurrentType()

IfcElectricCurrentEnum OdIfc2x3::IfcElectricalBaseProperties::getElectricCurrentType ( ) const

◆ getFullLoadCurrent()

double OdIfc2x3::IfcElectricalBaseProperties::getFullLoadCurrent ( ) const

◆ getInputFrequency()

double OdIfc2x3::IfcElectricalBaseProperties::getInputFrequency ( ) const

◆ getInputPhase()

int OdIfc2x3::IfcElectricalBaseProperties::getInputPhase ( ) const

◆ getInputVoltage()

double OdIfc2x3::IfcElectricalBaseProperties::getInputVoltage ( ) const

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcElectricalBaseProperties::getInstanceType ( ) const
virtual

Returns a type of a class instance.

Returns
Pointer to the <link OdDAI__Entity, OdDAI::Entity> type that determines an entity definition within a schema.

Reimplemented from OdIfc2x3::IfcEnergyProperties.

◆ getMaximumPowerInput()

double OdIfc2x3::IfcElectricalBaseProperties::getMaximumPowerInput ( ) const

◆ getMinimumCircuitCurrent()

double OdIfc2x3::IfcElectricalBaseProperties::getMinimumCircuitCurrent ( ) const

◆ getRatedPowerInput()

double OdIfc2x3::IfcElectricalBaseProperties::getRatedPowerInput ( ) const

◆ inFields()

virtual OdResult OdIfc2x3::IfcElectricalBaseProperties::inFields ( OdDAI::OdSpfFilerBase *  rdFiler)
virtual

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::IfcEnergyProperties.

◆ isKindOf()

virtual bool OdIfc2x3::IfcElectricalBaseProperties::isKindOf ( OdIfc::OdIfcEntityType  entityType) const
virtual

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::IfcEnergyProperties.

◆ outFields()

virtual OdResult OdIfc2x3::IfcElectricalBaseProperties::outFields ( OdDAI::OdSpfFilerBase *  wrFiler)
virtual

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::IfcEnergyProperties.

◆ putAttr() [1/2]

virtual bool OdIfc2x3::IfcElectricalBaseProperties::putAttr ( const char *  explicitAttrName,
const OdRxValue val 
)
virtual

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::IfcEnergyProperties.

◆ putAttr() [2/2]

virtual bool OdIfc2x3::IfcElectricalBaseProperties::putAttr ( const OdIfc::OdIfcAttribute  explicitAttrDef,
const OdRxValue val 
)
virtual

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::IfcEnergyProperties.

◆ setElectricCurrentType()

void OdIfc2x3::IfcElectricalBaseProperties::setElectricCurrentType ( IfcElectricCurrentEnum  ElectricCurrentType)

◆ setFullLoadCurrent()

void OdIfc2x3::IfcElectricalBaseProperties::setFullLoadCurrent ( double  FullLoadCurrent)

◆ setInputFrequency()

void OdIfc2x3::IfcElectricalBaseProperties::setInputFrequency ( double  InputFrequency)

◆ setInputPhase()

void OdIfc2x3::IfcElectricalBaseProperties::setInputPhase ( int  InputPhase)

◆ setInputVoltage()

void OdIfc2x3::IfcElectricalBaseProperties::setInputVoltage ( double  InputVoltage)

◆ setMaximumPowerInput()

void OdIfc2x3::IfcElectricalBaseProperties::setMaximumPowerInput ( double  MaximumPowerInput)

◆ setMinimumCircuitCurrent()

void OdIfc2x3::IfcElectricalBaseProperties::setMinimumCircuitCurrent ( double  MinimumCircuitCurrent)

◆ setRatedPowerInput()

void OdIfc2x3::IfcElectricalBaseProperties::setRatedPowerInput ( double  RatedPowerInput)

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcElectricalBaseProperties::testAttr ( const char *  explicitAttrName) const
virtual

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::IfcEnergyProperties.

◆ testAttr() [2/2]

virtual bool OdIfc2x3::IfcElectricalBaseProperties::testAttr ( const OdIfc::OdIfcAttribute  explicitAttrDef) const
virtual

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::IfcEnergyProperties.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcElectricalBaseProperties::type ( ) const
virtual

Returns the type of this entity.

Returns
A value of the <link OdIfc__OdIfcEntityType, OdIfc::OdIfcEntityType> type that represents type of this entity.

Reimplemented from OdIfc2x3::IfcEnergyProperties.

◆ unsetAttr() [1/2]

virtual void OdIfc2x3::IfcElectricalBaseProperties::unsetAttr ( const char *  explicitAttrName)
virtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc2x3::IfcEnergyProperties.

◆ unsetAttr() [2/2]

virtual void OdIfc2x3::IfcElectricalBaseProperties::unsetAttr ( const OdIfc::OdIfcAttribute  explicitAttrDef)
virtual

Resets a value for the specified attribute.

Parameters
explicitAttrDef[in] Explicit definition that represents an attribute to reset.

Reimplemented from OdIfc2x3::IfcEnergyProperties.

Member Data Documentation

◆ m_ElectricCurrentType

OdDAI::Enum OdIfc2x3::IfcElectricalBaseProperties::m_ElectricCurrentType
protected

◆ m_FullLoadCurrent

double OdIfc2x3::IfcElectricalBaseProperties::m_FullLoadCurrent
protected

◆ m_InputFrequency

double OdIfc2x3::IfcElectricalBaseProperties::m_InputFrequency
protected

◆ m_InputPhase

int OdIfc2x3::IfcElectricalBaseProperties::m_InputPhase
protected

◆ m_InputVoltage

double OdIfc2x3::IfcElectricalBaseProperties::m_InputVoltage
protected

◆ m_MaximumPowerInput

double OdIfc2x3::IfcElectricalBaseProperties::m_MaximumPowerInput
protected

◆ m_MinimumCircuitCurrent

double OdIfc2x3::IfcElectricalBaseProperties::m_MinimumCircuitCurrent
protected

◆ m_RatedPowerInput

double OdIfc2x3::IfcElectricalBaseProperties::m_RatedPowerInput
protected

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