///////////////////////////////////////////////////////////////////////////////
// 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_IFCSTRUCTURALCURVEACTION_AUTO_IMPL_H
#define _IFC4X2_IFCSTRUCTURALCURVEACTION_AUTO_IMPL_H
#include "IfcStructuralActionAutoImpl.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
A structural curve action defines an action which is distributed over a curve.
A curve action can be connected with a curve member or curve connection, or surface member or surface connection.
- Coordinate Systems -
Coordinate systems and related behavior is the same as for IfcStructuralActivity.
- Topology Use Definitions -
* Standard Case: If connected with a curve item, instances of IfcStructuralCurveAction have no ObjectPlacement nor Representation.
It is implied that the placement and representation of the IfcStructuralActivity is the same as the ones of the member or connection.
* Special Case 1: If connected with a surface item, instances of IfcStructuralCurveAction have an ObjectPlacement and Representation, containing an IfcEdgeCurve.
See IfcStructuralActivity for further definitions.
* Special Case 2: If not connected with a structural item (which can happen in an incomplete or conceptual model),
a curve action should have an ObjectPlacement and Representation, containing an IfcEdgeCurve. See IfcStructuralActivity for further definitions.
*/
class IFC4X2_EXPORT IfcStructuralCurveAction : public IfcStructuralAction
{
//DOM-IGNORE-BEGIN
OD_EXP_DECLARE_MEMBERS(OdIfc4x2::IfcStructuralCurveAction);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of ProjectedOrTrue attribute.
This attribute represents defines whether load values are specified per true length of the curve on which they act,
or per length of the projection of the curve in load direction. The latter is only applicable to loads which act in global coordinate directions.
\returns
Returns the value of ProjectedOrTrue attribute.
*/
IfcProjectedOrTrueLengthEnum getProjectedOrTrue() const;
/** \details
Sets the value of ProjectedOrTrue attribute.
This attribute represents defines whether load values are specified per true length of the curve on which they act,
or per length of the projection of the curve in load direction. The latter is only applicable to loads which act in global coordinate directions.
\param ProjectedOrTrue [in] ProjectedOrTrue attribute to set.
*/
void setProjectedOrTrue(IfcProjectedOrTrueLengthEnum ProjectedOrTrue);
/** \details
Returns the value of PredefinedType attribute.
This attribute represents type of action according to its distribution of load values.
\returns
Returns the value of PredefinedType attribute.
*/
IfcStructuralCurveActivityTypeEnum getPredefinedType() const;
/** \details
Sets the value of PredefinedType attribute.
This attribute represents type of action according to its distribution of load values.
\param PredefinedType [in] Predefined type to set.
*/
void setPredefinedType(IfcStructuralCurveActivityTypeEnum PredefinedType);
public:
/** \details
Default constructor for the IfcStructuralCurveAction class.
*/
IfcStructuralCurveAction();
/** \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:
OdDAI::Enum m_ProjectedOrTrue; // IfcProjectedOrTrueLengthEnum [optional]
OdDAI::Enum m_PredefinedType; // IfcStructuralCurveActivityTypeEnum
};
/** \details
A data type that represents a smart pointer to a IfcStructuralCurveAction object.
*/
typedef OdSmartPtr IfcStructuralCurveActionPtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC4X2_IFCSTRUCTURALCURVEACTION_AUTO_IMPL_H