/////////////////////////////////////////////////////////////////////////////// // 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 _IFC4_IFCRELCONNECTSSTRUCTURALMEMBER_AUTO_IMPL_H #define _IFC4_IFCRELCONNECTSSTRUCTURALMEMBER_AUTO_IMPL_H #include "IfcRelConnectsAutoImpl.h" #include "IfcStructuralMemberAutoImpl.h" #include "IfcStructuralConnectionAutoImpl.h" #include "IfcBoundaryConditionAutoImpl.h" #include "IfcStructuralConnectionConditionAutoImpl.h" #include "IfcAxis2Placement3DAutoImpl.h" #include "TD_PackPush.h" /** \details The namespace contains schema-dependent classes, definitions and sub routines for work with IFC4 express schema definitions. */ namespace OdIfc4 { /** \details The entity IfcRelConnectsStructuralMember defines all needed properties describing the connection between structural members and structural connection objects (nodes or supports). - Point Connection - Instances of the entity IfcRelConnectsStructuralMember shall be used to describe a connection between an instance of IfcStructuralPointConnection and either an instance of IfcStructuralCurveMember or IfcStructuralSurfaceMember. The RelatedStructuralConnection for point connections has to be of type IfcStructuralPointConnection. - Curve Connection - Instances of the entity IfcRelConnectsStructuralMember shall be used to describe a connection between an instance of IfcStructuralCurveConnection and an instance of either IfcStructuralCurveMember or IfcStructuralSurfaceMember. The RelatedStructuralConnection for curve connections has to be of type IfcStructuralCurveConnection. - Surface Connection - Instances of the entity IfcRelConnectsStructuralMember shall be used to describe a connection between an instance of IfcStructuralSurfaceConnection and an instance of IfcStructuralSurfaceMember. The RelatedStructuralConnection for curve connections has to be of type IfcStructuralSurfaceConnection. - Coordinate System for Applied Conditions - All values defined by AppliedCondition or AdditionalConditions are given within the coordinate system provided by ConditionCoordinateSystem, which is defined relative to the local coordinate system of the structural member. If the ConditionCoordinateSystem is not defined, the local coordinate system of the structural member is used instead. - Supported Length - Optionally a supported length can be given, which specifies the length (or width) of the physical connection along a curve connection. */ class IFC4_EXPORT IfcRelConnectsStructuralMember : public IfcRelConnects { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc4::IfcRelConnectsStructuralMember); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Returns the value of RelatingStructuralMember attribute. This attribute represents reference to an instance of IfcStructuralMember (or its subclasses) which is connected to the specified structural connection. \returns Returns the value of RelatingStructuralMember attribute. */ const OdDAIObjectId& getRelatingStructuralMember() const; /** \details Sets the value of RelatingStructuralMember attribute. This attribute represents reference to an instance of IfcStructuralMember (or its subclasses) which is connected to the specified structural connection. \param RelatingStructuralMember [in] Relating structural member to set. */ void setRelatingStructuralMember(const OdDAIObjectId& RelatingStructuralMember); /** \details Returns the value of RelatedStructuralConnection attribute. This attribute represents reference to an instance of IfcStructuralConnection (or its subclasses) which is connected to the specified structural member. \returns Returns the value of RelatedStructuralConnection attribute. */ const OdDAIObjectId& getRelatedStructuralConnection() const; /** \details Sets the value of RelatedStructuralConnection attribute. This attribute represents reference to an instance of IfcStructuralConnection (or its subclasses) which is connected to the specified structural member. \param RelatedStructuralConnection [in] Related structural connection to set. */ void setRelatedStructuralConnection(const OdDAIObjectId& RelatedStructuralConnection); /** \details Returns the value of AppliedCondition attribute. This attribute represents conditions which define the connections properties. Connection conditions are often called release but are not only used to define mechanisms like hinges but also rigid, elastic, and other conditions. \returns Returns the value of AppliedCondition attribute. */ const OdDAIObjectId& getAppliedCondition() const; /** \details Sets the value of AppliedCondition attribute. This attribute represents conditions which define the connections properties. Connection conditions are often called release but are not only used to define mechanisms like hinges but also rigid, elastic, and other conditions. \param AppliedCondition [in] Applied condition to set. */ void setAppliedCondition(const OdDAIObjectId& AppliedCondition); /** \details Returns the value of AdditionalConditions attribute. This attribute describes additional connection properties. \returns Returns the value of AdditionalConditions attribute. */ const OdDAIObjectId& getAdditionalConditions() const; /** \details Sets the value of AdditionalConditions attribute. This attribute describes additional connection properties. \param AdditionalConditions [in] Additional conditions to set. */ void setAdditionalConditions(const OdDAIObjectId& AdditionalConditions); /** \details Returns the value of SupportedLength attribute. This attribute represents the 'supported length' of this structural connection. See class description for more details. \returns Returns the value of SupportedLength attribute. */ double getSupportedLength() const; /** \details Sets the value of SupportedLength attribute. This attribute represents the 'supported length' of this structural connection. See class description for more details. \param SupportedLength [in] Supported length to set. */ void setSupportedLength(double SupportedLength); /** \details Returns the value of ConditionCoordinateSystem attribute. This attribute represents a coordinate system used for the description of the connection properties in ConnectionCondition relative to the local coordinate system of RelatingStructuralMember. If left unspecified, the placement IfcAxis2Placement3D((x,y,z), ?, ?) is implied with x,y,z being the local member coordinates where the connection is made and the default axes directions are in parallel with the local axes of RelatingStructuralMember. \returns Returns the value of ConditionCoordinateSystem attribute. */ const OdDAIObjectId& getConditionCoordinateSystem() const; /** \details Sets the value of ConditionCoordinateSystem attribute. This attribute represents a coordinate system used for the description of the connection properties in ConnectionCondition relative to the local coordinate system of RelatingStructuralMember. If left unspecified, the placement IfcAxis2Placement3D((x,y,z), ?, ?) is implied with x,y,z being the local member coordinates where the connection is made and the default axes directions are in parallel with the local axes of RelatingStructuralMember. \param ConditionCoordinateSystem [in] Condition coordinate system to set. */ void setConditionCoordinateSystem(const OdDAIObjectId& ConditionCoordinateSystem); public: /** \details Default constructor for the IfcRelConnectsStructuralMember class. */ IfcRelConnectsStructuralMember(); /** \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 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 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_RelatingStructuralMember; // IfcStructuralMember OdDAIObjectId m_RelatedStructuralConnection; // IfcStructuralConnection OdDAIObjectId m_AppliedCondition; // IfcBoundaryCondition [optional] OdDAIObjectId m_AdditionalConditions; // IfcStructuralConnectionCondition [optional] double m_SupportedLength; // IfcLengthMeasure [optional] OdDAIObjectId m_ConditionCoordinateSystem; // IfcAxis2Placement3D [optional] }; /** \details A data type that represents a smart pointer to a IfcRelConnectsStructuralMember object. */ typedef OdSmartPtr IfcRelConnectsStructuralMemberPtr; } // namespace #include "TD_PackPop.h" #endif // _IFC4_IFCRELCONNECTSSTRUCTURALMEMBER_AUTO_IMPL_H