/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCDISTRIBUTIONSYSTEM_AUTO_IMPL_H
#define _IFC4_IFCDISTRIBUTIONSYSTEM_AUTO_IMPL_H

#include "IfcSystemAutoImpl.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 distribution system is a network designed to receive, store, maintain, distribute, or control the flow of a distribution media. 
  A common example is a heating hot water system that consists of a pump, a tank, and an interconnected piping system for distributing hot water to terminals.
  
  The group IfcDistributionSystem defines the occurrence of a specialized system for use within the context of building services or utilities for built facilities.
  Important functionalities for the description of a distribution system are derived from existing IFC entities:
  * From IfcSystem it inherits the ability to couple the built system via 
    IfcRelReferencedInSpatialStructure to one or more IfcSpatialElement subtypes as necessary.
  * From IfcGroup it inherits the inverse attribute IsGroupedBy, pointing to the relationship class IfcRelAssignsToGroup. 
    This allows the grouping of distribution elements (instances of IfcDistributionElement subtypes).
  * From IfcObjectDefinition it inherits the inverse attribute IsDecomposedBy pointing to the relationship class IfcRelAggregates. 
    It provides the hierarchy between the separate (partial) distribution systems. For example, an electrical main circuit can be aggregated into branch circuits.
    
  - Property Sets for Objects -
  The Property Sets for Objects concept template applies to this entity under <em>Pset_DistributionSystemCommon</em> name as shown in table below:
  <table>
  <b>Template</b>                   <b>PropertyName</b>                   <b>Value</b>
  Single value                      AssetAccountingType                   IfcBoolean
  </table>
  
  - Group Assignment -
  The Group Assignment concept template applies to this entity as shown in table below.
  <table>
  <b>IsGrouped</b>                   <b>RelatedObjects</b>                <b>Description</b>
                                                                          Physical elements that comprise the asset.
  </table>                                                                   
  For the most common case of an IfcDistributionElement subtype containing ports of a particular PredefinedType 
  that all belong to the same distribution system, the IfcDistributionElement is assigned to the IfcDistributionSystem 
  via the IfcRelAssignsToGroup relationship, where IfcDistributionPort's are implied as part of the corresponding system based on their PredefinedType. 
  An IfcDistributionElement can belong to multiple systems, however only one IfcDistributionSystem of a particular PredefinedType.
  
  * EXAMPLE: A gas-powered hot water heater can have three ports: GAS, DOMESTICCOLDWATER, and DOMESTICHOTWATER. 
    The heater is a member of two systems (GAS and DOMESTICCOLDWATER), and hosts one system (DOMESTICHOTWATER) at the corresponding port.
    
  The next image illustrates a distribution system for an electrical circuit.
  
  <IMAGE ifcdistributionsystem-01>

  \changes
  
  * IFC4 changes: 
    For electrical power systems, IfcElectricalCircuit has been used for low-voltage (12-1000 V) power circuits and has been replaced by IfcDistributionCircuit in IFC4; 
  IfcDistributionSystem with PredefinedType 'ELECTRICAL' should be used for overall power systems, 
  and IfcDistributionCircuit with PredefinedType 'ELECTRICAL' should be used for each switched circuit.
*/
class IFC4_EXPORT IfcDistributionSystem : public IfcSystem
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4::IfcDistributionSystem);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of LongName attribute. 
  This attribute represents long name for a distribution system, used for informal purposes. 
  It should be used, if available, in conjunction with the inherited Name attribute.
  \returns
  Returns the value of LongName attribute.
  \remarks
  In many scenarios the Name attribute refers to the short name 
  or number of a distribution system or branch circuit, and the LongName refers to a descriptive name.
  */
  const OdAnsiString& getLongName() const;

  /** \details
  Sets the value of LongName attribute. 
  This attribute represents long name for a distribution system, used for informal purposes. 
  It should be used, if available, in conjunction with the inherited Name attribute.
  \param LongName [in] Long name to set.
  \remarks
  In many scenarios the Name attribute refers to the short name 
  or number of a distribution system or branch circuit, and the LongName refers to a descriptive name.
  */
  void setLongName(const OdAnsiString& LongName);

  /** \details
  Returns the value of PredefinedType attribute. 
  This attribute represents predefined types of distribution systems.
  \returns
  Returns the value of PredefinedType attribute.
  */
  IfcDistributionSystemEnum getPredefinedType() const;

  /** \details
  Sets the value of PredefinedType attribute. 
  This attribute represents predefined types of distribution systems.
  \param PredefinedType [in] Predefined type to set.
  */
  void setPredefinedType(IfcDistributionSystemEnum PredefinedType);


public:

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

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

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4_IFCDISTRIBUTIONSYSTEM_AUTO_IMPL_H