/////////////////////////////////////////////////////////////////////////////// 
// 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_IFCTRANSPORTELEMENT_AUTO_IMPL_H
#define _IFC4X1_IFCTRANSPORTELEMENT_AUTO_IMPL_H

#include "IfcElementAutoImpl.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 transport element is a generalization of all transport related objects that move people, animals or goods within a Facility. 
  The IfcTransportElement defines the occurrence of a transport element, that is expressed by the IfcTransportElementType.
  
  Transport element can describe fixed or non fixed elements, which can either be identified as specified operational assets 
  within a facility or vehicles that interact with the facility as a user or customer. In the case of operational assets, 
  instances of IfcTransportElement can represent individual identifiable vehicles or structures with properties such as serial numbers, 
  registration numbers etc. and be typed accordingly by instances of IfcTransportElementType.
  
  In the case transport elements that interact as users or customers, such as cars on a road or vessels at a port, 
  IfcTransportElementType is used to define element specifications which are used to design, analyze and provide operational constraints to the facility.
  
  Depending on local classification systems transport elements and transportation systems in buildings are either considered as part of a built system, 
  or as part of a built service system. Within IFC they are considered as part of a built system and can have to be mapped appropriately.
  
  - Object Typing -
  IfcTransportElement defines the occurrence of any transportation device, common information about transportation device types (or styles) is handled by IfcTransportElementType. 
  The IfcTransportElementType can establish the common type name, usage (or predefined) type, common material layer set, 
  common set of properties and common shape representations (using IfcRepresentationMap). 
  The IfcTransportElementType is attached using the IfcRelDefinedByType.RelatingType objectified relationship and is accessible by the inverse IsTypedBy attribute.
  
  If no IfcTransportElementType is attached (i.e. if only occurrence information is given) the PredefinedType should be provided. 
  If set to .USERDEFINED a user-defined value can be provided by the ObjectType attribute.
  
  - Property Sets for Objects -
  The Property Sets for Objects concept template applies to this entity under <em>Pset_TransportElementCommon</em> name as shown in table below:
  <table>
  <b>Template</b>                   <b>PropertyName</b>                   <b>Value</b>
  Single Value                      Reference                             IfcIdentifier
  Single Value                      CapacityPeople                        IfcCountMeasure
  Single Value                      CapacityWeight                        IfcMassMeasure
  Single Value                      FireExit                              IfcBoolean
  Enumerated Value                  Status                                IfcLabel
  </table>
  
  - Spatial Containment -
  The IfcTransportElement is placed within the project spatial hierarchy using the objectified relationship IfcRelContainedInSpatialStructure, 
  referring to it by its inverse attribute SELF\IfcElement.ContainedInStructure. 
  Subtypes of IfcSpatialStructureElement are valid spatial containers, with IfcBuilding being the default container.

  \changes
  
  * IFC2X_FINAL changes: 
    * The attribute PredefinedType (previously OperationType) is made optional.
  * IFC4 changes: 
    * The last attributes CapacityByWeight and CapacityByNumber are removed, use Pset_TransportElementCommon instead.
    * Name of the OperationType attribute changed to PredefinedType.
*/
class IFC4X1_EXPORT IfcTransportElement : public IfcElement
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x1::IfcTransportElement);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of PredefinedType attribute. 
  This attribute represents a list of 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.
  \remarks
  If the object has an associated IfcTypeObject with a PredefinedType, then this attribute is not used.
  */
  IfcTransportElementTypeEnum getPredefinedType() const;

  /** \details
  Sets the value of PredefinedType attribute. 
  This attribute represents a list of 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.
  \remarks
  If the object has an associated IfcTypeObject with a PredefinedType, then this attribute is not used.
  */
  void setPredefinedType(IfcTransportElementTypeEnum PredefinedType);


public:

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

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

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X1_IFCTRANSPORTELEMENT_AUTO_IMPL_H