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

#include "IfcAlignmentParameterSegmentAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  Individual segment along the IfcAlignmentVertical is 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, The IfcSegment Transition enumeration specifies the type of transition explicitly.
  The following vertical segment types are defined in the :
    * Line segment - IfcAlignmentVerticalSegmentTypeEnum.CONSTANTGRADIENT.
    * Circular arc segment - IfcAlignmentVerticalSegmentTypeEnum.CIRCULARARC.
    * Parabolic arc segment - IfcAlignmentVerticalSegmentTypeEnum.PARABOLICARC.
    * Transition segment with linear curvature variation - IfcAlignmentVerticalSegmentTypeEnum.CLOTHOID.
  For each vertical segment, the following non-redundant information is provided:
    * The start point.
    * The start gradient (as a ratio measure with horizontal being 0, uphill positive, and downhill negative), usually between -1 < n < 1.
    * The length (as horizontal length along the distance along (not the curve segment length)).
    * The curve parameter needed for circular and parabolic arc segments.
  The following information can be calculated (and is therefore not exchanged explicitly to avoid redundancy and inconsistencies).
    * The end distance along (from the distance along and segment length).
    * The end height (from start distance along, gradient, length and curve parameter).
    * The end direction (from start direction, segment length and curve parameter).
    * The point of vertical intersection (from start direction and end direction).
*/
class IFC4X4_EXPORT IfcAlignmentVerticalSegment : public IfcAlignmentParameterSegment
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x4::IfcAlignmentVerticalSegment);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of StartDistAlong attribute. StartDistAlong is distance along the horizontal alignment as measured along the corresponding IfcAlignmentHorizontal.
  The distance along is measured from the start point of IfcAlignmentHorizontal.
  \returns
  Returns the value of StartDistAlong attribute.
  */
  double getStartDistAlong() const;

  /** \details
  Sets the value of StartDistAlong attribute. StartDistAlong is distance along the horizontal alignment as measured along the corresponding IfcAlignmentHorizontal.
  The distance along is measured from the start point of IfcAlignmentHorizontal.
  \param StartDistAlong [in] StartDistAlong to set.
  */
  void setStartDistAlong(double StartDistAlong);

  /** \details
  Returns the value of HorizontalLength attribute. Horizontal length is 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. Horizontal length is length measured as distance along the horizontal alignment of the segment.
  \param HorizontalLength [in] Horizontal length to set.
  */
  void setHorizontalLength(double HorizontalLength);

  /** \details
  Returns the value of StartHeight attribute. Start height is 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. Start height is elevation in Z of the start point relative to the IfcAlignment coordinate system.
  \param StartHeight [in] StartHeight to set.
  \remarks
  It is strongly advised to not offset the IfcAlignment coordinate system from the project engineering coordinate system.
  */
  void setStartHeight(double StartHeight);

  /** \details
  Returns the value of StartGradient attribute. Start gradient is start gradient ratio of the segment. 
  Normally, this value should be in range [-1 .. 1], however values that exceed this range are accepted.
  \returns
  Returns the value of StartGradient attribute.
  */
  double getStartGradient() const;

  /** \details
  Sets the value of StartGradient attribute. Start gradient is start gradient ratio of the segment. 
  Normally, this value should be in range [-1 .. 1], however values that exceed this range are accepted.
  \param StartGradient [in] Start gradient ratio to set.
  */
  void setStartGradient(double StartGradient);

  /** \details
  Returns the value of EndGradient attribute. End gradient is end gradient ratio of the segment.
  Normally, this value should be in range [-1 .. 1], however values that exceed this range are accepted.
  \returns
  Returns the value of EndGradient attribute.
  \remarks
  If PredefinedType='.CONSTANTGRADIENT.' then this value is the same as StartGradient.
  */
  double getEndGradient() const;

  /** \details
  Sets the value of EndGradient attribute. End gradient is end gradient ratio of the segment.
  Normally, this value should be in range [-1 .. 1], however values that exceed this range are accepted.
  \param EndGradient [in] End gradient ratio to set.
  \remarks
  If PredefinedType='.CONSTANTGRADIENT.' then this value is the same as StartGradient.
  */
  void setEndGradient(double EndGradient);

  /** \details
  Returns the value of RadiusOfCurvature attribute. Radius of curvature is radius of parabola or arc. Positive values imply a CCW direction whereas negative CW.
  \returns
  Returns the value of RadiusOfCurvature attribute.
  \remarks
  * For PredefinedType is ARC: the radius of the basis circle for the arc.
  * For PredefinedType is PARABOLICARC: the parabola constant (determining the “steepness” of the parabola) is provided by the “minimum parabola radius”, 
    the true radius of a parabola is at its vertical axis (the zero-gradient point of the parabola). 
    The minimum radius is twice the focal length of the parabola (the distance between the focal point and the vertex).
  * For PredefinedType that is not either ARC or PARABOLICARC: the value should be empty.
  */
  double getRadiusOfCurvature() const;

  /** \details
  Sets the value of RadiusOfCurvature attribute. Radius of curvature is radius of parabola or arc. Positive values imply a CCW direction whereas negative CW.
  \param RadiusOfCurvature [in] Radius of curvature to set.
  \remarks
  * For PredefinedType is ARC: the radius of the basis circle for the arc.
  * For PredefinedType is PARABOLICARC: the parabola constant (determining the “steepness” of the parabola) is provided by the “minimum parabola radius”, 
    the true radius of a parabola is at its vertical axis (the zero-gradient point of the parabola). 
    The minimum radius is twice the focal length of the parabola (the distance between the focal point and the vertex).
  * For PredefinedType that is not either ARC or PARABOLICARC: the value should be empty.
  */
  void setRadiusOfCurvature(double RadiusOfCurvature);

  /** \details
  Returns the value of PredefinedType attribute. Predefined type indicates the predefined type of a vertical alignment segment.
  \returns
  Returns the value of PredefinedType attribute that can be one of the following:
  <table>
  <b>Enumeration Value</b>      <b>Segment type</b>                <b>Vertical curvature</b>
  CONSTANTGRADIENT              Constant gradient                  No vertical curvature
  PARABOLICARC                  Vertical curve, parabola           Derivative of gradient with respect to horizontal projection of alignment is constant
  CIRCULARARC                   Vertical curve, circular           Derivative of vertical angle with respect to 3D arc length along the alignment is constant
  CLOTHOID                      Vertical curve, clothoid           Variation of vertical curvature is constant
  </table>
  */
  IfcAlignmentVerticalSegmentTypeEnum getPredefinedType() const;

  /** \details
  Sets the value of PredefinedType attribute. Predefined type indicates the predefined type of a vertical alignment segment.
  \param PredefinedType [in] Predefined type to set.
  \remarks
  Possible value of this attribute:
  <table>
  <b>Enumeration Value</b>      <b>Segment type</b>                <b>Vertical curvature</b>
  CONSTANTGRADIENT              Constant gradient                  No vertical curvature
  PARABOLICARC                  Vertical curve, parabola           Derivative of gradient with respect to horizontal projection of alignment is constant
  CIRCULARARC                   Vertical curve, circular           Derivative of vertical angle with respect to 3D arc length along the alignment is constant
  CLOTHOID                      Vertical curve, clothoid           Variation of vertical curvature is constant
  </table>
  */
  void setPredefinedType(IfcAlignmentVerticalSegmentTypeEnum PredefinedType);


public:

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

  /** \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
  IfcNonNegativeLengthMeasure m_HorizontalLength;   // IfcNonNegativeLengthMeasure
  double m_StartHeight;   // IfcLengthMeasure
  double m_StartGradient;   // IfcRatioMeasure
  double m_EndGradient;   // IfcRatioMeasure
  double m_RadiusOfCurvature;   // IfcLengthMeasure  [optional]
  OdDAI::Enum m_PredefinedType;   // IfcAlignmentVerticalSegmentTypeEnum
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X4_IFCALIGNMENTVERTICALSEGMENT_AUTO_IMPL_H