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

#include "IfcAlignment2DVerticalSegmentAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  The vertical parabolic segment is defined as a parabola using the inherited attributes from IfcAlignment2DVerticalSegment 
  and the following additional curve parameters ParabolaConstant as the minimum radius of the parabolic arc at its apex, 
  and IsConvex to indicate the whether the parabolic arc defined a sag or a crest.
  
  The parabolic arc is described by (see figure 1):
  * R = signed ParabolaConstant, if IsConvex = true, then -R, if IsConvex = false, then +R as length measure
  * s<sub>0</sub> = StartDistAlong as length measure
  * z<sub>0</sub> = StartHeight as length measure
  * g<sub>0</sub> = StartGradient as ratio measure
  
  The following equations are used for any point along the parabola:
  * at any point s<sub>1</sub> along the HorizontalLength
  * the gradient g<sub>1</sub> = (s<sub>1</sub>-s<sub>0</sub>) / R + g<sub>0</sub>
  * the height z<sub>1</sub> = (s<sub>1</sub>-s<sub>0</sub>) * (g<sub>1</sub>+g<sub>0</sub>)/2 + z<sub>0</sub>
  
  Alignment vertical segment parabola convex:
  
  <IMAGE ifcalignment2dversegparabolicarc_fig1>
  Legend:
  * red: the parabolic curve with start point and calculated end point used as an vertical alignment
  * yellow: the underlying unbounded parabola definition
  * blue: the minimum circle defined by the parabola constant agreeing to the "is convex" flag, the constant, and the start gradient
  
  The image below shows alignment vertical parabolic arc segment convex:
  
  <IMAGE ifcalignment2dversegparabolicarc-convex>
  
  The image below shows alignment vertical parabolic arc segment concave:
  
  <IMAGE ifcalignment2dversegparabolicarc-concave>
*/
class IFC4X1_EXPORT IfcAlignment2DVerSegParabolicArc : public IfcAlignment2DVerticalSegment
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x1::IfcAlignment2DVerSegParabolicArc);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of ParabolaConstant attribute. 
  This attribute represents the parabola constant that determines the “steepness” of the parabola. 
  The parabola constant is provided by the “minimum parabola radius”, 
  the true radius of a parabola 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).
  \returns
  Returns the value of ParabolaConstant attribute.
  */
  double getParabolaConstant() const;

  /** \details
  Sets the value of ParabolaConstant attribute. 
  This attribute represents the parabola constant that determines the “steepness” of the parabola. 
  The parabola constant is provided by the “minimum parabola radius”, 
  the true radius of a parabola 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).
  \param ParabolaConstant [in] ParabolaConstant attribute to set.
  */
  void setParabolaConstant(double ParabolaConstant);

  /** \details
  Returns the value of IsConvex attribute. 
  This attribute represents the orientation of the parabolic arc. 
  Convex (Boolean=”true”) means decreasing gradient along the arc at the beginning such as at the crest of a hill, 
  concave (Boolean=”false”) means increasing gradient along the arc at the beginning such as at the base of a valley.
  \returns
  Returns the value of IsConvex attribute.
  */
  OdDAI::Boolean getIsConvex() const;

  /** \details
  Sets the value of IsConvex attribute. 
  This attribute represents the orientation of the parabolic arc. 
  Convex (Boolean=”true”) means decreasing gradient along the arc at the beginning such as at the crest of a hill, 
  concave (Boolean=”false”) means increasing gradient along the arc at the beginning such as at the base of a valley.
  \param IsConvex [in] IsConvex attribute to set.
  */
  void setIsConvex(OdDAI::Boolean IsConvex);


public:

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

  /** \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
  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: 
  IfcPositiveLengthMeasure m_ParabolaConstant;   // IfcPositiveLengthMeasure
  OdDAI::Boolean m_IsConvex;   // IfcBoolean
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X1_IFCALIGNMENT2DVERSEGPARABOLICARC_AUTO_IMPL_H