/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCWASTETERMINAL_AUTO_IMPL_H
#define _IFC4X1_IFCWASTETERMINAL_AUTO_IMPL_H

#include "IfcFlowTerminalAutoImpl.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
  A waste terminal has the purpose of collecting or intercepting waste from one 
  or more sanitary terminals or other fluid waste generating equipment and discharging it into a single waste/drainage system.
  
  A waste terminal provides for all forms of trap and waste point that collects discharge from a sanitary terminal 
  and discharges it into a waste/drainage subsystem or that collects waste from several terminals and passes it into a single waste/drainage subsystem. 
  This includes the P and S traps from soil sanitary terminals, sinks, and basins as well as floor wastes and gully traps that provide collection points.
  
  - Material Set -
  This concept can be applied to the following resources:
  * Casing - Material from which the casing is constructed.
  * Cover - Material from which the cover or grating is constructed.
  
  - Object Typing -
  This concept can be applied to the following resources:
  * IfcWasteTerminalType
  
  - Port Nesting -
  This concept can be applied with the following combinations:
  <table>
  <b>PortName</b>          <b>Flow</b>        <b>PredefinedType</b>
  Inlet                    SINK               DRAINAGE
  Outlet                   SOURCE             FLOORTRAP
  Inlet                    SINK               FLOORWASTE
  Outlet                   SOURCE             FLOORWASTE
  Inlet                    SINK               GULLYSUMP
  Inlet                    SOURCE             GULLYSUMP
  Inlet                    SINK               GULLYTRAP
  Inlet                    SOURCE             GULLYTRAP
  Outlet                   SOURCE             ROOFDRAIN
  Inlet                    SINK               WASTEDISPOSALUNIT
  Outlet                   SOURCE             WASTEDISPOSALUNIT
  Inlet                    SINK               WASTETRAP
  Outlet                   SOURCE             WASTETRAP
  </table>
  
  - Property Sets for Objects -
  This concept can be applied to the following resources:
  * Pset_WasteTerminalTypeCommon
  * Pset_WasteTerminalTypeFloorTrap (only applies to FLOORTRAP)
  * Pset_WasteTerminalTypeFloorWaste (only applies to FLOORWASTE)
  * Pset_WasteTerminalTypeGullySump (only applies to GULLYSUMP)
  * Pset_WasteTerminalTypeGullyTrap (only applies to GULLYTRAP)
  * Pset_WasteTerminalTypeRoofDrain (only applies to ROOFDRAIN)
  * Pset_WasteTerminalTypeWasteDisposalUnit (only applies to WASTEDISPOSALUNIT)
  * Pset_WasteTerminalTypeWasteTrap (only applies to WASTETRAP)
  
  - Quantity Sets -
  This concept can be applied to the following resources:
  * Qto_WasteTerminalBaseQuantities
*/
class IFC4X1_EXPORT IfcWasteTerminal : public IfcFlowTerminal
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x1::IfcWasteTerminal);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of PredefinedType attribute. 
  This attribute represents 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.
  */
  IfcWasteTerminalTypeEnum getPredefinedType() const;

  /** \details
  Sets the value of PredefinedType attribute. 
  This attribute represents 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.
  */
  void setPredefinedType(IfcWasteTerminalTypeEnum PredefinedType);


public:

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

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

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X1_IFCWASTETERMINAL_AUTO_IMPL_H