#include <IfcDerivedUnitAutoImpl.h>

Inheritance diagram for OdIfc4x3_add2::IfcDerivedUnit:

Public Member Functions
void	getElements (OdDAIObjectIds &Elements) const

OdDAI::SetOfOdDAIObjectId &	elements ()

IfcDerivedUnitEnum	getUnitType () const

void	setUnitType (IfcDerivedUnitEnum UnitType)

const OdAnsiString &	getUserDefinedType () const

void	setUserDefinedType (const OdAnsiString &UserDefinedType)

const OdAnsiString &	getName () const

void	setName (const OdAnsiString &Name)

	IfcDerivedUnit ()

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 OdIfc4x3_add2::OdIfc4x3Instance
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::SetOfOdDAIObjectId	m_Elements

OdDAI::Enum	m_UnitType

OdAnsiString	m_UserDefinedType

OdAnsiString	m_Name

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)

Detailed Description

A derived unit is an expression of units.

Example - The image below shows an example of how to assign miles per hour as a derived unit:

Definition at line 49 of file Ifc4x3/IfcDerivedUnitAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcDerivedUnit()

OdIfc4x3_add2::IfcDerivedUnit::IfcDerivedUnit ( )

Default constructor for the IfcDerivedUnit class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x3_add2::IfcDerivedUnit::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.

◆ elements()

OdDAI::SetOfOdDAIObjectId & OdIfc4x3_add2::IfcDerivedUnit::elements ( )

Returns the value of Elements attribute. This attribute represents the group of units and their exponents that define the derived unit.

Returns: Returns the value of Elements attribute.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x3_add2::IfcDerivedUnit::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.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x3_add2::IfcDerivedUnit::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 OdIfc::OdIfcInstance.

◆ getElements()

void OdIfc4x3_add2::IfcDerivedUnit::getElements ( OdDAIObjectIds & Elements ) const

Gets the value of Elements attribute. This attribute represents the group of units and their exponents that define the derived unit.

Parameters

Elements [out] Receives the elements.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x3_add2::IfcDerivedUnit::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.

◆ getName()

const OdAnsiString & OdIfc4x3_add2::IfcDerivedUnit::getName ( ) const

Returns the value of Name attribute. This attribute represents name of the unit in addition to the unit type, particularly when the derived unit elements refer to conversion or context based units.

Returns: Returns the value of Name attribute.

◆ getUnitType()

IfcDerivedUnitEnum OdIfc4x3_add2::IfcDerivedUnit::getUnitType ( ) const

Returns the value of UnitType attribute. This attribute represents name of the derived unit chosen from an enumeration of derived unit types for use in IFC models.

Returns: Returns the value of UnitType attribute.

◆ getUserDefinedType()

const OdAnsiString & OdIfc4x3_add2::IfcDerivedUnit::getUserDefinedType ( ) const

Returns the value of UserDefinedType attribute. This attribute represents type of the derived unit if the UnitType attribute is set to USERDEFINED.

Returns: Returns the value of UserDefinedType attribute.

◆ inFields()

virtual OdResult OdIfc4x3_add2::IfcDerivedUnit::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.

◆ isKindOf()

virtual bool OdIfc4x3_add2::IfcDerivedUnit::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 OdIfc::OdIfcInstance.

◆ outFields()

virtual OdResult OdIfc4x3_add2::IfcDerivedUnit::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.

◆ putAttr() [1/2]

virtual bool OdIfc4x3_add2::IfcDerivedUnit::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 OdIfc::OdIfcInstance.

◆ putAttr() [2/2]

virtual bool OdIfc4x3_add2::IfcDerivedUnit::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 OdIfc::OdIfcInstance.

◆ setName()

void OdIfc4x3_add2::IfcDerivedUnit::setName ( const OdAnsiString & Name )

Sets the value of Name attribute. This attribute represents name of the unit in addition to the unit type, particularly when the derived unit elements refer to conversion or context based units.

Parameters

Name	[in] Name to set.

◆ setUnitType()

void OdIfc4x3_add2::IfcDerivedUnit::setUnitType ( IfcDerivedUnitEnum UnitType )

Sets the value of UnitType attribute. This attribute represents name of the derived unit chosen from an enumeration of derived unit types for use in IFC models.

Parameters

UnitType [in] Unit type to set.

◆ setUserDefinedType()

void OdIfc4x3_add2::IfcDerivedUnit::setUserDefinedType ( const OdAnsiString & UserDefinedType )

Sets the value of UserDefinedType attribute. This attribute represents type of the derived unit if the UnitType attribute is set to USERDEFINED.

Parameters

UserDefinedType [in] User-defined type to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x3_add2::IfcDerivedUnit::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 OdIfc::OdIfcInstance.

◆ testAttr() [2/2]

virtual bool OdIfc4x3_add2::IfcDerivedUnit::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 OdIfc::OdIfcInstance.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x3_add2::IfcDerivedUnit::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 OdIfc::OdIfcInstance.

◆ unsetAttr() [1/2]

virtual void OdIfc4x3_add2::IfcDerivedUnit::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc::OdIfcInstance.

◆ unsetAttr() [2/2]

virtual void OdIfc4x3_add2::IfcDerivedUnit::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 OdIfc::OdIfcInstance.

Member Data Documentation

◆ m_Elements

OdDAI::SetOfOdDAIObjectId OdIfc4x3_add2::IfcDerivedUnit::m_Elements

protected

Definition at line 254 of file Ifc4x3/IfcDerivedUnitAutoImpl.h.

◆ m_Name

OdAnsiString OdIfc4x3_add2::IfcDerivedUnit::m_Name

protected

Definition at line 257 of file Ifc4x3/IfcDerivedUnitAutoImpl.h.

◆ m_UnitType

OdDAI::Enum OdIfc4x3_add2::IfcDerivedUnit::m_UnitType

protected

Definition at line 255 of file Ifc4x3/IfcDerivedUnitAutoImpl.h.

◆ m_UserDefinedType

OdAnsiString OdIfc4x3_add2::IfcDerivedUnit::m_UserDefinedType

protected

Definition at line 256 of file Ifc4x3/IfcDerivedUnitAutoImpl.h.

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

Ifc4x3/IfcDerivedUnitAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcDerivedUnit()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ elements()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getElements()

◆ getInstanceType()

◆ getName()

◆ getUnitType()

◆ getUserDefinedType()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setName()

◆ setUnitType()

◆ setUserDefinedType()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_Elements

◆ m_Name

◆ m_UnitType

◆ m_UserDefinedType