/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCALIGNMENTHORIZONTALSEGMENT_AUTO_IMPL_H
#define _IFC4X4_IFCALIGNMENTHORIZONTALSEGMENT_AUTO_IMPL_H

#include "IfcAlignmentParameterSegmentAutoImpl.h"
#include "IfcCartesianPointAutoImpl.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 IfcAlignmentHorizontal, being defined in the x/y coordinate space. 
  Each single horizontal alignment segment has an optional associated segment definition. 
  The placement of IfcAlignmentHorizontalSegment and the IfcCurveSegment StartPlacement correspond to each other.
  
  The following information can be calculated (and is therefore not exchanged explicitly to avoid redundancy and inconsistencies):
  * the end point (from start point, direction, segment length and curve parameter)
  * the start distance along (from the end distance along of the previous segment, or the start distance along of the horizontal alignment (if it is the first segment)
  * the end distance along (from the start distance and the segment length)
  * the end direction (from the curve parameter, the start direction and the segment length)
  * the point of intersection (from the start direction and the end direction)
  
  The following checks can be done to validate the correct exchange:
  * continuity – whether the calculated end point of the previous segment matches with the provided start point of this segment
  * tangential continuity – whether the calculated end direction of the previous segment matches with the provided start direction of this segment
*/
class IFC4X4_EXPORT IfcAlignmentHorizontalSegment : public IfcAlignmentParameterSegment
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x4::IfcAlignmentHorizontalSegment);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of StartPoint attribute. StartPoint is the start point of the segment defined by a Cartesian point.
  \returns
  Returns the value of StartPoint attribute.
  */
  const OdDAIObjectId& getStartPoint() const;

  /** \details
  Sets the value of StartPoint attribute. StartPoint is the start point of the segment defined by a Cartesian point.
  \param StartPoint [in] StartPoint to set.
  */
  void setStartPoint(const OdDAIObjectId& StartPoint);

  /** \details
  Returns the value of StartDirection attribute. StartDirection is the direction of the tangent at the start point. 
  Direction value 0 indicates a curve with a start tangent along the positive x-axis. Values increases counter-clockwise, and decreases clockwise. 
  Depending on the plane angle unit, either degree or radians, the sensible range is -360° ≤ n ≤ 360° (or -2π ≤ n ≤ 2π). 
  Values larger than a full circle (>|360°| or >|2 π| are not used.
  \returns
  Returns the value of StartDirection attribute.
  */
  double getStartDirection() const;

  /** \details
  Sets the value of StartDirection attribute. StartDirection is the direction of the tangent at the start point. 
  Direction value 0 indicates a curve with a start tangent along the positive x-axis. Values increases counter-clockwise, and decreases clockwise. 
  Depending on the plane angle unit, either degree or radians, the sensible range is -360° ≤ n ≤ 360° (or -2π ≤ n ≤ 2π). 
  Values larger than a full circle (>|360°| or >|2 π| are not used.
  \param StartDirection [in] StartDirection to set.
  */
  void setStartDirection(double StartDirection);

  /** \details
  Returns the value of StartRadiusOfCurvature attribute. For a NONLINEAR horizontal segment type 
  the radius of the curve is at the start point (placement of the segment). For CIRCULAR type it is constant i.e. 
  StartRadiusOfCurvature and EndRadiusOfCurvature are always the same. For LINE type, both StartRadiusOfCurvature and EndRadiusOfCurvature are 0. 
  If the radius is 0 it is interpreted as INFINITE. Positive values imply a CCW direction whereas negative CW.
  \returns
  Returns the value of StartRadiusOfCurvature attribute.
  */
  double getStartRadiusOfCurvature() const;

  /** \details
  Sets the value of StartRadiusOfCurvature attribute. For a NONLINEAR horizontal segment type 
  the radius of the curve is at the start point (Placement of the segment). For CIRCULAR type it is constant i.e. 
  StartRadiusOfCurvature and EndRadiusOfCurvature are always the same. For LINE type, both StartRadiusOfCurvature and EndRadiusOfCurvature are 0. 
  If the radius is 0 it is interpreted as INFINITE. Positive values imply a CCW direction whereas negative CW.
  \param StartRadiusOfCurvature [in] Start radius of curvature to set.
  */
  void setStartRadiusOfCurvature(double StartRadiusOfCurvature);

  /** \details
  Returns the value of EndRadiusOfCurvature attribute. For a NONLINEAR horizontal segment type the radius of the curve is at the end point. 
  If the radius is 0 it is interpreted as INFINITE. Positive values imply a CCW direction whereas negative CW.
  \returns
  Returns the value of EndRadiusOfCurvature attribute.
  */
  double getEndRadiusOfCurvature() const;

  /** \details
  Sets the value of EndRadiusOfCurvature attribute. For a NONLINEAR horizontal segment type the radius of the curve is at the end point. 
  If the radius is 0 it is interpreted as INFINITE. Positive values imply a CCW direction whereas negative CW.
  \param EndRadiusOfCurvature [in] End radius of curvature to set.
  */
  void setEndRadiusOfCurvature(double EndRadiusOfCurvature);

  /** \details
  Returns the value of SegmentLength attribute. SegmentLength is the length along the curve.
  \returns
  Returns the value of SegmentLength attribute.
  */
  double getSegmentLength() const;

  /** \details
  Sets the value of SegmentLength attribute. SegmentLength is the length along the curve.
  \param SegmentLength [in] Segment length to set.
  */
  void setSegmentLength(double SegmentLength);

  /** \details
  Returns the value of GravityCenterLineHeight attribute. GravityCenterLineHeight is optional attribute required for the exchange of Vienna bend transition segment.
  \returns
  Returns the value of GravityCenterLineHeight attribute.
  */
  double getGravityCenterLineHeight() const;

  /** \details
  Sets the value of GravityCenterLineHeight attribute. GravityCenterLineHeight is optional attribute required for the exchange of Vienna bend transition segment.
  \param GravityCenterLineHeight [in] Gravity center line height to set.
  */
  void setGravityCenterLineHeight(double GravityCenterLineHeight);

  /** \details
  Returns the value of PredefinedType attribute. PredefinedType identifies the predefined type of a horizontal alignment segment.
  \returns
  Returns the value from the IfcAlignmentHorizontalSegmentTypeEnum enumeration that represents a horizontal alignment segment.
  */
  IfcAlignmentHorizontalSegmentTypeEnum getPredefinedType() const;

  /** \details
  Sets the value of PredefinedType attribute. PredefinedType identifies the predefined type of a horizontal alignment segment.
  \param PredefinedType [in] Predefined type to set.
  */
  void setPredefinedType(IfcAlignmentHorizontalSegmentTypeEnum PredefinedType);


public:

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

  /** \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: 
  OdDAIObjectId m_StartPoint;   // IfcCartesianPoint
  double m_StartDirection;   // IfcPlaneAngleMeasure
  double m_StartRadiusOfCurvature;   // IfcLengthMeasure
  double m_EndRadiusOfCurvature;   // IfcLengthMeasure
  IfcNonNegativeLengthMeasure m_SegmentLength;   // IfcNonNegativeLengthMeasure
  IfcPositiveLengthMeasure m_GravityCenterLineHeight;   // IfcPositiveLengthMeasure  [optional]
  OdDAI::Enum m_PredefinedType;   // IfcAlignmentHorizontalSegmentTypeEnum
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X4_IFCALIGNMENTHORIZONTALSEGMENT_AUTO_IMPL_H