/////////////////////////////////////////////////////////////////////////////// 
// 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_RC1_IFCBUILDINGELEMENTPROXY_AUTO_IMPL_H
#define _IFC4X3_RC1_IFCBUILDINGELEMENTPROXY_AUTO_IMPL_H

#include "IfcBuiltElementAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  The IfcBuildingElementProxy is a proxy definition that provides the same functionality as subtypes of IfcBuildingElement, 
  but without having a predefined meaning of the special type of building element, it represents.
  Proxies can also be used as spatial place holders or provisions, that are later replaced by special types of elements.
  
  One use of the proxy object is a provision for voids, i.e. where a particular volume of space 
  is requested by an engineering function that might later be accepted or rejected. 
  If accepted it is transformed into a void within a building element, like a wall opening, or a slab opening. 
  The provision for voids is exchanged as an IfcBuildingElementProxy with the PredefinedType = ProvisionForVoid. 
  Such proxy has a swept solid geometry, where the profile of the swept solid lies on/near the surface 
  of the referred building element and the extrusion depths is equal to or bigger then 
  (in case of round or otherwise irregular element shape) the thickness of the building element. 
  The appropriate property set should be attached.
  
  In addition to the provision for voids, the building element proxy can also represent a provision for space, 
  often the necessary space allocation for mechanical equipment that will be determined in a later design phase. 
  The provision for space is exchanged as an IfcBuildingElementProxy with the PredefinedType = ProvisionForSpace.
  
  Other usages of IfcBuildingElementProxy include:
  * The IfcBuildingElementProxy can be used to exchange special types of building elements for which the current specification does not yet provide a semantic definition
  * The IfcBuildingElementProxy can also be used to represent building elements for which the participating applications can not provide a semantic definition
  
  - Object Typing -
  The IfcBuildingElementProxyType can be used to share common information among many 
  occurrences of the same proxy without establishing a particular semantic meaning of the type.
  If no IfcBuildingElementProxyType is attached (i.e. if only occurrence information is available) the PredefinedType should be provided. 
  If set to .USERDEFINED. a user defined value has to be provided by the ObjectType attribute.
  This concept can be applied to the following resources:
  * IfcBuildingElementProxyType
  
  - Property Sets for Objects -
  This concept can be applied to the following resources:
  * Pset_ConcreteElementGeneral
  * Pset_PrecastConcreteElementFabrication
  * Pset_PrecastConcreteElementGeneral
  * Pset_BuildingElementProxyCommon
  * Pset_ProvisionForVoid (only applies to PROVISIONFORVOID)
  
  - Quantity Sets -
  This concept can be applied to the following resources:
  * Qto_BuildingElementProxyQuantities
  
  - Spatial Containment -
  The IfcBuildingElementProxy, as any subtype of IfcBuildingElement, can participate alternatively in one of the two different containment relationships:
  * the Spatial Containment (defined here)
  * the Element Composition

  \changes
  
  * IFC4 changes: 
    * Name of the CompositionType attribute changed to PredefinedType
    * Type of the CompositionType attribute changed from "IfcElementCompositionEnum" to "IfcBuildingElementProxyTypeEnum"
*/
class IFC4X3_RC1_EXPORT IfcBuildingElementProxy : public IfcBuiltElement
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x3_rc1::IfcBuildingElementProxy);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of PredefinedType attribute. 
  This attribute represents predefined generic type for a building element proxy that is specified in an enumeration. 
  There can be a property set specified specifically for the predefined types.
  \returns
  Returns the value of PredefinedType attribute.
  \remarks
  * The PredefinedType is only used if no IfcBuildingElementProxyType is assigned, providing its own IfcBuildingElementProxyType.PredefinedType
  * IFC4 CHANGE: The attribute CompositionType has been replaced by PredefinedType, being a superset of the enumerators
  */
  IfcBuildingElementProxyTypeEnum getPredefinedType() const;

  /** \details
  Sets the value of PredefinedType attribute. 
  This attribute represents predefined generic type for a building element proxy that is specified in an enumeration. 
  There can be a property set specified specifically for the predefined types.
  \param PredefinedType [in] Predefined type to set.
  \remarks
  * The PredefinedType is only used if no IfcBuildingElementProxyType is assigned, providing its own IfcBuildingElementProxyType.PredefinedType
  * IFC4 CHANGE: The attribute CompositionType has been replaced by PredefinedType, being a superset of the enumerators
  */
  void setPredefinedType(IfcBuildingElementProxyTypeEnum PredefinedType);


public:

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

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

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X3_RC1_IFCBUILDINGELEMENTPROXY_AUTO_IMPL_H