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

#include "IfcCoordinateOperationAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  The map conversion deals with transforming the local engineering coordinate system, often called world coordinate system, 
  into the coordinate reference system of the underlying map.
  
  The map conversion allows to convert the local origin of the local engineering coordinate system to its place within a map 
  (easting, northing, orthogonal height) and to rotate the x-axis of the local engineering coordinate system within the horizontal (easting/westing) plane of the map.
  
  The scale factor can be used when the length unit for the 3 axes of the map coordinate system 
  are not identical with the length unit established for this project (see IfcProject.UnitsInContext). If omitted, the scale factor 1.0 is assumed.

  \changes
  
  * IFC4 changes: 
    The assignment of curve, surface and other styles to an IfcStyledItem has been simplified by IfcStyleAssignmentSelect. 
    The use of intermediate IfcPresentationStyleAssignment is deprecated.
*/
class IFC4_EXPORT IfcMapConversion : public IfcCoordinateOperation
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4::IfcMapConversion);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of Eastings attribute. 
  This attribute represents the location along the easting of the coordinate system of the target map coordinate reference system.
  \returns
  Returns the value of Eastings attribute.
  \remarks
  For right-handed Cartesian coordinate systems this would establish the location along the x axis.
  */
  double getEastings() const;

  /** \details
  Sets the value of Eastings attribute. 
  This attribute represents the location along the easting of the coordinate system of the target map coordinate reference system.
  \param Eastings [in] Eastings attribute to set.
  \remarks
  For right-handed Cartesian coordinate systems this would establish the location along the x axis.
  */
  void setEastings(double Eastings);

  /** \details
  Returns the value of Northings attribute. 
  This attribute represents the location along the northing of the coordinate system of the target map coordinate reference system.
  \returns
  Returns the value of Northings attribute.
  \remarks
  For right-handed Cartesian coordinate systems this would establish the location along the y axis.
  */
  double getNorthings() const;

  /** \details
  Sets the value of Northings attribute. 
  This attribute represents the location along the northing of the coordinate system of the target map coordinate reference system.
  \param Northings [in] Northings attribute to set.
  \remarks
  For right-handed Cartesian coordinate systems this would establish the location along the y axis.
  */
  void setNorthings(double Northings);

  /** \details
  Returns the value of OrthogonalHeight attribute. 
  This attribute represents orthogonal height relative to the vertical datum specified.
  \returns
  Returns the value of OrthogonalHeight attribute.
  \remarks
  For right-handed Cartesian coordinate systems this would establish the location along the z axis.
  */
  double getOrthogonalHeight() const;

  /** \details
  Sets the value of OrthogonalHeight attribute. 
  This attribute represents orthogonal height relative to the vertical datum specified.
  \param OrthogonalHeight [in] Orthogonal height to set.
  \remarks
  For right-handed Cartesian coordinate systems this would establish the location along the z axis.
  */
  void setOrthogonalHeight(double OrthogonalHeight);

  /** \details
  Returns the value of XAxisAbscissa attribute. 
  This attribute represents the value along the easing axis of the end point 
  of a vector indicating the position of the local x axis of the engineering coordinate reference system.
  \returns
  Returns the value of XAxisAbscissa attribute.
  \remarks
  For right-handed Cartesian coordinate systems this would establish the location along the x axis.
  Together with the XAxisOrdinate it provides the direction of the local x axis within the horizontal plane of the map coordinate system.
  */
  double getXAxisAbscissa() const;

  /** \details
  Sets the value of XAxisAbscissa attribute. 
  This attribute represents the value along the easing axis of the end point 
  of a vector indicating the position of the local x axis of the engineering coordinate reference system.
  \param XAxisAbscissa [in] X axis abscissa to set.
  \remarks
  For right-handed Cartesian coordinate systems this would establish the location along the x axis.
  Together with the XAxisOrdinate it provides the direction of the local x axis within the horizontal plane of the map coordinate system.
  */
  void setXAxisAbscissa(double XAxisAbscissa);

  /** \details
  Returns the value of XAxisOrdinate attribute. 
  This attribute represents the value along the northing axis of the end point 
  of a vector indicating the position of the local x axis of the engineering coordinate reference system.
  \returns
  Returns the value of XAxisOrdinate attribute.
  \remarks
  For right-handed Cartesian coordinate systems this would establish the location along the y axis.
  */
  double getXAxisOrdinate() const;

  /** \details
  Sets the value of XAxisOrdinate attribute. 
  This attribute represents the value along the northing axis of the end point 
  of a vector indicating the position of the local x axis of the engineering coordinate reference system.
  \param XAxisOrdinate [in] X axis ordinate to set.
  \remarks
  For right-handed Cartesian coordinate systems this would establish the location along the y axis.
  */
  void setXAxisOrdinate(double XAxisOrdinate);

  /** \details
  Returns the value of Scale attribute. 
  This attribute represents scale that is used, when the units of the CRS are not identical to the units of the engineering coordinate system. 
  If omitted, the value of 1.0 is assumed.
  \returns
  Returns the value of Scale attribute.
  */
  double getScale() const;

  /** \details
  Sets the value of Scale attribute. 
  This attribute represents scale that is used, when the units of the CRS are not identical to the units of the engineering coordinate system.
  If omitted, the value of 1.0 is assumed.
  \param Scale [in] Scale to set.
  */
  void setScale(double Scale);


public:

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

  /** \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_Eastings;   // IfcLengthMeasure
  double m_Northings;   // IfcLengthMeasure
  double m_OrthogonalHeight;   // IfcLengthMeasure
  double m_XAxisAbscissa;   // IfcReal  [optional]
  double m_XAxisOrdinate;   // IfcReal  [optional]
  double m_Scale;   // IfcReal  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4_IFCMAPCONVERSION_AUTO_IMPL_H