/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCALIGNMENTCANTSEGMENT_AUTO_IMPL_H
#define _IFC4X4_IFCALIGNMENTCANTSEGMENT_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
  This class represents an individual segment (or sequence) that defines whole cant alignment.
  The cant alignment is defined by ordered segments that connect end-to-start. 
  The points defined in a cant alignment segment are defined in a plane with x = distance along horizontal alignment and y = height 
  relative to projected points in vertical alignment. The following cant segment types are defined in the IfcAlignmentCantSegmentTypeEnum enumeration:
  * Bloss transition - kIfcAlignmentCantSegmentTypeEnum_BLOSSCURVE.
  * Constant cant - kIfcAlignmentCantSegmentTypeEnum_CONSTANTCANT.
  * Cosine transition - kIfcAlignmentCantSegmentTypeEnum_COSINECURVE.
  * Helmert transition - kIfcAlignmentCantSegmentTypeEnum_HELMERTCURVE.
  * Linear transition - kIfcAlignmentCantSegmentTypeEnum_LINEARTRANSITION.
  * Sine transition - kIfcAlignmentCantSegmentTypeEnum_SINECURVE.
  * Viennese Bend (R) transition - kIfcAlignmentCantSegmentTypeEnum_VIENNESEBEND.
  
  For each cant segment, the following information is provided:
  * The start point, defined by distance along the horizontal alignment.
  * The length (as horizontal length along the distance along (not the curve segment length)).
  * The start cant, given by the values of left cant and right cant, measured relatively to vertical alignment.
  * The end cant, given by the values of left cant and right cant, measured from vertical alignment.
  * The information of tangential continuity that can be used to check continuity of segments 
    (e.g. invalid sudden change of cant or missing cant information if end point and starting point differ over a threshold).
*/
class IFC4X4_EXPORT IfcAlignmentCantSegment : public IfcAlignmentParameterSegment
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x4::IfcAlignmentCantSegment);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of StartDistAlong attribute. StartDistAlong is 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. StartDistAlong is distance along the horizontal alignment, 
  measured along the IfcAlignment2DHorizontal given in the length unit of the global IfcUnitAssignment.
  \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 StartCantLeft attribute. StartCantLeft is length measured for the left cant at the beginning of the segment.
  \returns
  Returns the value of StartCantLeft attribute.
  */
  double getStartCantLeft() const;

  /** \details
  Sets the value of StartCantLeft attribute. StartCantLeft is length measured for the left cant at the beginning of the segment.
  \param StartCantLeft [in] StartCantLeft to set.
  */
  void setStartCantLeft(double StartCantLeft);

  /** \details
  Returns the value of EndCantLeft attribute. EndCantLeft is length measured for the left cant at the end of the segment.
  \returns
  Returns the value of EndCantLeft attribute.
  */
  double getEndCantLeft() const;

  /** \details
  Sets the value of EndCantLeft attribute. EndCantLeft is length measured for the left cant at the end of the segment.
  \param EndCantLeft [in] EndCantLeft to set.
  */
  void setEndCantLeft(double EndCantLeft);

  /** \details
  Returns the value of StartCantRight attribute. StartCantRight is length measured for the right cant at the beginning of the segment.
  \returns
  Returns the value of StartCantRight attribute.
  */
  double getStartCantRight() const;

  /** \details
  Sets the value of StartCantRight attribute. StartCantRight is length measured for the right cant at the beginning of the segment.
  \param StartCantRight [in] StartCantRight to set.
  */
  void setStartCantRight(double StartCantRight);

  /** \details
  Returns the value of EndCantRight attribute. EndCantRight is length measured for the right cant at the end of the segment.
  \returns
  Returns the value of EndCantRight attribute.
  */
  double getEndCantRight() const;

  /** \details
  Sets the value of EndCantRight attribute. EndCantRight is length measured for the right cant at the end of the segment.
  \param EndCantRight [in] EndCantRight to set.
  */
  void setEndCantRight(double EndCantRight);

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

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


public:

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

  /** \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_StartCantLeft;   // IfcLengthMeasure
  double m_EndCantLeft;   // IfcLengthMeasure  [optional]
  double m_StartCantRight;   // IfcLengthMeasure
  double m_EndCantRight;   // IfcLengthMeasure  [optional]
  OdDAI::Enum m_PredefinedType;   // IfcAlignmentCantSegmentTypeEnum
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X4_IFCALIGNMENTCANTSEGMENT_AUTO_IMPL_H