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

#include "IfcProductAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  IfcProxy is intended to be a kind of a container for wrapping objects which are defined by associated properties, 
  which may or may not have a geometric representation and placement in space. 
  A proxy can have a semantic meaning, defined by the Name attribute, and property definitions, 
  attached through the property assignment relationship, which definition can be outside of the definitions given by the current release of IFC.
  
  The ProxyType can give an indication to which high level semantic breakdown of object the semantic definition of the proxy relates to. 
  The Tag attribute can be used to assign a human or system interpretable identifier (such as a serial number or bar code).
  * Given that only a limited number of semantic constructs can be formally defined within IFC 
    there has to be a mechanism for capturing those constructs that are not yet defined by IFC.
  * Product proxies are a mechanism that allows to exchange data that is part of the project but not necessarily part of the IFC model. 
    Those proxies can have geometric representations assigned.
*/
class IFC2X3_EXPORT IfcProxy : public IfcProduct
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x3::IfcProxy);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of ProxyType attribute. 
  This attribute represents high level (and only) semantic meaning attached to the IfcProxy, 
  defining the basic construct type behind the Proxy, e.g. Product or Process.
  \returns
  Returns the value of ProxyType attribute.
  */
  IfcObjectTypeEnum getProxyType() const;

  /** \details
  Sets the value of ProxyType attribute. 
  This attribute represents high level (and only) semantic meaning attached to the IfcProxy, 
  defining the basic construct type behind the Proxy, e.g. Product or Process.
  \param ProxyType [in] Proxy type to set.
  */
  void setProxyType(IfcObjectTypeEnum ProxyType);

  /** \details
  Returns the value of Tag attribute. 
  This attribute represents the tag (or label) identifier at the particular instance of a product, 
  e.g. the serial number, or the position number. It is the identifier at the occurrence level.
  \returns
  Returns the value of Tag attribute.
  */
  const OdAnsiString& getTag() const;

  /** \details
  Sets the value of Tag attribute. 
  This attribute represents the tag (or label) identifier at the particular instance of a product, 
  e.g. the serial number, or the position number. It is the identifier at the occurrence level.
  \param Tag [in] Tag to set.
  */
  void setTag(const OdAnsiString& Tag);


public:

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

  /** \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_ProxyType;   // IfcObjectTypeEnum
  OdAnsiString m_Tag;   // IfcLabel  [optional]
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X3_IFCPROXY_AUTO_IMPL_H