#include <IfcElectricalBasePropertiesAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcElectricalBaseProperties:

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) override

virtual OdResult	outFields (OdDAI::OdSpfFilerBase *wrFiler) override

virtual OdDAI::Entity *	getInstanceType () const override

virtual OdRxValue	getAttr (const char *attrName) const override

virtual bool	comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) 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 OdIfc2x3::IfcEnergyProperties
IfcEnergySequenceEnum	getEnergySequence () const

void	setEnergySequence (IfcEnergySequenceEnum EnergySequence)

const OdAnsiString &	getUserDefinedEnergySequence () const

void	setUserDefinedEnergySequence (const OdAnsiString &UserDefinedEnergySequence)

	IfcEnergyProperties ()

Public Member Functions inherited from OdIfc2x3::IfcPropertySetDefinition
void	getInvPropertyDefinitionOf (OdDAIObjectIds &PropertyDefinitionOf) const

void	getInvDefinesType (OdDAIObjectIds &DefinesType) const

Public Member Functions inherited from OdIfc2x3::IfcPropertyDefinition
void	getInvHasAssociations (OdDAIObjectIds &HasAssociations) const

Public Member Functions inherited from OdIfc2x3::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 OdIfc2x3::OdIfc2x3Instance
void	setInverseCounterParts () override

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 OdGsCache *	gsNode () const

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *traits) const

virtual bool	subWorldDraw (OdGiWorldDraw *wd) const

virtual OdDbStub *	ownerId () 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
OdDAI::CompressedGUID	m_GlobalId

OdDAIObjectId	m_OwnerHistory

OdAnsiString	m_Name

OdAnsiString	m_Description

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

Additional Inherited Members
Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3d *	asPoint3d (const OdIfcInstance *inst)

static const OdGePoint2d *	asPoint2d (const OdIfcInstance *inst)

static const OdGeVector3d *	asVector3d (const OdIfcInstance *inst)

static const OdGeVector2d *	asVector2d (const OdIfcInstance *inst)

static const OdGeMatrix2d *	asMatrix2d (const OdIfcInstance *inst)

static const OdGeMatrix3d *	asMatrix3d (const OdIfcInstance *inst)

static OdIfcCompoundPtr	asCompound (OdSmartPtr< OdIfcInstance > inst)

static const OdCmEntityColor *	asRgbColor (const OdIfcInstance *inst)

Protected Member Functions inherited from OdIfc2x3::IfcPropertySetDefinition
virtual OdRxValue	getAttr (const char *attrName) const override

virtual bool	putAttr (const char *explicitAttrName, const OdRxValue &val) override

Detailed Description

Common definition to capture basic electrical characteristics for use in building services and facilities management.

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

Constructor & Destructor Documentation

◆ IfcElectricalBaseProperties()

OdIfc2x3::IfcElectricalBaseProperties::IfcElectricalBaseProperties ( )

Default constructor for the IfcElectricalBaseProperties class.

Member Function Documentation

◆ comparedToEarlyImpl()

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

overridevirtual

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

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

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x3::IfcElectricalBaseProperties::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 OdIfc2x3::IfcEnergyProperties.

◆ getElectricCurrentType()

IfcElectricCurrentEnum OdIfc2x3::IfcElectricalBaseProperties::getElectricCurrentType ( ) const

Returns the value of ElectricCurrentType attribute. This attribute represents the type of electrical current applied.

Returns: Returns the value of ElectricCurrentType attribute.

◆ getFullLoadCurrent()

double OdIfc2x3::IfcElectricalBaseProperties::getFullLoadCurrent ( ) const

Returns the value of FullLoadCurrent attribute. This attribute represents the full load electrical current requirements.

Returns: Returns the value of FullLoadCurrent attribute.

◆ getInputFrequency()

double OdIfc2x3::IfcElectricalBaseProperties::getInputFrequency ( ) const

Returns the value of InputFrequency attribute. This attribute represents the nominal frequency of input voltage wave form.

Returns: Returns the value of InputFrequency attribute.

◆ getInputPhase()

int OdIfc2x3::IfcElectricalBaseProperties::getInputPhase ( ) const

Returns the value of InputPhase attribute. This attribute represents the relative phase of input conductors.

Returns: Returns the value of InputPhase attribute.

◆ getInputVoltage()

double OdIfc2x3::IfcElectricalBaseProperties::getInputVoltage ( ) const

Returns the value of InputVoltage attribute. This attribute represents the input electrical potential.

Returns: Returns the value of InputVoltage attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcElectricalBaseProperties::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 OdIfc2x3::IfcEnergyProperties.

◆ getMaximumPowerInput()

double OdIfc2x3::IfcElectricalBaseProperties::getMaximumPowerInput ( ) const

Returns the value of MaximumPowerInput attribute. This attribute represents the maximum power input of the electrical device.

Returns: Returns the value of MaximumPowerInput attribute.

◆ getMinimumCircuitCurrent()

double OdIfc2x3::IfcElectricalBaseProperties::getMinimumCircuitCurrent ( ) const

Returns the value of MinimumCircuitCurrent attribute. This attribute represents the minimum current carrying capacity of the electrical circuit.

Returns: Returns the value of MinimumCircuitCurrent attribute.

◆ getRatedPowerInput()

double OdIfc2x3::IfcElectricalBaseProperties::getRatedPowerInput ( ) const

Returns the value of RatedPowerInput attribute. This attribute represents the actual electrical input power of the electrical device at its rated capacity.

Returns: Returns the value of RatedPowerInput attribute.

◆ inFields()

virtual OdResult OdIfc2x3::IfcElectricalBaseProperties::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 OdIfc2x3::IfcEnergyProperties.

◆ isKindOf()

virtual bool OdIfc2x3::IfcElectricalBaseProperties::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 OdIfc2x3::IfcEnergyProperties.

◆ outFields()

virtual OdResult OdIfc2x3::IfcElectricalBaseProperties::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 OdIfc2x3::IfcEnergyProperties.

◆ putAttr() [1/2]

virtual bool OdIfc2x3::IfcElectricalBaseProperties::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 OdIfc2x3::IfcEnergyProperties.

◆ putAttr() [2/2]

virtual bool OdIfc2x3::IfcElectricalBaseProperties::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 OdIfc2x3::IfcEnergyProperties.

◆ setElectricCurrentType()

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

Sets the value of ElectricCurrentType attribute. This attribute represents the type of electrical current applied.

Parameters

ElectricCurrentType [in] ElectricCurrentType attribute to set.

◆ setFullLoadCurrent()

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

Sets the value of FullLoadCurrent attribute. This attribute represents the full load electrical current requirements.

Parameters

FullLoadCurrent [in] FullLoadCurrent attribute to set.

◆ setInputFrequency()

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

Sets the value of InputFrequency attribute. This attribute represents the nominal frequency of input voltage wave form.

Parameters

InputFrequency [in] InputFrequency attribute to set.

◆ setInputPhase()

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

Sets the value of InputPhase attribute. This attribute represents the relative phase of input conductors.

Parameters

InputPhase [in] InputPhase attribute to set.

◆ setInputVoltage()

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

Sets the value of InputVoltage attribute. This attribute represents the input electrical potential.

Parameters

InputVoltage [in] InputVoltage attribute to set.

◆ setMaximumPowerInput()

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

Sets the value of MaximumPowerInput attribute. This attribute represents the maximum power input of the electrical device.

Parameters

MaximumPowerInput [in] MaximumPowerInput attribute to set.

◆ setMinimumCircuitCurrent()

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

Sets the value of MinimumCircuitCurrent attribute. This attribute represents the minimum current carrying capacity of the electrical circuit.

Parameters

MinimumCircuitCurrent [in] MinimumCircuitCurrent attribute to set.

◆ setRatedPowerInput()

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

Sets the value of RatedPowerInput attribute. This attribute represents the actual electrical input power of the electrical device at its rated capacity.

Parameters

RatedPowerInput [in] RatedPowerInput attribute to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcElectricalBaseProperties::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 OdIfc2x3::IfcEnergyProperties.

◆ testAttr() [2/2]

virtual bool OdIfc2x3::IfcElectricalBaseProperties::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 OdIfc2x3::IfcEnergyProperties.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcElectricalBaseProperties::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 OdIfc2x3::IfcEnergyProperties.

◆ unsetAttr() [1/2]

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

overridevirtual

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 )

overridevirtual

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

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

◆ m_FullLoadCurrent

double OdIfc2x3::IfcElectricalBaseProperties::m_FullLoadCurrent

protected

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

◆ m_InputFrequency

double OdIfc2x3::IfcElectricalBaseProperties::m_InputFrequency

protected

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

◆ m_InputPhase

int OdIfc2x3::IfcElectricalBaseProperties::m_InputPhase

protected

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

◆ m_InputVoltage

double OdIfc2x3::IfcElectricalBaseProperties::m_InputVoltage

protected

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

◆ m_MaximumPowerInput

double OdIfc2x3::IfcElectricalBaseProperties::m_MaximumPowerInput

protected

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

◆ m_MinimumCircuitCurrent

double OdIfc2x3::IfcElectricalBaseProperties::m_MinimumCircuitCurrent

protected

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

◆ m_RatedPowerInput

double OdIfc2x3::IfcElectricalBaseProperties::m_RatedPowerInput

protected

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

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

Ifc2x3/IfcElectricalBasePropertiesAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcElectricalBaseProperties()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getElectricCurrentType()

◆ getFullLoadCurrent()

◆ getInputFrequency()

◆ getInputPhase()

◆ getInputVoltage()

◆ getInstanceType()

◆ getMaximumPowerInput()

◆ getMinimumCircuitCurrent()

◆ getRatedPowerInput()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setElectricCurrentType()

◆ setFullLoadCurrent()

◆ setInputFrequency()

◆ setInputPhase()

◆ setInputVoltage()

◆ setMaximumPowerInput()

◆ setMinimumCircuitCurrent()

◆ setRatedPowerInput()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_ElectricCurrentType

◆ m_FullLoadCurrent

◆ m_InputFrequency

◆ m_InputPhase

◆ m_InputVoltage

◆ m_MaximumPowerInput

◆ m_MinimumCircuitCurrent

◆ m_RatedPowerInput