///////////////////////////////////////////////////////////////////////////////
// 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 _IFC4X4_IFCFEATUREELEMENTSUBTRACTION_AUTO_IMPL_H
#define _IFC4X4_IFCFEATUREELEMENTSUBTRACTION_AUTO_IMPL_H
#include "IfcFeatureElementAutoImpl.h"
#include "TD_PackPush.h"
/** \details
The namespace contains schema-dependent classes, definitions and sub routines
for work with IFC4X4 express schema definitions.
*/
namespace OdIfc4x4 {
/** \details
The IfcFeatureElementSubtraction is specialization of the general feature element,
that represents an existence dependent elements which modifies the shape and appearance of the associated master element.
The IfcFeatureElementSubtraction offers the ability to handle shape modifiers
as semantic objects within the IFC object model that subtract from the shape of the master element.
The voiding relationship between a master element and a subtraction feature is geometrically resolved by a Boolean difference operation.
The local placement for IfcFeatureElementSubtraction is defined in its supertype IfcProduct.
It is defined by the IfcLocalPlacement, which defines the local coordinate system that is referenced by all geometric representations.
The local placement is always defined in relation to the local placement of the building element from which the feature element substration is substracted:
* The PlacementRelTo attribute of IfcObjectPlacement points (if specified) to the object placement of the IfcElement,
which is used in the VoidsElements.RelatingElement inverse attribute (the parent element of the feature).
\remarks
* This definition cannot be instantiated.
* A single subtraction feature such as the subtype IfcOpeningElement is assigned by a single subtraction relationship IfcRelVoidsElement
to one occurrences of IfcElement. It establishes a 1:1 relationship between the opening and the element.
An element can have several IfcRelVoidsElement relationships, enabling several voids.
*/
class IFC4X4_EXPORT IfcFeatureElementSubtraction : public IfcFeatureElement
{
//DOM-IGNORE-BEGIN
OD_EXP_NON_INSTANTIABLE_DECLARE_MEMBERS(OdIfc4x4::IfcFeatureElementSubtraction);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of VoidsElements attribute.
This attribute represents reference to the Voids Relationship that uses this Opening Element to create a void within an Element.
The Opening Element can only be used to create a single void within a single Element.
\returns
Returns the value of VoidsElements attribute.
*/
OdDAIObjectId getInvVoidsElements() const;
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
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:
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.
*/
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
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:
using IfcElement::getAttr;
using IfcElement::putAttr;
protected:
// Declare friend classes for inverse attributes functionality:
friend class IfcRelVoidsElement;
};
/** \details
A data type that represents a smart pointer to a IfcFeatureElementSubtraction object.
*/
typedef OdSmartPtr IfcFeatureElementSubtractionPtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC4X4_IFCFEATUREELEMENTSUBTRACTION_AUTO_IMPL_H