/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCSURFACEFEATURE_AUTO_IMPL_H
#define _IFC4_IFCSURFACEFEATURE_AUTO_IMPL_H

#include "IfcFeatureElementAutoImpl.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
  A surface feature is a modification at (onto, or into) of the surface of an element. 
  Parts of the surface of the entire surface can be affected. The volume and mass of the element can be increased, 
  remain unchanged, or be decreased by the surface feature, depending on manufacturing technology. 
  However, any increase or decrease of volume is small compared to the total volume of the element.
  
  The part–whole relationship is established by an aggregation relationship object, 
  expressing the decomposition of an element type into one or more additive elements (element parts) and zero or more feature elements.
  
  - Containment Use Definition -
  Surface features have no spatial containment relationship to the spatial structure since they are dependent on element types 
  without spatial containment relationships or on an element occurrence with own spatial containment relationship.
  * The SELF\IfcElement.ContainedInStructure relationship should be NIL.
  
  - Geometry use definition -
  The geometric representation of IfcSurfaceFeatureElement is specified by the IfcProductDefinitionShape, allowing multiple geometric representation.
  
  - Local Placement -
  The local placement for IfcSurfaceFeatureElement is defined in its supertype IfcProduct. 
  It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.
  * In case of features which are part of an element type, absolute placement into the type object's implied coordinate system is used.
  * In case of features which are voiding an element occurrence, the PlacementRelTo relationship of IfcLocalPlacement points to the local placement of the respective element.
  
  - Shape Representation -
  Different shape representations can be used, depending on the nature of the feature and information requirements:
  * Symbolic representation, such as the two-dimensional bounding box of a tag.
  * A geometric set representing the geometric items of a mark.
  * Surface representations of treated parts of the element surface by means of IfcShellBasedSurfaceModel. 
    The faces within the surface model can be included into a B-Rep model within a representation map of the parent element type.
    
  Higher-level parameters (geometric and non-geometric) can be provided by property sets based on local agreements.
  
  - Product Local Placement -
  The local placement for IfcSurfaceFeatureElement is defined in its supertype IfcProduct. 
  It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.
  * In case of features which are part of an element type, absolute placement into the type object's implied coordinate system is used.
  * In case of features which are voiding an element occurrence, the PlacementRelTo relationship of IfcLocalPlacement points to the local placement of the respective element.
  
  - Property Sets for Objects -
  This concept can be applied to the following resources:
  * Pset_RoadMarkingCommon (only applies to HATCHMARKING)
  * Pset_RoadMarkingCommon (only applies to LINEMARKING)
  * Pset_RoadMarkingCommon (only applies to PAVEMENTSURFACEMARKING)
  * Pset_RoadMarkingCommon (only applies to SYMBOLMARKING)
  * Pset_MarkingLinesCommon (only applies to LINEMARKING)
  * Pset_RoadSymbolsCommon (only applies to SYMBOLMARKING)
  
  - Quantity Sets -
  This concept can be applied to the following resources:
  * Qto_SurfaceFeatureBaseQuantities
*/
class IFC4_EXPORT IfcSurfaceFeature : public IfcFeatureElement
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4::IfcSurfaceFeature);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of PredefinedType attribute. 
  This attribute represents indicates the kind of surface feature.
  \returns
  Returns the value of PredefinedType attribute.
  */
  IfcSurfaceFeatureTypeEnum getPredefinedType() const;

  /** \details
  Sets the value of PredefinedType attribute. 
  This attribute represents indicates the kind of surface feature.
  \param PredefinedType [in] Predefined type to set.
  */
  void setPredefinedType(IfcSurfaceFeatureTypeEnum PredefinedType);


public:

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

  /** \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;   // IfcSurfaceFeatureTypeEnum  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4_IFCSURFACEFEATURE_AUTO_IMPL_H