///////////////////////////////////////////////////////////////////////////////
// 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 _IFC2X_FINAL_IFCRELCOVERSBLDGELEMENTS_AUTO_IMPL_H
#define _IFC2X_FINAL_IFCRELCOVERSBLDGELEMENTS_AUTO_IMPL_H
#include "IfcRelConnectsAutoImpl.h"
#include "IfcBuildingElementAutoImpl.h"
#include "TD_PackPush.h"
/** \details
The namespace contains schema-dependent classes, definitions and sub routines
for work with IFC2X_FINAL express schema definitions.
*/
namespace OdIfc2x_final {
/** \details
The IfcRelCoversBldgElements relationship is an objectified relationship
between an element and one to many coverings, which cover that element.
The IFC specification provides two relationships:
* IfcRelCoversBldgElements to assign coverings to elements (deprecated, use IfcRelAggregates instead).
* IfcRelCoversSpaces to assign coverings to spaces (deprecated, use IfcRelContainedInSpatialStructure instead).
Whether the relationship between the covering and the space, or between the covering and the element,
is regarded as primary, has to be determined within the context of a model view definition.
\remarks
The relationship IfcRelCoversBldgElements is deprecated, use IfcRelAggregates instead.
*/
class IFC2X_FINAL_EXPORT IfcRelCoversBldgElements : public IfcRelConnects
{
//DOM-IGNORE-BEGIN
OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcRelCoversBldgElements);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of RelatingBuildingElement attribute.
This attribute represents relationship to the element that is covered.
It includes building elements for coverings such as flooring or cladding,
or distribution elements for coverings such as sleeving or wrapping.
\returns
Returns the value of RelatingBuildingElement attribute.
*/
const OdDAIObjectId& getRelatingBuildingElement() const;
/** \details
Sets the value of RelatingBuildingElement attribute.
This attribute represents relationship to the element that is covered.
It includes building elements for coverings such as flooring or cladding,
or distribution elements for coverings such as sleeving or wrapping.
\param RelatingBuildingElement [in] Relating building element to set.
*/
void setRelatingBuildingElement(const OdDAIObjectId& RelatingBuildingElement);
/** \details
Returns the value of RelatedCoverings attribute.
This attribute represents relationship to the set of coverings that are assigned to this element.
\param RelatedCoverings [out] Receives the related coverings.
*/
void getRelatedCoverings(OdDAIObjectIds& RelatedCoverings) const;
/** \details
Returns the value of RelatedCoverings attribute.
This attribute represents relationship to the set of coverings that are assigned to this element.
\returns
Returns the value of RelatedCoverings attribute.
*/
OdDAI::ListOfOdDAIObjectId& relatedCoverings();
public:
/** \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 OdDAI::Entity 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 OdIfc::OdIfcEntityType 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:
OdDAIObjectId m_RelatingBuildingElement; // IfcBuildingElement
OdDAI::ListOfOdDAIObjectId m_RelatedCoverings; // LIST [1:?] of IfcCovering
};
/** \details
A data type that represents a smart pointer to a IfcRelCoversBldgElements object.
*/
typedef OdSmartPtr IfcRelCoversBldgElementsPtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC2X_FINAL_IFCRELCOVERSBLDGELEMENTS_AUTO_IMPL_H