/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCALIGNMENT2DVERTICALSEGMENT_AUTO_IMPL_H
#define _IFC4X3_RC1_IFCALIGNMENT2DVERTICALSEGMENT_AUTO_IMPL_H

#include "IfcAlignment2DSegmentAutoImpl.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
  This definition represents an individual segment along the IfcAlignment2DVertical, being defined in the distance-along/z coordinate space.
  The vertical alignment is defined by segments that connects end-to-start. 
  The vertical alignment curve geometry is defined in a plane with x = distance along horizontal, the y = height (or elevation). 
  The transition at the segment connection is not enforced to be tangential, 
  if the “tangential continuity” flag is set to false, otherwise a tangential continuity shall be preserved.
  
  The following vertical segment types are defined:
  * line segment - IfcAlignment2DVerSegLine
  * circular arc segment - IfcAlignment2DVerSegCircularArc
  * parabolic arc segment - IfcAlignment2DVerSegParabolicArc which can describe symmetric and asymmetric parabolas
*/
class IFC4X3_RC1_EXPORT IfcAlignment2DVerticalSegment : public IfcAlignment2DSegment
{
  //DOM-IGNORE-BEGIN
  OD_EXP_NON_INSTANTIABLE_DECLARE_MEMBERS(OdIfc4x3_rc1::IfcAlignment2DVerticalSegment);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of StartDistAlong attribute. 
  This attribute represents the distance along the horizontal alignment, 
  measured along the IfcAlignment2DHorizontal given in the length unit of the global IfcUnitAssignment.
  \returns
  Returns the value of StartDistAlong attribute.
  */
  double getStartDistAlong() const;

  /** \details
  Sets the value of StartDistAlong attribute. 
  This attribute represents the distance along the horizontal alignment, 
  measured along the IfcAlignment2DHorizontal given in the length unit of the global IfcUnitAssignment.
  \param StartDistAlong [in] StartDistAlong attribute to set.
  */
  void setStartDistAlong(double StartDistAlong);

  /** \details
  Returns the value of HorizontalLength attribute. 
  This attribute represents the length measured as distance along the horizontal alignment of the segment.
  \returns
  Returns the value of HorizontalLength attribute.
  */
  double getHorizontalLength() const;

  /** \details
  Sets the value of HorizontalLength attribute. 
  This attribute represents the length measured as distance along the horizontal alignment of the segment.
  \param HorizontalLength [in] HorizontalLength attribute to set.
  */
  void setHorizontalLength(double HorizontalLength);

  /** \details
  Returns the value of StartHeight attribute. 
  This attribute represents the elevation in Z of the start point relative to the IfcAlignment coordinate system.
  \returns
  Returns the value of StartHeight attribute.
  */
  double getStartHeight() const;

  /** \details
  Sets the value of StartHeight attribute. 
  This attribute represents the elevation in Z of the start point relative to the IfcAlignment coordinate system.
  \param StartHeight [in] StartHeight attribute to set.
  */
  void setStartHeight(double StartHeight);

  /** \details
  Returns the value of StartGradient attribute. 
  This attribute represents the gradient of the tangent of the vertical segment at the start point. 
  It is provided as a ratio measure. The ratio is percentage/100 (0.1 is equal to 10%). 
  It has a theoretical range of -∞ < n < ∞ using a ratio measure. 
  The equivalent range measured in degree is -90° < n < 90°.
  Positive gradient means an increasing height at the start (or uphill), 
  a negative gradient means decreasing height at the start (or downhill).
  \returns
  Returns the value of StartGradient attribute.
  */
  double getStartGradient() const;

  /** \details
  Sets the value of StartGradient attribute. 
  This attribute represents the gradient of the tangent of the vertical segment at the start point. 
  It is provided as a ratio measure. The ratio is percentage/100 (0.1 is equal to 10%). 
  It has a theoretical range of -∞ < n < ∞ using a ratio measure. 
  The equivalent range measured in degree is -90° < n < 90°.
  Positive gradient means an increasing height at the start (or uphill), 
  a negative gradient means decreasing height at the start (or downhill).
  \param StartGradient [in] StartGradient attribute to set.
  */
  void setStartGradient(double StartGradient);
  void getInvToVertical(OdDAIObjectIds& ToVertical) const;


public:

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

  /** \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: 
  double m_StartDistAlong;   // IfcLengthMeasure
  IfcPositiveLengthMeasure m_HorizontalLength;   // IfcPositiveLengthMeasure
  double m_StartHeight;   // IfcLengthMeasure
  double m_StartGradient;   // IfcRatioMeasure

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

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X3_RC1_IFCALIGNMENT2DVERTICALSEGMENT_AUTO_IMPL_H