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

#include "IfcReinforcingElementAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  A reinforcing bar is usually made of steel with manufactured deformations in the surface, 
  and used in concrete and masonry construction to provide additional strength. 
  A single instance of this class can represent one or many of actual rebars, for example a row of rebars.
  
  - Mapped Geometry -
  The representation map should contain a representation 
  of AdvancedSweptSolid type which holds an IfcSweptDiskSolid (including subtype IfcSweptDiskSolidPolygonal). 
  Multiple IfcMappedItem's can be used to represent several bars as one occurrence of IfcReinforcingBar.
  
  - Material Set -
  This concept can be applied to the following resources:
  * Core - Material from which the rebar is constructed, such as steel.
  * Coating - Outer coating, if applicable.
  
  - Object Typing -
  This concept can be applied to the following resources:
  * IfcReinforcingBarType
*/
class IFC2X3_EXPORT IfcReinforcingBar : public IfcReinforcingElement
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x3::IfcReinforcingBar);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of NominalDiameter attribute. 
  This attribute represents the nominal diameter defining the cross-section size of the reinforcing bar.
  \returns
  Returns the value of NominalDiameter attribute.
  \remarks
  IFC4 CHANGE: Attribute is deprecated. Use corresponding attribute at IfcReinforcingBarType instead.
  */
  double getNominalDiameter() const;

  /** \details
  Sets the value of NominalDiameter attribute. 
  This attribute represents the nominal diameter defining the cross-section size of the reinforcing bar.
  \param NominalDiameter [in] Nominal diameter to set.
  \remarks
  IFC4 CHANGE: Attribute is deprecated. Use corresponding attribute at IfcReinforcingBarType instead.
  */
  void setNominalDiameter(double NominalDiameter);

  /** \details
  Returns the value of CrossSectionArea attribute. 
  This attribute represents the effective cross-section area of the reinforcing bar or group of bars.
  \returns
  Returns the value of CrossSectionArea attribute.
  \remarks
  IFC4 CHANGE: Attribute is deprecated. Use corresponding attribute at IfcReinforcingBarType instead.
  */
  double getCrossSectionArea() const;

  /** \details
  Sets the value of CrossSectionArea attribute. 
  This attribute represents the effective cross-section area of the reinforcing bar or group of bars.
  \param CrossSectionArea [in] Cross-section area to set.
  \remarks
  IFC4 CHANGE: Attribute is deprecated. Use corresponding attribute at IfcReinforcingBarType instead.
  */
  void setCrossSectionArea(double CrossSectionArea);

  /** \details
  Returns the value of BarLength attribute. 
  This attribute represents the total length of the reinforcing bar. 
  The total length of bended bars are calculated according to local standards with corrections for the bends.
  \returns
  Returns the value of BarLength attribute.
  \remarks
  IFC4 CHANGE: Attribute is deprecated. Use corresponding attribute at IfcReinforcingBarType instead.
  */
  double getBarLength() const;

  /** \details
  Sets the value of BarLength attribute. 
  This attribute represents the total length of the reinforcing bar. 
  The total length of bended bars are calculated according to local standards with corrections for the bends.
  \param BarLength [in] Bar length to set.
  \remarks
  IFC4 CHANGE: Attribute is deprecated. Use corresponding attribute at IfcReinforcingBarType instead.
  */
  void setBarLength(double BarLength);

  /** \details
  Returns the value of BarRole attribute. 
  This attribute represents the role, purpose or usage of the bar, i.e. the kind of loads and stresses it is intended to carry.
  \returns
  Returns the value of BarRole attribute.
  \remarks
  IFC4 CHANGE: Attribute is deprecated. Use corresponding attribute at IfcReinforcingBarType instead.
  */
  IfcReinforcingBarRoleEnum getBarRole() const;

  /** \details
  Sets the value of BarRole attribute. 
  This attribute represents the role, purpose or usage of the bar, i.e. the kind of loads and stresses it is intended to carry.
  \param BarRole [in] Bar role to set.
  \remarks
  IFC4 CHANGE: Attribute is deprecated. Use corresponding attribute at IfcReinforcingBarType instead.
  */
  void setBarRole(IfcReinforcingBarRoleEnum BarRole);

  /** \details
  Returns the value of BarSurface attribute. 
  This attribute represents indicator for whether the bar surface is plain or textured.
  \returns
  Returns the value of BarSurface attribute.
  \remarks
  IFC4 CHANGE: Attribute is deprecated. Use corresponding attribute at IfcReinforcingBarType instead.
  */
  IfcReinforcingBarSurfaceEnum getBarSurface() const;

  /** \details
  Sets the value of BarSurface attribute. 
  This attribute represents indicator for whether the bar surface is plain or textured.
  \param BarSurface [in] Bar surface to set.
  \remarks
  IFC4 CHANGE: Attribute is deprecated. Use corresponding attribute at IfcReinforcingBarType instead.
  */
  void setBarSurface(IfcReinforcingBarSurfaceEnum BarSurface);


public:

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

  /** \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: 
  IfcPositiveLengthMeasure m_NominalDiameter;   // IfcPositiveLengthMeasure
  double m_CrossSectionArea;   // IfcAreaMeasure
  IfcPositiveLengthMeasure m_BarLength;   // IfcPositiveLengthMeasure  [optional]
  OdDAI::Enum m_BarRole;   // IfcReinforcingBarRoleEnum
  OdDAI::Enum m_BarSurface;   // IfcReinforcingBarSurfaceEnum  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X3_IFCREINFORCINGBAR_AUTO_IMPL_H