/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCCOORDINATEREFERENCESYSTEM_AUTO_IMPL_H
#define _IFC4X1_IFCCOORDINATEREFERENCESYSTEM_AUTO_IMPL_H

#include "Ifc4x1BaseClass.h"

#include "Ifc4x1Enum.h"
#include "Ifc4x1SelectTypes.h"
#include "Ifc4x1CollectionTypes.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 IfcCoordinateReferenceSystem is a definition of a coordinate reference system by means of qualified identifiers only. 
  The interpretation of the identifier is expected to be well-known to the receiving software.
  
  The unambiguous identifier by which the coordinate reference system is known, is stored in the Name attribute. 
  Well defined identifiers include the geodetic and also often the vertical datum. 
  In these cases the GeodeticDatum and the VerticalDatum attributed can be omitted.

  \remarks
  This definition may not be instantiated.
*/
class IFC4X1_EXPORT IfcCoordinateReferenceSystem : public OdIfc4x1Instance
{
  //DOM-IGNORE-BEGIN
  OD_EXP_NON_INSTANTIABLE_DECLARE_MEMBERS(OdIfc4x1::IfcCoordinateReferenceSystem);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of Name attribute. 
  This attribute represents name by which the coordinate reference system is identified.
  \returns
  Returns the value of Name attribute.
  */
  const OdAnsiString& getName() const;

  /** \details
  Sets the value of Name attribute. 
  This attribute represents name by which the coordinate reference system is identified.
  \param Name [in] Name to set.
  */
  void setName(const OdAnsiString& Name);

  /** \details
  Returns the value of Description attribute. 
  This attribute represents informal description of this coordinate reference system.
  \returns
  Returns the value of Description attribute.
  */
  const OdAnsiString& getDescription() const;

  /** \details
  Sets the value of Description attribute. 
  This attribute represents informal description of this coordinate reference system.
  \param Description [in] Description to set.
  */
  void setDescription(const OdAnsiString& Description);

  /** \details
  Returns the value of GeodeticDatum attribute. 
  This attribute represents name by which this datum is identified. 
  The geodetic datum is associated with the coordinate reference system 
  and indicates the shape and size of the rotation ellipsoid and this ellipsoid's connection and orientation to the actual globe/earth. 
  This attribute is required if the Name identifier does not unambiguously define the geodetic datum.
  \returns
  Returns the value of GeodeticDatum attribute.
  \remarks
  EXAMPLE: geodetic datums include:
  * ED50
  * EUREF89
  * WSG84
  */
  const OdAnsiString& getGeodeticDatum() const;

  /** \details
  Sets the value of GeodeticDatum attribute. 
  This attribute represents name by which this datum is identified. 
  The geodetic datum is associated with the coordinate reference system 
  and indicates the shape and size of the rotation ellipsoid and this ellipsoid's connection and orientation to the actual globe/earth. 
  This attribute is required if the Name identifier does not unambiguously define the geodetic datum.
  \param GeodeticDatum [in] Geodetic datum to set.
  \remarks
  EXAMPLE: geodetic datums include:
  * ED50
  * EUREF89
  * WSG84
  */
  void setGeodeticDatum(const OdAnsiString& GeodeticDatum);

  /** \details
  Returns the value of VerticalDatum attribute. 
  This attribute represents name by which the vertical datum is identified. 
  The vertical datum is associated with the height axis of the coordinate reference system 
  and indicates the reference plane and fundamental point defining the origin of a height system. 
  This attribute is required if the Name identifier does not unambiguously define the vertical datum 
  and if the coordinate reference system is a 3D reference system.
  \returns
  Returns the value of VerticalDatum attribute.
  \remarks
  EXAMPLE: vertical datums include:
  * DHHN92: the German 'Haupthöhennetz'
  * EVRS2007; the European Vertical Reference System
  */
  const OdAnsiString& getVerticalDatum() const;

  /** \details
  Sets the value of VerticalDatum attribute. 
  This attribute represents name by which the vertical datum is identified. 
  The vertical datum is associated with the height axis of the coordinate reference system 
  and indicates the reference plane and fundamental point defining the origin of a height system. 
  This attribute is required if the Name identifier does not unambiguously define the vertical datum 
  and if the coordinate reference system is a 3D reference system.
  \param VerticalDatum [in] Vertical datum to set.
  \remarks
  EXAMPLE: vertical datums include:
  * DHHN92: the German 'Haupthöhennetz'
  * EVRS2007; the European Vertical Reference System
  */
  void setVerticalDatum(const OdAnsiString& VerticalDatum);

  /** \details
  Returns the value of HasCoordinateOperation attribute. 
  This attribute represents an instance that is used for conversion between coordinate systems. 
  It refers to a coordinate operation (IfcCoordinateOperation instance) between this coordinate reference system, and another geographic coordinate reference system.
  \param HasCoordinateOperation [out] Receives the value of HasCoordinateOperation attribute.
  */
  void getInvHasCoordinateOperation(OdDAIObjectIds& HasCoordinateOperation) const;


public:

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

  /** \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: 
  OdAnsiString m_Name;   // IfcLabel
  OdAnsiString m_Description;   // IfcText  [optional]
  OdAnsiString m_GeodeticDatum;   // IfcIdentifier  [optional]
  OdAnsiString m_VerticalDatum;   // IfcIdentifier  [optional]

  // Declare friend classes for inverse attributes functionality: 
  friend class IfcCoordinateOperation;
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X1_IFCCOORDINATEREFERENCESYSTEM_AUTO_IMPL_H