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

#include "IfcProductAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  An annotation is an information element within the geometric (and spatial) context of a project, 
  that adds a note or meaning to the objects which constitutes the project model. 
  Annotations include additional points, curves, text, dimensioning, hatching and other forms of graphical notes. 
  It also includes virtual or symbolic representations of additional model components, not representing products or spatial structures, 
  such as event elements, survey points, contour lines or similar.
  
  If available, the annotation should be related to the spatial context of the project, by containing the annotation within the appropriate level of the building structure 
  (site, facility, facility part or building, storey, or space). This is handled by the IfcRelContainedInSpatialStructure relationship.
  
  * 'Annotation point' is an annotation provided by a point that has additional semantic. 
    The inherited attribute ObjectType should be used to capture the type of point annotation, some suggested values are:
      * 'SurveyPoint': A single survey point represented by a Cartesian point. A property set can add the conditions (method, accuracy, etc. to the survey point).
      * 'SurveyArea': A set of survey points represented by Cartesian point. 
        These coordinates are determined relative to the coordinates of a reference point, which acts as the datum for the survey. 
        Properties attached apply equally to all points. The difference in elevation of the survey points enables terrain to be determined.
  * 'Annotation curve' is an annotation provided by a curve that has additional semantic. 
    The inherited attribute ObjectType should be used to capture the type of curve annotation, some suggested values are:
      * 'ContourLine': A line of constant elevation typically used on geographic maps where the spacing of lines at constant intervals of elevation can be used as an indication of slope.
      * 'IsoBar': A line of constant pressure typically used on weather maps or to show pressure gradient in spaces, chambers or externally.
      * 'IsoLux': A line of constant illumination typically used to show the distribution of illumination levels and/or day lighting in a space or externally.
      * 'IsoTherm': A line of constant temperature typically used to show the distribution and effect of heating or cooling within a space or to show temperature distribution on a geographic map.
  * 'Annotation surface': is an annotation provided by a surface that has additional semantic. 
    The inherited attribute ObjectType should be used to capture the type of surface annotation, some suggested values are:
      * 'SurveyArea': A surface patch based on survey points.
*/
class IFC4X3_EXPORT IfcAnnotation : public IfcProduct
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x3_add2::IfcAnnotation);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of PredefinedType attribute. 
  This attribute represents the a list of types to further identify the object. 
  Some property sets can be specifically applicable to one of these types.
  \returns
  Returns the value of PredefinedType attribute.
  \remarks
  If the object has an associated IfcTypeObject with a PredefinedType, then this attribute is not be used.
  */
  IfcAnnotationTypeEnum getPredefinedType() const;

  /** \details
  Sets the value of PredefinedType attribute. 
  This attribute represents the a list of types to further identify the object. 
  Some property sets can be specifically applicable to one of these types.
  \param PredefinedType [in] Predefined type to set.
  \remarks
  If the object has an associated IfcTypeObject with a PredefinedType, then this attribute is not be used.
  */
  void setPredefinedType(IfcAnnotationTypeEnum PredefinedType);

  /** \details
  Returns the value of ContainedInStructure attribute. 
  This attribute represents relationship to a spatial structure element with which the associate is primarily associated.
  \param ContainedInStructure [out] Receives the value of ContainedInStructure attribute.
  */
  void getInvContainedInStructure(OdDAIObjectIds& ContainedInStructure) const;


public:

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

  /** \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: 
  OdDAI::Enum m_PredefinedType;   // IfcAnnotationTypeEnum  [optional]

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

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X3_ADD2_IFCANNOTATION_AUTO_IMPL_H