CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4x1::IfcConversionBasedUnit Class Reference

#include <IfcConversionBasedUnitAutoImpl.h>

Inheritance diagram for OdIfc4x1::IfcConversionBasedUnit:
OdIfc4x1::IfcNamedUnit OdIfc4x1::OdIfc4x1Instance OdIfc::OdIfcInstance OdIfc4x1::IfcConversionBasedUnitWithOffset

Public Member Functions

const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
const OdDAIObjectId & getConversionFactor () const
 
void setConversionFactor (const OdDAIObjectId &ConversionFactor)
 
void getInvHasExternalReference (OdDAIObjectIds &HasExternalReference) const
 
 IfcConversionBasedUnit ()
 
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 OdIfc4x1::IfcNamedUnit
const OdDAIObjectId & getDimensions () const
 
void setDimensions (const OdDAIObjectId &Dimensions)
 
IfcUnitEnum getUnitType () const
 
void setUnitType (IfcUnitEnum UnitType)
 
 IfcNamedUnit ()
 
- Public Member Functions inherited from OdIfc4x1::OdIfc4x1Instance
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 OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Protected Attributes

OdAnsiString m_Name
 
OdDAIObjectId m_ConversionFactor
 
- Protected Attributes inherited from OdIfc4x1::IfcNamedUnit
OdDAIObjectId m_Dimensions
 
OdDAI::Enum m_UnitType
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Friends

class IfcExternalReferenceRelationship
 

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

An IfcConversionBasedUnit is used to define a unit that has a conversion rate to a base unit. To identify some commonly used conversion based units, the standard designations (case insensitive) for the Name attribute are indicated in the table below.

Name Description inch Indicates project directives issued by the actor. foot Indicates groups for which the actor is responsible. US survey foot Indicates products for which the actor is responsible. yard Indicates processes for which the actor is responsible. mile Indicates resources for which the actor is responsible. square inch Area measure equal to 0.0006452 square meters square foot Area measure equal to 0.09290 square meters square yard Area measure equal to 0.83612736 square meters acre Area measure equal to 4046.86 square meters square mile Area measure equal to 2 588 881 square meters cubic inch Volume measure equal to 0.00001639 cubic meters cubic foot Volume measure equal to 0.02832 cubic meters cubic yard Volume measure equal to 0.7636 cubic meters litre Volume measure equal to 0.001 cubic meters fluid ounce UK Volume measure equal to 0.0000284130625 cubic meters fluid ounce US Volume measure equal to 0.00002957353 cubic meters pint UK Volume measure equal to 0.000568 cubic meters pint US Volume measure equal to 0.000473 cubic meters gallon UK Volume measure equal to 0.004546 cubic meters gallon US Volume measure equal to 0.003785 cubic meters degree Angle measure equal to π/180 rad ounce Mass measure equal to 28.35 g pound Mass measure equal to 0.454 kg ton UK Mass measure equal to 1016.0469088 kg, also known as long ton, gross ton, shipper's ton ton US Mass measure equal to 907.18474 kg, also known as short ton, net ton lbf Force measure equal to 4.4482216153 N, pound-force kip Force measure equal to 4448.2216153 N, kilopound-force psi Pressure measure equal to 6894.7572932 Pa, pound-force per square inch ksi Pressure measure equal to 6894757.2932 Pa, kilopound-force per square inch minute Time measure equal to 60 s hour Time measure equal to 3600 s day Time measure equal to 86400 s btu Energy measure equal to 1055.056 J, British Thermal Unit

Definition at line 79 of file Ifc4x1/IfcConversionBasedUnitAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcConversionBasedUnit()

OdIfc4x1::IfcConversionBasedUnit::IfcConversionBasedUnit ( )

Default constructor for the IfcConversionBasedUnit class.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x1::IfcConversionBasedUnit::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 OdIfc4x1::IfcNamedUnit.

Reimplemented in OdIfc4x1::IfcConversionBasedUnitWithOffset.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x1::IfcConversionBasedUnit::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 OdIfc4x1::IfcNamedUnit.

Reimplemented in OdIfc4x1::IfcConversionBasedUnitWithOffset.

◆ getConversionFactor()

const OdDAIObjectId & OdIfc4x1::IfcConversionBasedUnit::getConversionFactor ( ) const

Returns the value of ConversionFactor attribute. This attribute represents the physical quantity from which the converted unit is derived.

Returns
Returns the value of ConversionFactor attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x1::IfcConversionBasedUnit::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 OdIfc4x1::IfcNamedUnit.

Reimplemented in OdIfc4x1::IfcConversionBasedUnitWithOffset.

◆ getInvHasExternalReference()

void OdIfc4x1::IfcConversionBasedUnit::getInvHasExternalReference ( OdDAIObjectIds & HasExternalReference) const

Returns the value of HasExternalReference attribute. This attribute represents reference to external information, e.g. library, classification, or document information, which is associated with the conversion-based unit.

Parameters
HasExternalReference[out] Receives the value of HasExternalReference attribute.

◆ getName()

const OdAnsiString & OdIfc4x1::IfcConversionBasedUnit::getName ( ) const

Returns the value of Name attribute. This attribute represents the word, or group of words, by which the conversion based unit is referred to.

Returns
Returns the value of Name attribute.

◆ inFields()

virtual OdResult OdIfc4x1::IfcConversionBasedUnit::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 OdIfc4x1::IfcNamedUnit.

Reimplemented in OdIfc4x1::IfcConversionBasedUnitWithOffset.

◆ isKindOf()

virtual bool OdIfc4x1::IfcConversionBasedUnit::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 OdIfc4x1::IfcNamedUnit.

Reimplemented in OdIfc4x1::IfcConversionBasedUnitWithOffset.

◆ outFields()

virtual OdResult OdIfc4x1::IfcConversionBasedUnit::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 OdIfc4x1::IfcNamedUnit.

Reimplemented in OdIfc4x1::IfcConversionBasedUnitWithOffset.

◆ putAttr() [1/2]

virtual bool OdIfc4x1::IfcConversionBasedUnit::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 OdIfc4x1::IfcNamedUnit.

Reimplemented in OdIfc4x1::IfcConversionBasedUnitWithOffset.

◆ putAttr() [2/2]

virtual bool OdIfc4x1::IfcConversionBasedUnit::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 OdIfc4x1::IfcNamedUnit.

Reimplemented in OdIfc4x1::IfcConversionBasedUnitWithOffset.

◆ setConversionFactor()

void OdIfc4x1::IfcConversionBasedUnit::setConversionFactor ( const OdDAIObjectId & ConversionFactor)

Sets the value of ConversionFactor attribute. This attribute represents the physical quantity from which the converted unit is derived.

Parameters
ConversionFactor[in] Conversion factor to set.

◆ setName()

void OdIfc4x1::IfcConversionBasedUnit::setName ( const OdAnsiString & Name)

Sets the value of Name attribute. This attribute represents the word, or group of words, by which the conversion based unit is referred to.

Parameters
Name[in] Name to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x1::IfcConversionBasedUnit::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 OdIfc4x1::IfcNamedUnit.

Reimplemented in OdIfc4x1::IfcConversionBasedUnitWithOffset.

◆ testAttr() [2/2]

virtual bool OdIfc4x1::IfcConversionBasedUnit::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 OdIfc4x1::IfcNamedUnit.

Reimplemented in OdIfc4x1::IfcConversionBasedUnitWithOffset.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x1::IfcConversionBasedUnit::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 OdIfc4x1::IfcNamedUnit.

Reimplemented in OdIfc4x1::IfcConversionBasedUnitWithOffset.

◆ unsetAttr() [1/2]

virtual void OdIfc4x1::IfcConversionBasedUnit::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc4x1::IfcNamedUnit.

Reimplemented in OdIfc4x1::IfcConversionBasedUnitWithOffset.

◆ unsetAttr() [2/2]

virtual void OdIfc4x1::IfcConversionBasedUnit::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 OdIfc4x1::IfcNamedUnit.

Reimplemented in OdIfc4x1::IfcConversionBasedUnitWithOffset.

Friends And Related Symbol Documentation

◆ IfcExternalReferenceRelationship

friend class IfcExternalReferenceRelationship
friend

Definition at line 245 of file Ifc4x1/IfcConversionBasedUnitAutoImpl.h.

Member Data Documentation

◆ m_ConversionFactor

OdDAIObjectId OdIfc4x1::IfcConversionBasedUnit::m_ConversionFactor
protected

Definition at line 242 of file Ifc4x1/IfcConversionBasedUnitAutoImpl.h.

◆ m_Name

OdAnsiString OdIfc4x1::IfcConversionBasedUnit::m_Name
protected

Definition at line 241 of file Ifc4x1/IfcConversionBasedUnitAutoImpl.h.


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