/////////////////////////////////////////////////////////////////////////////// 
// 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 _IFC2X_FINAL_IFCRESOURCE_AUTO_IMPL_H
#define _IFC2X_FINAL_IFCRESOURCE_AUTO_IMPL_H

#include "IfcObjectAutoImpl.h"
#include "IfcMeasureWithUnitAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  IfcResource contains the information needed to represent the costs, schedule, 
  and other impacts from the use of a thing in a process. 
  It is not intended to use IfcResource to model the general properties of the things themselves, 
  while an optional linkage from IfcResource to the things to be used can be specified 
  (specifically, the relationship from subtypes of IfcResource to IfcProduct through the IfcRelAssignsToResource relationship).
  
  There are two basic intended uses of IfcResource. First, if the attributes of the thing are not needed for the purpose of the use of IfcResource, 
  or the types of things are not explicitly modeled in IFC yet, 
  then the linkage between the resource and the thing doesn't have to be instantiated in the system. 
  That is, the attributes of IfcResource (or its subtypes) alone are sufficient 
  to represent the use of the thing as a resource for the purpose of the project.
  
  If the attributes of the thing are needed for the use of IfcResource objects, 
  and they are modeled explicitly as objects, then the IfcResource instances 
  can be linked to the instances of the type of the things being referenced. 
  Things that might be used as resources and that are already modeled in the IFC 
  include physical products, people and organizations, and materials. 
  The relationship object IfcRelAssignsToResource is provided for this approach.
  The inherited attribute ObjectType is used as a textual code that identifies the resource type.

  \remarks
  This definition cannot be instantiated
*/
class IFC2X_FINAL_EXPORT IfcResource : public IfcObject
{
  //DOM-IGNORE-BEGIN
  OD_EXP_NON_INSTANTIABLE_DECLARE_MEMBERS(OdIfc2x_final::IfcResource);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of ResourceConsumption attribute. 
  This attribute represents a value that indicates how the resource 
  is consumed during its use in a process (see IfcResourceConsumptionEnum for more detail).
  \returns
  Returns the value of ResourceConsumption attribute.
  */
  IfcResourceConsumptionEnum getResourceConsumption() const;

  /** \details
  Sets the value of ResourceConsumption attribute. 
  This attribute represents a value that indicates how the resource 
  is consumed during its use in a process (see IfcResourceConsumptionEnum for more detail).
  \param ResourceConsumption [in] Resource consumption to set.
  */
  void setResourceConsumption(IfcResourceConsumptionEnum ResourceConsumption);

  /** \details
  Returns the value of BaseUnit attribute. 
  This attribute represents the basic (i.e. default, or recommended) unit 
  that should be used for measuring the volume (or amount) of the resource.
  \returns
  Returns the value of BaseUnit attribute.
  */
  const OdDAIObjectId& getBaseUnit() const;

  /** \details
  Sets the value of BaseUnit attribute. 
  This attribute represents the basic (i.e. default, or recommended) unit 
  that should be used for measuring the volume (or amount) of the resource.
  \param BaseUnit [in] Base unit to set.
  */
  void setBaseUnit(const OdDAIObjectId& BaseUnit);

  /** \details
  Returns the value of ResourceOf attribute. 
  This attribute represents set of relationships to other objects, 
  e.g. products, processes, controls, resources or actors, for which this resource object is a resource.
  \param ResourceOf [out] Receives the value of ResourceOf attribute.
  */
  void getInvResourceOf(OdDAIObjectIds& ResourceOf) const;


public:

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

  /** \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
  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: 
  OdDAI::Enum m_ResourceConsumption;   // IfcResourceConsumptionEnum  [optional]
  OdDAIObjectId m_BaseUnit;   // IfcMeasureWithUnit  [optional]

  // Declare friend classes for inverse attributes functionality: 
  friend class IfcRelAssignsToResource;
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X_FINAL_IFCRESOURCE_AUTO_IMPL_H