#include <IfcCurrencyRelationshipAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcCurrencyRelationship:

Public Member Functions
const OdDAIObjectId &	getRelatingMonetaryUnit () const

void	setRelatingMonetaryUnit (const OdDAIObjectId &RelatingMonetaryUnit)

const OdDAIObjectId &	getRelatedMonetaryUnit () const

void	setRelatedMonetaryUnit (const OdDAIObjectId &RelatedMonetaryUnit)

double	getExchangeRate () const

void	setExchangeRate (double ExchangeRate)

const OdDAIObjectId &	getRateDateTime () const

void	setRateDateTime (const OdDAIObjectId &RateDateTime)

const OdDAIObjectId &	getRateSource () const

void	setRateSource (const OdDAIObjectId &RateSource)

	IfcCurrencyRelationship ()

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::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
OdDAIObjectId	m_RelatingMonetaryUnit

OdDAIObjectId	m_RelatedMonetaryUnit

IfcPositiveRatioMeasure	m_ExchangeRate

OdDAIObjectId	m_RateDateTime

OdDAIObjectId	m_RateSource

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

IfcCurrencyRelationship defines the rate of exchange that applies between two designated currencies at a particular time and as published by a particular source.

An IfcCurrencyRelationship is used where there can be a need to reference an IfcCostValue in one currency to an IfcCostValue in another currency. It takes into account the fact that currency exchange rates can vary by requiring the recording the date and time of the currency exchange rate used and the source that publishes the rate. There can be many sources and there are different strategies for currency conversion (spot rate, forward buying of currency at a fixed rate).

Definition at line 55 of file Ifc2x3/IfcCurrencyRelationshipAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcCurrencyRelationship()

OdIfc2x3::IfcCurrencyRelationship::IfcCurrencyRelationship ( )

Default constructor for the IfcCurrencyRelationship class.

Member Function Documentation

◆ comparedToEarlyImpl()

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

◆ getAttr() [1/2]

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

◆ getExchangeRate()

double OdIfc2x3::IfcCurrencyRelationship::getExchangeRate ( ) const

Returns the value of ExchangeRate attribute. This attribute represents the currently agreed ratio of the amount of a related monetary unit that is equivalent to a unit amount of the relating monetary unit in a currency relationship. For instance, in the case of a conversion from GBP to USD, the value of the exchange rate can be 1.486 (USD) : 1 (GBP).

Returns: Returns the value of ExchangeRate attribute.

◆ getInstanceType()

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

◆ getRateDateTime()

const OdDAIObjectId & OdIfc2x3::IfcCurrencyRelationship::getRateDateTime ( ) const

Returns the value of RateDateTime attribute. This attribute represents the date and time at which an exchange rate applies.

Returns: Returns the value of RateDateTime attribute.

◆ getRateSource()

const OdDAIObjectId & OdIfc2x3::IfcCurrencyRelationship::getRateSource ( ) const

Returns the value of RateSource attribute. This attribute represents the source from which an exchange rate is obtained.

Returns: Returns the value of RateSource attribute.

◆ getRelatedMonetaryUnit()

const OdDAIObjectId & OdIfc2x3::IfcCurrencyRelationship::getRelatedMonetaryUnit ( ) const

Returns the value of RelatedMonetaryUnit attribute. This attribute represents the monetary unit to which an exchange results. For instance, in the case of a conversion from GBP to USD, the related monetary unit is USD.

Returns: Returns the value of RelatedMonetaryUnit attribute.

◆ getRelatingMonetaryUnit()

const OdDAIObjectId & OdIfc2x3::IfcCurrencyRelationship::getRelatingMonetaryUnit ( ) const

Returns the value of RelatingMonetaryUnit attribute. This attribute represents the monetary unit from which an exchange is derived. For instance, in the case of a conversion from GBP to USD, the relating monetary unit is GBP.

Returns: Returns the value of RelatingMonetaryUnit attribute.

◆ inFields()

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

◆ setExchangeRate()

void OdIfc2x3::IfcCurrencyRelationship::setExchangeRate ( double ExchangeRate )

Sets the value of ExchangeRate attribute. This attribute represents the currently agreed ratio of the amount of a related monetary unit that is equivalent to a unit amount of the relating monetary unit in a currency relationship. For instance, in the case of a conversion from GBP to USD, the value of the exchange rate can be 1.486 (USD) : 1 (GBP).

Parameters

ExchangeRate [in] Exchange rate to set.

◆ setRateDateTime()

void OdIfc2x3::IfcCurrencyRelationship::setRateDateTime ( const OdDAIObjectId & RateDateTime )

Sets the value of RateDateTime attribute. This attribute represents the date and time at which an exchange rate applies.

Parameters

RateDateTime [in] Rate date time to set.

◆ setRateSource()

void OdIfc2x3::IfcCurrencyRelationship::setRateSource ( const OdDAIObjectId & RateSource )

Sets the value of RateSource attribute. This attribute represents the source from which an exchange rate is obtained.

Parameters

RateSource [in] Rate source to set.

◆ setRelatedMonetaryUnit()

void OdIfc2x3::IfcCurrencyRelationship::setRelatedMonetaryUnit ( const OdDAIObjectId & RelatedMonetaryUnit )

Sets the value of RelatedMonetaryUnit attribute. This attribute represents the monetary unit to which an exchange results. For instance, in the case of a conversion from GBP to USD, the related monetary unit is USD.

Parameters

RelatedMonetaryUnit [in] Related monetary unit to set.

◆ setRelatingMonetaryUnit()

void OdIfc2x3::IfcCurrencyRelationship::setRelatingMonetaryUnit ( const OdDAIObjectId & RelatingMonetaryUnit )

Sets the value of RelatingMonetaryUnit attribute. This attribute represents the monetary unit from which an exchange is derived. For instance, in the case of a conversion from GBP to USD, the relating monetary unit is GBP.

Parameters

RelatingMonetaryUnit [in] Relating monetary unit to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcCurrencyRelationship::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 OdIfc2x3::IfcCurrencyRelationship::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 OdIfc2x3::IfcCurrencyRelationship::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 OdIfc2x3::IfcCurrencyRelationship::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 OdIfc2x3::IfcCurrencyRelationship::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_ExchangeRate

IfcPositiveRatioMeasure OdIfc2x3::IfcCurrencyRelationship::m_ExchangeRate

protected

Definition at line 283 of file Ifc2x3/IfcCurrencyRelationshipAutoImpl.h.

◆ m_RateDateTime

OdDAIObjectId OdIfc2x3::IfcCurrencyRelationship::m_RateDateTime

protected

Definition at line 284 of file Ifc2x3/IfcCurrencyRelationshipAutoImpl.h.

◆ m_RateSource

OdDAIObjectId OdIfc2x3::IfcCurrencyRelationship::m_RateSource

protected

Definition at line 285 of file Ifc2x3/IfcCurrencyRelationshipAutoImpl.h.

◆ m_RelatedMonetaryUnit

OdDAIObjectId OdIfc2x3::IfcCurrencyRelationship::m_RelatedMonetaryUnit

protected

Definition at line 282 of file Ifc2x3/IfcCurrencyRelationshipAutoImpl.h.

◆ m_RelatingMonetaryUnit

OdDAIObjectId OdIfc2x3::IfcCurrencyRelationship::m_RelatingMonetaryUnit

protected

Definition at line 281 of file Ifc2x3/IfcCurrencyRelationshipAutoImpl.h.

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

Ifc2x3/IfcCurrencyRelationshipAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcCurrencyRelationship()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getExchangeRate()

◆ getInstanceType()

◆ getRateDateTime()

◆ getRateSource()

◆ getRelatedMonetaryUnit()

◆ getRelatingMonetaryUnit()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setExchangeRate()

◆ setRateDateTime()

◆ setRateSource()

◆ setRelatedMonetaryUnit()

◆ setRelatingMonetaryUnit()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_ExchangeRate

◆ m_RateDateTime

◆ m_RateSource

◆ m_RelatedMonetaryUnit

◆ m_RelatingMonetaryUnit