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

#include "IfcReinforcingElementAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  A tendon is a steel element such as a wire, cable, bar, rod, or strand used to impart prestress to concrete when the element is tensioned.
  - Mapped Geometry -
  This method of representation allows for several tendons represented by a single instance of IfcTendon. 
  The representation map should contain one IfcSweptDiskSolid.
  
  - Object Typing -
  This concept can be applied to the following resources:
  * IfcTendonType

  \changes
  
  * IFC4 changes: 
    * CrossSectionArea attribute is optional.
    * NominalDiameter attribute is optional.
    * PredefinedType attribute is optional.
*/
class IFC4_EXPORT IfcTendon : public IfcReinforcingElement
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4::IfcTendon);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of PredefinedType attribute. 
  This attribute represents predefined generic types for a tendon.
  \returns
  Returns the value of PredefinedType attribute.
  */
  IfcTendonTypeEnum getPredefinedType() const;

  /** \details
  Sets the value of PredefinedType attribute. 
  This attribute represents predefined generic types for a tendon.
  \param PredefinedType [in] Predefined type to set.
  */
  void setPredefinedType(IfcTendonTypeEnum PredefinedType);

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

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

  /** \details
  Returns the value of CrossSectionArea attribute. 
  This attribute represents the effective cross-section area of the tendon.
  \returns
  Returns the value of CrossSectionArea attribute.
  \remarks
  IFC4 CHANGE: Attribute is deprecated. Use respective attribute at IfcTendonType instead.
  */
  double getCrossSectionArea() const;

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

  /** \details
  Returns the value of TensionForce attribute. 
  This attribute represents the maximum allowed tension force that can be applied on the tendon.
  \returns
  Returns the value of TensionForce attribute.
  */
  double getTensionForce() const;

  /** \details
  Sets the value of TensionForce attribute. 
  This attribute represents the maximum allowed tension force that can be applied on the tendon.
  \param TensionForce [in] Tension force to set.
  */
  void setTensionForce(double TensionForce);

  /** \details
  Returns the value of PreStress attribute. 
  This attribute represents the prestress to be applied on the tendon.
  \returns
  Returns the value of PreStress attribute.
  */
  double getPreStress() const;

  /** \details
  Sets the value of PreStress attribute. 
  This attribute represents the prestress to be applied on the tendon.
  \param PreStress [in] PreStress to set.
  */
  void setPreStress(double PreStress);

  /** \details
  Returns the value of FrictionCoefficient attribute. 
  This attribute represents the friction coefficient between tendon and tendon sheet while the tendon is unbonded.
  \returns
  Returns the value of FrictionCoefficient attribute.
  */
  double getFrictionCoefficient() const;

  /** \details
  Sets the value of FrictionCoefficient attribute. 
  This attribute represents the friction coefficient between tendon and tendon sheet while the tendon is unbonded.
  \param FrictionCoefficient [in] Friction coefficient to set.
  */
  void setFrictionCoefficient(double FrictionCoefficient);

  /** \details
  Returns the value of AnchorageSlip attribute. 
  This attribute represents the deformation of an anchor or slippage of tendons when the prestressing device is released.
  \returns
  Returns the value of AnchorageSlip attribute.
  */
  double getAnchorageSlip() const;

  /** \details
  Sets the value of AnchorageSlip attribute. 
  This attribute represents the deformation of an anchor or slippage of tendons when the prestressing device is released.
  \param AnchorageSlip [in] Anchorage slip to set.
  */
  void setAnchorageSlip(double AnchorageSlip);

  /** \details
  Returns the value of MinCurvatureRadius attribute. 
  This attribute represents the smallest curvature radius calculated on the whole effective length 
  of the tendon where the tension properties are still valid.
  \returns
  Returns the value of MinCurvatureRadius attribute.
  */
  double getMinCurvatureRadius() const;

  /** \details
  Sets the value of MinCurvatureRadius attribute. 
  This attribute represents the smallest curvature radius calculated on the whole effective length 
  of the tendon where the tension properties are still valid.
  \param MinCurvatureRadius [in] Minimum curvature radius to set.
  */
  void setMinCurvatureRadius(double MinCurvatureRadius);


public:

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

  /** \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: 
  OdDAI::Enum m_PredefinedType;   // IfcTendonTypeEnum  [optional]
  IfcPositiveLengthMeasure m_NominalDiameter;   // IfcPositiveLengthMeasure  [optional]
  double m_CrossSectionArea;   // IfcAreaMeasure  [optional]
  double m_TensionForce;   // IfcForceMeasure  [optional]
  double m_PreStress;   // IfcPressureMeasure  [optional]
  IfcNormalisedRatioMeasure m_FrictionCoefficient;   // IfcNormalisedRatioMeasure  [optional]
  IfcPositiveLengthMeasure m_AnchorageSlip;   // IfcPositiveLengthMeasure  [optional]
  IfcPositiveLengthMeasure m_MinCurvatureRadius;   // IfcPositiveLengthMeasure  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4_IFCTENDON_AUTO_IMPL_H