#include <IfcAssetAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcAsset:

Public Member Functions
const OdAnsiString &	getAssetID () const

void	setAssetID (const OdAnsiString &AssetID)

const OdDAIObjectId &	getOriginalValue () const

void	setOriginalValue (const OdDAIObjectId &OriginalValue)

const OdDAIObjectId &	getCurrentValue () const

void	setCurrentValue (const OdDAIObjectId &CurrentValue)

const OdDAIObjectId &	getTotalReplacementCost () const

void	setTotalReplacementCost (const OdDAIObjectId &TotalReplacementCost)

IfcActorSelect	owner ()

IfcActorSelect	user ()

const OdDAIObjectId &	getResponsiblePerson () const

void	setResponsiblePerson (const OdDAIObjectId &ResponsiblePerson)

const OdDAIObjectId &	getIncorporationDate () const

void	setIncorporationDate (const OdDAIObjectId &IncorporationDate)

const OdDAIObjectId &	getDepreciatedValue () const

void	setDepreciatedValue (const OdDAIObjectId &DepreciatedValue)

	IfcAsset ()

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::IfcGroup
OdDAIObjectId	getInvIsGroupedBy () const

Public Member Functions inherited from OdIfc2x3::IfcObject
const OdAnsiString &	getObjectType () const

void	setObjectType (const OdAnsiString &ObjectType)

void	getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const

	IfcObject ()

Public Member Functions inherited from OdIfc2x3::IfcObjectDefinition
void	getInvHasAssignments (OdDAIObjectIds &HasAssignments) const

void	getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const

void	getInvDecomposes (OdDAIObjectIds &Decomposes) const

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
OdAnsiString	m_AssetID

OdDAIObjectId	m_OriginalValue

OdDAIObjectId	m_CurrentValue

OdDAIObjectId	m_TotalReplacementCost

OdDAI::Select	m_Owner

OdDAI::Select	m_User

OdDAIObjectId	m_ResponsiblePerson

OdDAIObjectId	m_IncorporationDate

OdDAIObjectId	m_DepreciatedValue

Protected Attributes inherited from OdIfc2x3::IfcObject
OdAnsiString	m_ObjectType

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::IfcGroup
virtual OdRxValue	getAttr (const char *attrName) const override

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

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

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

Detailed Description

An asset is a uniquely identifiable grouping of elements acting as a single entity that has a financial value or that can be operated on as a single unit.

An asset is generally the level of granularity at which maintenance operations are undertaken. An asset is a group that can contain one or more elements. Whilst the financial value of a component or element can be defined, financial value is also defined for accounting purposes at the level of the asset.

There are a number of actors that can be associated with an asset, each actor having a role. Actors within the scope of the project are indicated using the IfcRelAssignsToActor relationship in which case roles should be defined through the IfcActorRole class; otherwise principal actors are identified as attributes of the class. In the existence of both, direct attributes take precedence.

Property Sets for Objects - The Property Sets for Objects concept template applies to this entity under Pset_Asset name as shown in table below:

Template

PropertyName Value Enumerated value AssetAccountingType IfcBoolean Enumerated value AssetTaxType IfcDateTime Enumerated value AssetInsuranceType IfcDateTime

Classification - The operating function of an asset within an organization can be particularly valuable in situations where one organization provides and maintains core services and another organization adds and maintains terminal services. It can classify who owns and is responsible for the asset. Operating function can be designated through the use of one or more classification references.
Group Assignment - The Group Assignment concept template applies to this entity as shown in table below.

IsGrouped

RelatedObjects Description Physical elements that comprise the asset.

Definition at line 72 of file Ifc2x3/IfcAssetAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcAsset()

OdIfc2x3::IfcAsset::IfcAsset ( )

Default constructor for the IfcAsset class.

Member Function Documentation

◆ comparedToEarlyImpl()

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

◆ getAssetID()

const OdAnsiString & OdIfc2x3::IfcAsset::getAssetID ( ) const

Returns the value of AssetID attribute. This attribute represents a unique identifier assigned to an asset that enables its differentiation from other assets.

Returns: Returns the value of AssetID attribute.

Remarks: The asset identifier is unique within the asset register. It differs from the globally unique id assigned to the instance of an entity populating a database.

◆ getAttr() [1/2]

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

◆ getAttr() [2/2]

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

◆ getCurrentValue()

const OdDAIObjectId & OdIfc2x3::IfcAsset::getCurrentValue ( ) const

Returns the value of CurrentValue attribute. This attribute represents the current cost value of the asset.

Returns: Returns the value of CurrentValue attribute.

◆ getDepreciatedValue()

const OdDAIObjectId & OdIfc2x3::IfcAsset::getDepreciatedValue ( ) const

Returns the value of DepreciatedValue attribute. This attribute represents the current value of an asset within the accounting rules and procedures of an organization.

Returns: Returns the value of DepreciatedValue attribute.

◆ getIncorporationDate()

const OdDAIObjectId & OdIfc2x3::IfcAsset::getIncorporationDate ( ) const

Returns the value of IncorporationDate attribute. This attribute represents the date on which an asset was incorporated into the works, installed, constructed, erected or completed.

Returns: Returns the value of IncorporationDate attribute.

Remarks: This is the date on which an asset is considered to start depreciating.

◆ getInstanceType()

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

◆ getOriginalValue()

const OdDAIObjectId & OdIfc2x3::IfcAsset::getOriginalValue ( ) const

Returns the value of OriginalValue attribute. This attribute represents the cost value of the asset at the time of purchase.

Returns: Returns the value of OriginalValue attribute.

◆ getResponsiblePerson()

const OdDAIObjectId & OdIfc2x3::IfcAsset::getResponsiblePerson ( ) const

Returns the value of ResponsiblePerson attribute. This attribute represents the person designated to be responsible for the asset.

Returns: Returns the value of ResponsiblePerson attribute.

Remarks: In some regulations (for example, UK Health and Safety at Work Act, Electricity at Work Regulations), management of assets must have a person identified as being responsible and to whom regulatory, insurance and other organizations communicate. In places where there is not a legal requirement, the responsible person would be the asset manager but would not have a legal status.

◆ getTotalReplacementCost()

const OdDAIObjectId & OdIfc2x3::IfcAsset::getTotalReplacementCost ( ) const

Returns the value of TotalReplacementCost attribute. This attribute represents the total cost of replacement of the asset.

Returns: Returns the value of TotalReplacementCost attribute.

◆ inFields()

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

◆ isKindOf()

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

◆ outFields()

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

◆ owner()

IfcActorSelect OdIfc2x3::IfcAsset::owner ( )

Returns the value of Owner attribute. This attribute represents the name of the person or organization that 'owns' the asset.

Returns: Returns the value of Owner attribute.

◆ putAttr() [1/2]

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

◆ putAttr() [2/2]

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

◆ setAssetID()

void OdIfc2x3::IfcAsset::setAssetID ( const OdAnsiString & AssetID )

Sets the value of AssetID attribute. This attribute represents a unique identification assigned to an asset that enables its differentiation from other assets.

Parameters

AssetID [in] AssetID to set.

Remarks: The asset identifier is unique within the asset register. It differs from the globally unique id assigned to the instance of an entity populating a database.

◆ setCurrentValue()

void OdIfc2x3::IfcAsset::setCurrentValue ( const OdDAIObjectId & CurrentValue )

Sets the value of CurrentValue attribute. This attribute represents the current cost value of the asset.

Parameters

CurrentValue [in] Current value to set.

◆ setDepreciatedValue()

void OdIfc2x3::IfcAsset::setDepreciatedValue ( const OdDAIObjectId & DepreciatedValue )

Sets the value of DepreciatedValue attribute. This attribute represents the current value of an asset within the accounting rules and procedures of an organization.

Parameters

DepreciatedValue [in] Depreciated value to set.

◆ setIncorporationDate()

void OdIfc2x3::IfcAsset::setIncorporationDate ( const OdDAIObjectId & IncorporationDate )

Sets the value of IncorporationDate attribute. This attribute represents the date on which an asset was incorporated into the works, installed, constructed, erected or completed.

Parameters

IncorporationDate [in] Incorporation date to set.

Remarks: This is the date on which an asset is considered to start depreciating.

◆ setOriginalValue()

void OdIfc2x3::IfcAsset::setOriginalValue ( const OdDAIObjectId & OriginalValue )

Sets the value of OriginalValue attribute. This attribute represents the cost value of the asset at the time of purchase.

Parameters

OriginalValue [in] Original value to set.

◆ setResponsiblePerson()

void OdIfc2x3::IfcAsset::setResponsiblePerson ( const OdDAIObjectId & ResponsiblePerson )

Sets the value of ResponsiblePerson attribute. This attribute represents the person designated to be responsible for the asset.

Parameters

ResponsiblePerson [in] Responsible person to set.

Remarks: In some regulations (for example, UK Health and Safety at Work Act, Electricity at Work Regulations), management of assets must have a person identified as being responsible and to whom regulatory, insurance and other organizations communicate. In places where there is not a legal requirement, the responsible person would be the asset manager but would not have a legal status.

◆ setTotalReplacementCost()

void OdIfc2x3::IfcAsset::setTotalReplacementCost ( const OdDAIObjectId & TotalReplacementCost )

Sets the value of TotalReplacementCost attribute. This attribute represents the total cost of replacement of the asset.

Parameters

TotalReplacementCost [in] Total replacement cost to set.

◆ testAttr() [1/2]

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

◆ testAttr() [2/2]

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

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcAsset::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::IfcGroup.

◆ unsetAttr() [1/2]

virtual void OdIfc2x3::IfcAsset::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::IfcGroup.

◆ unsetAttr() [2/2]

virtual void OdIfc2x3::IfcAsset::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::IfcGroup.

◆ user()

IfcActorSelect OdIfc2x3::IfcAsset::user ( )

Returns the value of User attribute. This attribute represents the name of the person or organization that 'uses' the asset.

Returns: Returns the value of User attribute.

Member Data Documentation

◆ m_AssetID

OdAnsiString OdIfc2x3::IfcAsset::m_AssetID

protected

Definition at line 354 of file Ifc2x3/IfcAssetAutoImpl.h.

◆ m_CurrentValue

OdDAIObjectId OdIfc2x3::IfcAsset::m_CurrentValue

protected

Definition at line 356 of file Ifc2x3/IfcAssetAutoImpl.h.

◆ m_DepreciatedValue

OdDAIObjectId OdIfc2x3::IfcAsset::m_DepreciatedValue

protected

Definition at line 362 of file Ifc2x3/IfcAssetAutoImpl.h.

◆ m_IncorporationDate

OdDAIObjectId OdIfc2x3::IfcAsset::m_IncorporationDate

protected

Definition at line 361 of file Ifc2x3/IfcAssetAutoImpl.h.

◆ m_OriginalValue

OdDAIObjectId OdIfc2x3::IfcAsset::m_OriginalValue

protected

Definition at line 355 of file Ifc2x3/IfcAssetAutoImpl.h.

◆ m_Owner

OdDAI::Select OdIfc2x3::IfcAsset::m_Owner

protected

Definition at line 358 of file Ifc2x3/IfcAssetAutoImpl.h.

◆ m_ResponsiblePerson

OdDAIObjectId OdIfc2x3::IfcAsset::m_ResponsiblePerson

protected

Definition at line 360 of file Ifc2x3/IfcAssetAutoImpl.h.

◆ m_TotalReplacementCost

OdDAIObjectId OdIfc2x3::IfcAsset::m_TotalReplacementCost

protected

Definition at line 357 of file Ifc2x3/IfcAssetAutoImpl.h.

◆ m_User

OdDAI::Select OdIfc2x3::IfcAsset::m_User

protected

Definition at line 359 of file Ifc2x3/IfcAssetAutoImpl.h.

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

Ifc2x3/IfcAssetAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcAsset()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAssetID()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getCurrentValue()

◆ getDepreciatedValue()

◆ getIncorporationDate()

◆ getInstanceType()

◆ getOriginalValue()

◆ getResponsiblePerson()

◆ getTotalReplacementCost()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ owner()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setAssetID()

◆ setCurrentValue()

◆ setDepreciatedValue()

◆ setIncorporationDate()

◆ setOriginalValue()

◆ setResponsiblePerson()

◆ setTotalReplacementCost()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

◆ user()

Member Data Documentation

◆ m_AssetID

◆ m_CurrentValue

◆ m_DepreciatedValue

◆ m_IncorporationDate

◆ m_OriginalValue

◆ m_Owner

◆ m_ResponsiblePerson

◆ m_TotalReplacementCost

◆ m_User