///////////////////////////////////////////////////////////////////////////////
// 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_IFCOBJECTPLACEMENT_AUTO_IMPL_H
#define _IFC2X_FINAL_IFCOBJECTPLACEMENT_AUTO_IMPL_H
#include "Ifc2x_FinalBaseClass.h"
#include "Ifc2x_FinalEnum.h"
#include "Ifc2x_FinalSelectTypes.h"
#include "Ifc2x_FinalCollectionTypes.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
IfcObjectPlacement is an abstract supertype for the special types defining the object coordinate system.
The IfcObjectPlacement has to be provided for each product that has a shape representation.
The object placement can be specified:
* Absolute: by an axis2 placement, relative to the world coordinate system
* Relative: by an axis2 placement, relative to the object placement of another product
* By grid reference: by the virtual intersection and reference direction specified by two axes of a design grid
* Linear placement: by distance along a curve, with possible offsets
Object placement has to unambiguously define the object coordinate system as either two-dimensional axis placement (IfcAxis2Placement2D)
or three-dimensional axis placement (IfcAxis2Placement3D).
\remarks
This definition may not be instantiated
*/
class IFC2X_FINAL_EXPORT IfcObjectPlacement : public OdIfc2x_FinalInstance
{
//DOM-IGNORE-BEGIN
OD_EXP_NON_INSTANTIABLE_DECLARE_MEMBERS(OdIfc2x_final::IfcObjectPlacement);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of ReferencedByPlacements attribute.
This attribute represents placements that are specified relative to this placement of an object.
\param ReferencedByPlacements [out] Receives the value of ReferencedByPlacements attribute.
*/
void getInvReferencedByPlacements(OdDAIObjectIds& ReferencedByPlacements) 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
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 OdDAI::ApplicationInstance::getAttr;
using OdDAI::ApplicationInstance::putAttr;
protected:
// Declare friend classes for inverse attributes functionality:
friend class IfcLocalPlacement;
};
/** \details
A data type that represents a smart pointer to a IfcObjectPlacement object.
*/
typedef OdSmartPtr IfcObjectPlacementPtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC2X_FINAL_IFCOBJECTPLACEMENT_AUTO_IMPL_H