///////////////////////////////////////////////////////////////////////////////
// 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 _IFC4X2_IFCREPRESENTATIONMAP_AUTO_IMPL_H
#define _IFC4X2_IFCREPRESENTATIONMAP_AUTO_IMPL_H
#include "Ifc4x2BaseClass.h"
#include "Ifc4x2Enum.h"
#include "Ifc4x2SelectTypes.h"
#include "Ifc4x2CollectionTypes.h"
#include "IfcRepresentationAutoImpl.h"
#include "TD_PackPush.h"
/** \details
The namespace contains schema-dependent classes, definitions and sub routines
for work with IFC4X2 express schema definitions.
*/
namespace OdIfc4x2 {
/** \details
An IfcRepresentationMap presents the base definition (also referred to as block, cell or macro) called MappedRepresentation within the MappingOrigin.
The MappingOrigin defines the coordinate system in which the MappedRepresentation is defined.
The RepresentationMap is used through an IfcMappeditem in one or several IfcShapeRepresentation's.
Cartesian transformation operator can be applied to transform the MappedRepresentation into the placement coordinate system of the shape representation.
The transformation of the representation map is restricted to be a Cartesian transformation mapping (translation, rotation, mirroring and scaling).
*/
class IFC4X2_EXPORT IfcRepresentationMap : public OdIfc4x2Instance
{
//DOM-IGNORE-BEGIN
OD_EXP_DECLARE_MEMBERS(OdIfc4x2::IfcRepresentationMap);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of MappingOrigin attribute.
This attribute represents an axis2 placement that defines the position about which the mapped representation is mapped.
\returns
Returns the value of MappingOrigin attribute.
*/
IfcAxis2Placement mappingOrigin();
/** \details
Returns the value of MappedRepresentation attribute.
This attribute provides a representation that is mapped to at least one mapped item.
\returns
Returns the value of MappedRepresentation attribute.
*/
const OdDAIObjectId& getMappedRepresentation() const;
/** \details
Sets the value of MappedRepresentation attribute.
This attribute provides a representation that is mapped to at least one mapped item.
\param MappedRepresentation [in] Mapped representation to set.
*/
void setMappedRepresentation(const OdDAIObjectId& MappedRepresentation);
/** \details
Gets the value of HasShapeAspects attribute.
This attribute represents reference to the shape aspect that represents part of the shape or its feature distinctively.
\param HasShapeAspects [out] Receives the HasShapeAspects attribute.
*/
void getInvHasShapeAspects(OdDAIObjectIds& HasShapeAspects) const;
void getInvMapUsage(OdDAIObjectIds& MapUsage) const;
public:
/** \details
Default constructor for the IfcRepresentationMap class.
*/
IfcRepresentationMap();
/** \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
Sets the object ID of this instance to inverse attributes of related instances according to schema specification of inverse attributes.
*/
virtual void setInverseCounterParts() 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:
OdDAI::Select m_MappingOrigin; // IfcAxis2Placement
OdDAIObjectId m_MappedRepresentation; // IfcRepresentation
// Declare friend classes for inverse attributes functionality:
friend class IfcShapeAspect;
friend class IfcMappedItem;
};
/** \details
A data type that represents a smart pointer to a IfcRepresentationMap object.
*/
typedef OdSmartPtr IfcRepresentationMapPtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC4X2_IFCREPRESENTATIONMAP_AUTO_IMPL_H