/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCSPACEPROGRAM_AUTO_IMPL_H
#define _IFC2X_FINAL_IFCSPACEPROGRAM_AUTO_IMPL_H

#include "IfcControlAutoImpl.h"
#include "IfcSpatialStructureElementAutoImpl.h"
#include "IfcCostValueAutoImpl.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
  Architectural program for a space in the building or facility is designed, essentially the requirements definition for such a building space. 
  The assignment of a person or an organization to a space program, e.g. 
  is handled through using the objectified relationship IfcRelAssignsToActor referring to IfcActor. 
  Space programs can be nested, i.e. an IfcSpaceProgram can specify a program group up to any desired level. 
  This is handled through using the objectified relationship IfcRelNests.
*/
class IFC2X_FINAL_EXPORT IfcSpaceProgram : public IfcControl
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcSpaceProgram);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of SpaceProgramIdentifier attribute. 
  This attribute represents the identifier for this space program. 
  It often refers to a number (or code) assigned to the space program. Example: R-001.
  \returns
  Returns the value of SpaceProgramIdentifier attribute.
  */
  const OdAnsiString& getSpaceProgramIdentifier() const;

  /** \details
  Sets the value of SpaceProgramIdentifier attribute. 
  This attribute represents the identifier for this space program. 
  It often refers to a number (or code) assigned to the space program. Example: R-001.
  \param SpaceProgramIdentifier [in] SpaceProgramIdentifier attribute to set.
  */
  void setSpaceProgramIdentifier(const OdAnsiString& SpaceProgramIdentifier);

  /** \details
  Returns the value of MaxRequiredArea attribute. 
  This attribute represents the the maximum floor area programmed for this space (according to client requirements).
  \returns
  Returns the value of MaxRequiredArea attribute.
  */
  double getMaxRequiredArea() const;

  /** \details
  Sets the value of MaxRequiredArea attribute. 
  This attribute represents the the maximum floor area programmed for this space (according to client requirements).
  \param MaxRequiredArea [in] MaxRequiredArea attribute to set.
  */
  void setMaxRequiredArea(double MaxRequiredArea);

  /** \details
  Returns the value of MinRequiredArea attribute. 
  This attribute represents the minimum floor area programmed for this space (according to client requirements).
  \returns
  Returns the value of MinRequiredArea attribute.
  */
  double getMinRequiredArea() const;

  /** \details
  Sets the value of MinRequiredArea attribute. 
  This attribute represents the minimum floor area programmed for this space (according to client requirements).
  \param MinRequiredArea [in] MinRequiredArea attribute to set.
  */
  void setMinRequiredArea(double MinRequiredArea);

  /** \details
  Returns the value of RequestedLocation attribute. 
  This attribute represents the location within the building structure, requested for the space.
  \returns
  Returns the value of RequestedLocation attribute.
  */
  const OdDAIObjectId& getRequestedLocation() const;

  /** \details
  Sets the value of RequestedLocation attribute. 
  This attribute represents the location within the building structure, requested for the space.
  \param RequestedLocation [in] RequestedLocation attribute to set.
  */
  void setRequestedLocation(const OdDAIObjectId& RequestedLocation);

  /** \details
  Returns the value of MinEstimatedCost attribute. 
  This attribute represents the minimum costs estimated for the space program.
  \returns
  Returns the value of MinEstimatedCost attribute.
  */
  const OdDAIObjectId& getMinEstimatedCost() const;

  /** \details
  Sets the value of MinEstimatedCost attribute. 
  This attribute represents the minimum costs estimated for the space program.
  \param MinEstimatedCost [in] MinEstimatedCost attribute to set.
  */
  void setMinEstimatedCost(const OdDAIObjectId& MinEstimatedCost);

  /** \details
  Returns the value of MaxEstimatedCost attribute. 
  This attribute represents the maximum costs estimated for the space program.
  \returns
  Returns the value of MaxEstimatedCost attribute.
  */
  const OdDAIObjectId& getMaxEstimatedCost() const;

  /** \details
  Sets the value of MaxEstimatedCost attribute. 
  This attribute represents the maximum costs estimated for the space program.
  \param MaxEstimatedCost [in] MaxEstimatedCost attribute to set.
  */
  void setMaxEstimatedCost(const OdDAIObjectId& MaxEstimatedCost);

  /** \details
  Returns the value of StandardRequiredArea attribute. 
  This attribute represents the floor area programmed for this space (according to client requirements).
  \returns
  Returns the value of StandardRequiredArea attribute.
  */
  double getStandardRequiredArea() const;

  /** \details
  Sets the value of StandardRequiredArea attribute. 
  This attribute represents the floor area programmed for this space (according to client requirements).
  \param StandardRequiredArea [in] StandardRequiredArea attribute to set.
  */
  void setStandardRequiredArea(double StandardRequiredArea);

  /** \details
  Gets the value of HasInteractionReqsFrom attribute. 
  This attribute represents the set of inverse relationships to space or work interaction requirement objects.
  \param HasInteractionReqsFrom [out] Receives the HasInteractionReqsFrom attribute.
  */
  void getInvHasInteractionReqsFrom(OdDAIObjectIds& HasInteractionReqsFrom) const;

  /** \details
  Gets the value of HasInteractionReqsTo attribute. 
  This attribute represents the set of inverse relationships to space or work interaction requirements.
  \param HasInteractionReqsTo [out] Receives the HasInteractionReqsTo attribute.
  */
  void getInvHasInteractionReqsTo(OdDAIObjectIds& HasInteractionReqsTo) const;


public:

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

  /** \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: 
  OdAnsiString m_SpaceProgramIdentifier;   // IfcIdentifier
  double m_MaxRequiredArea;   // IfcAreaMeasure  [optional]
  double m_MinRequiredArea;   // IfcAreaMeasure  [optional]
  OdDAIObjectId m_RequestedLocation;   // IfcSpatialStructureElement  [optional]
  OdDAIObjectId m_MinEstimatedCost;   // IfcCostValue  [optional]
  OdDAIObjectId m_MaxEstimatedCost;   // IfcCostValue  [optional]
  double m_StandardRequiredArea;   // IfcAreaMeasure

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

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X_FINAL_IFCSPACEPROGRAM_AUTO_IMPL_H