/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////

// This file is generated automatically.

#ifndef _IFC4X3_RC1_IFCASSET_AUTO_IMPL_H
#define _IFC4X3_RC1_IFCASSET_AUTO_IMPL_H

#include "IfcGroupAutoImpl.h"
#include "IfcCostValueAutoImpl.h"
#include "IfcPersonAutoImpl.h"

#include "TD_PackPush.h"

/** \details
  The namespace contains schema-dependent classes, definitions and sub routines
  for work with IFC4X3_RC1 express schema definitions.
*/
namespace OdIfc4x3_rc1 {

/** \details
  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 <em>Pset_Asset</em> name as shown in table below:
  <table>
  <b>Template</b>                   <b>PropertyName</b>                   <b>Value</b>
  Enumerated value                  AssetAccountingType                   IfcBoolean
  Enumerated value                  AssetTaxType                          IfcDateTime
  Enumerated value                  AssetInsuranceType                    IfcDateTime
  </table>
  
  - 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.
  <table>
  <b>IsGrouped</b>                   <b>RelatedObjects</b>                <b>Description</b>
                                                                          Physical elements that comprise the asset.
  </table>
*/
class IFC4X3_RC1_EXPORT IfcAsset : public IfcGroup
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x3_rc1::IfcAsset);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of Identification attribute. 
  This attribute represents a unique identification assigned to an asset that enables its differentiation from other assets.
  \returns
  Returns the value of Identification 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.
  */
  const OdAnsiString& getIdentification() const;

  /** \details
  Sets the value of Identification attribute. 
  This attribute represents a unique identification assigned to an asset that enables its differentiation from other assets.
  \param Identification [in] Identification 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.
  */
  void setIdentification(const OdAnsiString& Identification);

  /** \details
  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.
  */
  const OdDAIObjectId& getOriginalValue() const;

  /** \details
  Sets the value of OriginalValue attribute. 
  This attribute represents the cost value of the asset at the time of purchase.
  \param OriginalValue [in] Original value to set.
  */
  void setOriginalValue(const OdDAIObjectId& OriginalValue);

  /** \details
  Returns the value of CurrentValue attribute. 
  This attribute represents the current cost value of the asset.
  \returns
  Returns the value of CurrentValue attribute.
  */
  const OdDAIObjectId& getCurrentValue() const;

  /** \details
  Sets the value of CurrentValue attribute. 
  This attribute represents the current cost value of the asset.
  \param CurrentValue [in] Current value to set.
  */
  void setCurrentValue(const OdDAIObjectId& CurrentValue);

  /** \details
  Returns the value of TotalReplacementCost attribute. 
  This attribute represents the total cost of replacement of the asset.
  \returns
  Returns the value of TotalReplacementCost attribute.
  */
  const OdDAIObjectId& getTotalReplacementCost() const;

  /** \details
  Sets the value of TotalReplacementCost attribute. 
  This attribute represents the total cost of replacement of the asset.
  \param TotalReplacementCost [in] Total replacement cost to set.
  */
  void setTotalReplacementCost(const OdDAIObjectId& TotalReplacementCost);

  /** \details
  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.
  */
  IfcActorSelect owner();

  /** \details
  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.
  */
  IfcActorSelect user();

  /** \details
  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.
  */
  const OdDAIObjectId& getResponsiblePerson() const;

  /** \details
  Sets the value of ResponsiblePerson attribute. 
  This attribute represents the person designated to be responsible for the asset.
  \param 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.
  */
  void setResponsiblePerson(const OdDAIObjectId& ResponsiblePerson);

  /** \details
  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.
  */
  const OdAnsiString& getIncorporationDate() const;

  /** \details
  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.
  \param IncorporationDate [in] Incorporation date to set.
  \remarks
  This is the date on which an asset is considered to start depreciating.
  */
  void setIncorporationDate(const OdAnsiString& IncorporationDate);

  /** \details
  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.
  */
  const OdDAIObjectId& getDepreciatedValue() const;

  /** \details
  Sets the value of DepreciatedValue attribute. 
  This attribute represents the current value of an asset within the accounting rules and procedures of an organization.
  \param DepreciatedValue [in] Depreciated value to set.
  */
  void setDepreciatedValue(const OdDAIObjectId& DepreciatedValue);


public:

  /** \details
  Default constructor for the IfcAsset class.
  */
  IfcAsset();

  /** \details
  Reads object's data from the specified filer.
  \param 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.
  */
  virtual OdResult inFields(OdDAI::OdSpfFilerBase* rdFiler) override;

  /** \details
  Writes object's data the the specified filer.
  \param 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.
  */
  virtual OdResult outFields(OdDAI::OdSpfFilerBase* wrFiler) override;

  /** \details
  Returns a type of a class instance.
  \returns
  Pointer to the <exref target="OdDAI__Entity.html">OdDAI::Entity</exref> type that determines an entity definition within a schema.
  */
  virtual OdDAI::Entity* getInstanceType() const override;

  /** \details
  Returns an attribute value for the specified attribute name.
  \param attrName [in] Name of an attribute to query.
  \returns
  OdRxValue object that represents a generic variant type value.
  */
  virtual OdRxValue getAttr(const char * attrName) const override;

  /** \details
  Early-bound version of instances comparison.
  \param pOther [in] Other application instance.
  \param 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:
  <table>
    Name             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.
  </table>
  */
  virtual bool comparedToEarlyImpl(const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const override;

  /** \details
  Resets a value for the specified attribute.
  \param explicitAttrName [in] Explicit name of the attribute to reset.
  */
  virtual void unsetAttr(const char * explicitAttrName) override;

  /** \details
  Checks whether the specified attribute is set.
  \param explicitAttrName [in] Explicit name of the attribute to test.
  \returns
  true if the specified attribute is set, false otherwise.
  */
  virtual bool testAttr(const char * explicitAttrName) const override;

  /** \details
  Sets the specified attribute with a given value.
  \param explicitAttrName [in] Explicit name of the attribute to set.
  \param val [in] Value to set.
  \returns
  true if the value is successfully set for the specified attribute, false otherwise.
  */
  virtual bool putAttr(const char * explicitAttrName, const OdRxValue &val) override;

  /** \details
  Checks whether the specified instance is the object derived from or belongs to this class.
  \param entityType [in] Entity to check.
  \returns
  true if the specified instance is the object derived from or belongs to this class, false otherwise.
  */
  virtual bool isKindOf(OdIfc::OdIfcEntityType entityType) const override;

  /** \details
  Returns the type of this entity.
  \returns
  A value of the <exref target="OdIfc__OdIfcEntityType.html">OdIfc::OdIfcEntityType</exref> type that represents type of this entity.
  */
  virtual OdIfc::OdIfcEntityType type() const override;

  /** \details
  Returns an attribute value for the specified attribute definition.
  \param attrDef [in] Attribute definition to query.
  \returns
  OdRxValue object that represents a generic variant type value.
  */
  virtual OdRxValue getAttr(const OdIfc::OdIfcAttribute attrDef) const override;

  /** \details
  Resets a value for the specified attribute.
  \param explicitAttrDef [in] Explicit definition that represents an attribute to reset.
  */
  virtual void unsetAttr(const OdIfc::OdIfcAttribute explicitAttrDef) override;

  /** \details
  Checks whether the specified attribute is set.
  \param explicitAttrDef [in] Attribute definition to test.
  \returns
  true if the specified attribute is set, false otherwise.
  */
  virtual bool testAttr(const OdIfc::OdIfcAttribute explicitAttrDef) const override;

  /** \details
  Sets the specified attribute with a given value.
  \param explicitAttrDef [in] Explicit attribute definition to set.
  \param val [in] Value to set.
  \returns
  true if the value is successfully set for the specified attribute, false otherwise.
  */
  virtual bool putAttr(const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val) override;

protected:
  // Fields declaration: 
  OdAnsiString m_Identification;   // IfcIdentifier  [optional]
  OdDAIObjectId m_OriginalValue;   // IfcCostValue  [optional]
  OdDAIObjectId m_CurrentValue;   // IfcCostValue  [optional]
  OdDAIObjectId m_TotalReplacementCost;   // IfcCostValue  [optional]
  OdDAI::Select m_Owner;   // IfcActorSelect  [optional]
  OdDAI::Select m_User;   // IfcActorSelect  [optional]
  OdDAIObjectId m_ResponsiblePerson;   // IfcPerson  [optional]
  OdAnsiString m_IncorporationDate;   // IfcDate  [optional]
  OdDAIObjectId m_DepreciatedValue;   // IfcCostValue  [optional]
};

/** \details
  A data type that represents a smart pointer to a <exref target="OdIfc4x3_rc1__IfcAsset.html">IfcAsset</exref> object.
*/
typedef OdSmartPtr<IfcAsset> IfcAssetPtr;

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X3_RC1_IFCASSET_AUTO_IMPL_H