CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc2x2_final::IfcStructuralAction Class Reference

#include <IfcStructuralActionAutoImpl.h>

Inheritance diagram for OdIfc2x2_final::IfcStructuralAction:
OdIfc2x2_final::IfcStructuralActivity OdIfc2x2_final::IfcProduct OdIfc2x2_final::IfcObject OdIfc2x2_final::IfcRoot OdIfc2x2_final::OdIfc2x2_FinalInstance OdIfc::OdIfcInstance OdIfc2x2_final::IfcStructuralLinearAction OdIfc2x2_final::IfcStructuralPlanarAction OdIfc2x2_final::IfcStructuralPointAction OdIfc2x2_final::IfcStructuralLinearActionVarying OdIfc2x2_final::IfcStructuralPlanarActionVarying

Public Member Functions

OdDAI::Boolean getDestabilizingLoad () const
 
void setDestabilizingLoad (OdDAI::Boolean DestabilizingLoad)
 
IfcProjectedOrTrueLengthEnum getProjectedOrTrue () const
 
void setProjectedOrTrue (IfcProjectedOrTrueLengthEnum ProjectedOrTrue)
 
const OdDAIObjectId & getCausedBy () const
 
void setCausedBy (const OdDAIObjectId &CausedBy)
 
 IfcStructuralAction ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler) override
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler) override
 
virtual OdDAI::Entity * getInstanceType () const override
 
virtual OdRxValue getAttr (const char *attrName) const override
 
virtual void unsetAttr (const char *explicitAttrName) override
 
virtual bool testAttr (const char *explicitAttrName) const override
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val) override
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const override
 
virtual OdIfc::OdIfcEntityType type () const override
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const override
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef) override
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const override
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val) override
 
- Public Member Functions inherited from OdIfc2x2_final::IfcStructuralActivity
const OdDAIObjectId & getAppliedLoad () const
 
void setAppliedLoad (const OdDAIObjectId &AppliedLoad)
 
IfcGlobalOrLocalEnum getGlobalOrLocal () const
 
void setGlobalOrLocal (IfcGlobalOrLocalEnum GlobalOrLocal)
 
OdDAIObjectId getInvAssignedToStructuralItem () const
 
 IfcStructuralActivity ()
 
- Public Member Functions inherited from OdIfc2x2_final::IfcProduct
const OdDAIObjectId & getObjectPlacement () const
 
void setObjectPlacement (const OdDAIObjectId &ObjectPlacement)
 
const OdDAIObjectId & getRepresentation () const
 
void setRepresentation (const OdDAIObjectId &Representation)
 
void getInvReferencedBy (OdDAIObjectIds &ReferencedBy) const
 
- Public Member Functions inherited from OdIfc2x2_final::IfcObject
const OdAnsiString & getObjectType () const
 
void setObjectType (const OdAnsiString &ObjectType)
 
void getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
void getInvHasAssignments (OdDAIObjectIds &HasAssignments) const
 
void getInvDecomposes (OdDAIObjectIds &Decomposes) const
 
void getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const
 
 IfcObject ()
 
- Public Member Functions inherited from OdIfc2x2_final::IfcRoot
OdDAI::CompressedGUID getGlobalId () const
 
void setGlobalId (OdDAI::CompressedGUID GlobalId)
 
const OdDAIObjectId & getOwnerHistory () const
 
void setOwnerHistory (const OdDAIObjectId &OwnerHistory)
 
const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
const OdAnsiString & getDescription () const
 
void setDescription (const OdAnsiString &Description)
 
 IfcRoot ()
 
- Public Member Functions inherited from OdIfc::OdIfcInstance
 ODRX_DECLARE_MEMBERS (OdIfcInstance)
 
 OdIfcInstance ()
 
 ~OdIfcInstance ()
 
bool isInstanceOf (OdIfcEntityType entityType) const
 
IfcOpResult resolved ()
 
void resolve (IfcOpResult resolved, void *resPtr)
 
void unresolve ()
 
virtual void setGsNode (OdGsCache *pGsNode)
 
virtual OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Protected Attributes

OdDAI::Boolean m_DestabilizingLoad
 
OdDAI::Enum m_ProjectedOrTrue
 
OdDAIObjectId m_CausedBy
 
- Protected Attributes inherited from OdIfc2x2_final::IfcStructuralActivity
OdDAIObjectId m_AppliedLoad
 
OdDAI::Enum m_GlobalOrLocal
 
- Protected Attributes inherited from OdIfc2x2_final::IfcProduct
OdDAIObjectId m_ObjectPlacement
 
OdDAIObjectId m_Representation
 
- Protected Attributes inherited from OdIfc2x2_final::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc2x2_final::IfcRoot
OdDAI::CompressedGUID m_GlobalId
 
OdDAIObjectId m_OwnerHistory
 
OdAnsiString m_Name
 
OdAnsiString m_Description
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Additional Inherited Members

- Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3dasPoint3d (const OdIfcInstance *inst)
 
static const OdGePoint2dasPoint2d (const OdIfcInstance *inst)
 
static const OdGeVector3dasVector3d (const OdIfcInstance *inst)
 
static const OdGeVector2dasVector2d (const OdIfcInstance *inst)
 
static const OdGeMatrix2dasMatrix2d (const OdIfcInstance *inst)
 
static const OdGeMatrix3dasMatrix3d (const OdIfcInstance *inst)
 
static OdIfcCompoundPtr asCompound (OdSmartPtr< OdIfcInstance > inst)
 
static const OdCmEntityColorasRgbColor (const OdIfcInstance *inst)
 

Detailed Description

A structural action is a structural activity that acts upon a structural item or building element. Structural actions are grouped into either an IfcStructuralLoadGroup of predefined type LOAD_GROUP or, more often, an IfcStructuralLoadCase. This is accomplished via the inverse relationship HasAssignments and an IfcRelAssignsToGroup relationship object. IfcStructuralLoadGroup.LoadGroupFor or IfcStructuralLoadCase.LoadGroupFor respectively refers to the structural analysis model(s) in which the loads are used.

It is possible to establish relationships between actions in one analysis model and reactions in another analysis model which cause the actions. For example, a support reaction from one structural system can be taken over as a load onto another supporting structural system. This is expressed by means of the inverse relationship ReferencedBy of the action and an IfcRelAssignsToProduct relationship object. IfcRelAssignsToProduct.Name is set to 'Causes' and IfcRelAssignsToProduct.RelatedObjects refers to an instance of a subtype of IfcStructuralReaction.

Definition at line 49 of file Ifc2x2_Final/IfcStructuralActionAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcStructuralAction()

OdIfc2x2_final::IfcStructuralAction::IfcStructuralAction ( )

Default constructor for the IfcStructuralAction class.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x2_final::IfcStructuralAction::getAttr ( const char * attrName) const
overridevirtual

Returns an attribute value for the specified attribute name.

Parameters
attrName[in] Name of an attribute to query.
Returns
OdRxValue object that represents a generic variant type value.

Reimplemented from OdIfc2x2_final::IfcStructuralActivity.

Reimplemented in OdIfc2x2_final::IfcStructuralLinearActionVarying, and OdIfc2x2_final::IfcStructuralPlanarActionVarying.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x2_final::IfcStructuralAction::getAttr ( const OdIfc::OdIfcAttribute attrDef) const
overridevirtual

Returns an attribute value for the specified attribute definition.

Parameters
attrDef[in] Attribute definition to query.
Returns
OdRxValue object that represents a generic variant type value.

Reimplemented from OdIfc2x2_final::IfcStructuralActivity.

Reimplemented in OdIfc2x2_final::IfcStructuralLinearActionVarying, and OdIfc2x2_final::IfcStructuralPlanarActionVarying.

◆ getCausedBy()

const OdDAIObjectId & OdIfc2x2_final::IfcStructuralAction::getCausedBy ( ) const

Returns the value of CausedBy attribute. This attribute represents an optional reference to an instance of IfcStructuralReaction representing a result of another structural analysis model which creates this action upon the considered structural analysis model.

Returns
Returns the value of CausedBy attribute.

◆ getDestabilizingLoad()

OdDAI::Boolean OdIfc2x2_final::IfcStructuralAction::getDestabilizingLoad ( ) const

Returns the value of DestabilizingLoad attribute. This attribute represents indicates if this action can cause a stability problem. If it is 'FALSE', no further investigations regarding stability problems are necessary.

Returns
Returns the value of DestabilizingLoad attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x2_final::IfcStructuralAction::getInstanceType ( ) const
overridevirtual

Returns a type of a class instance.

Returns
Pointer to the <exref target=https://docs.opendesign.com/tkernel_api_cpp/OdDAI__Entity.html>>OdDAI::Entity</exref> type that determines an entity definition within a schema.

Reimplemented from OdIfc2x2_final::IfcStructuralActivity.

Reimplemented in OdIfc2x2_final::IfcStructuralLinearAction, OdIfc2x2_final::IfcStructuralLinearActionVarying, OdIfc2x2_final::IfcStructuralPlanarAction, OdIfc2x2_final::IfcStructuralPlanarActionVarying, and OdIfc2x2_final::IfcStructuralPointAction.

◆ getProjectedOrTrue()

IfcProjectedOrTrueLengthEnum OdIfc2x2_final::IfcStructuralAction::getProjectedOrTrue ( ) const

Returns the value of ProjectedOrTrue attribute. This attribute indicates whether the load values are specified by using the length of the member on which they act (true length) or by using the projected length resulting from the loaded member and the global project coordinate system. It is only considered if the global project coordinate system is used, and if the action is of type IfcStructuralLinearAction or IfcStructuralPlanarAction.

Returns
Returns the value of ProjectedOrTrue attribute.

◆ inFields()

virtual OdResult OdIfc2x2_final::IfcStructuralAction::inFields ( OdDAI::OdSpfFilerBase * rdFiler)
overridevirtual

Reads object's data from the specified filer.

Parameters
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.

Reimplemented from OdIfc2x2_final::IfcStructuralActivity.

Reimplemented in OdIfc2x2_final::IfcStructuralLinearActionVarying, and OdIfc2x2_final::IfcStructuralPlanarActionVarying.

◆ isKindOf()

virtual bool OdIfc2x2_final::IfcStructuralAction::isKindOf ( OdIfc::OdIfcEntityType entityType) const
overridevirtual

Checks whether the specified instance is the object derived from or belongs to this class.

Parameters
entityType[in] Entity to check.
Returns
true if the specified instance is the object derived from or belongs to this class, false otherwise.

Reimplemented from OdIfc2x2_final::IfcStructuralActivity.

Reimplemented in OdIfc2x2_final::IfcStructuralLinearAction, OdIfc2x2_final::IfcStructuralLinearActionVarying, OdIfc2x2_final::IfcStructuralPlanarAction, OdIfc2x2_final::IfcStructuralPlanarActionVarying, and OdIfc2x2_final::IfcStructuralPointAction.

◆ outFields()

virtual OdResult OdIfc2x2_final::IfcStructuralAction::outFields ( OdDAI::OdSpfFilerBase * wrFiler)
overridevirtual

Writes object's data the the specified filer.

Parameters
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.

Reimplemented from OdIfc2x2_final::IfcStructuralActivity.

Reimplemented in OdIfc2x2_final::IfcStructuralLinearActionVarying, and OdIfc2x2_final::IfcStructuralPlanarActionVarying.

◆ putAttr() [1/2]

virtual bool OdIfc2x2_final::IfcStructuralAction::putAttr ( const char * explicitAttrName,
const OdRxValue & val )
overridevirtual

Sets the specified attribute with a given value.

Parameters
explicitAttrName[in] Explicit name of the attribute to set.
val[in] Value to set.
Returns
true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc2x2_final::IfcStructuralActivity.

Reimplemented in OdIfc2x2_final::IfcStructuralLinearActionVarying, and OdIfc2x2_final::IfcStructuralPlanarActionVarying.

◆ putAttr() [2/2]

virtual bool OdIfc2x2_final::IfcStructuralAction::putAttr ( const OdIfc::OdIfcAttribute explicitAttrDef,
const OdRxValue & val )
overridevirtual

Sets the specified attribute with a given value.

Parameters
explicitAttrDef[in] Explicit attribute definition to set.
val[in] Value to set.
Returns
true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc2x2_final::IfcStructuralActivity.

Reimplemented in OdIfc2x2_final::IfcStructuralLinearActionVarying, and OdIfc2x2_final::IfcStructuralPlanarActionVarying.

◆ setCausedBy()

void OdIfc2x2_final::IfcStructuralAction::setCausedBy ( const OdDAIObjectId & CausedBy)

Sets the value of CausedBy attribute. This attribute represents an optional reference to an instance of IfcStructuralReaction representing a result of another structural analysis model which creates this action upon the considered structural analysis model.

Parameters
CausedBy[in] CausedBy attribute to set.

◆ setDestabilizingLoad()

void OdIfc2x2_final::IfcStructuralAction::setDestabilizingLoad ( OdDAI::Boolean DestabilizingLoad)

Sets the value of DestabilizingLoad attribute. This attribute represents indicates if this action can cause a stability problem. If it is 'FALSE', no further investigations regarding stability problems are necessary.

Parameters
DestabilizingLoad[in] Destabilizing load to set.

◆ setProjectedOrTrue()

void OdIfc2x2_final::IfcStructuralAction::setProjectedOrTrue ( IfcProjectedOrTrueLengthEnum ProjectedOrTrue)

Sets the value of ProjectedOrTrue attribute. This attribute indicates whether the load values are specified by using the length of the member on which they act (true length) or by using the projected length resulting from the loaded member and the global project coordinate system. It is only considered if the global project coordinate system is used, and if the action is of type IfcStructuralLinearAction or IfcStructuralPlanarAction.

Parameters
ProjectedOrTrue[in] ProjectedOrTrue attribute to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x2_final::IfcStructuralAction::testAttr ( const char * explicitAttrName) const
overridevirtual

Checks whether the specified attribute is set.

Parameters
explicitAttrName[in] Explicit name of the attribute to test.
Returns
true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc2x2_final::IfcStructuralActivity.

Reimplemented in OdIfc2x2_final::IfcStructuralLinearActionVarying, and OdIfc2x2_final::IfcStructuralPlanarActionVarying.

◆ testAttr() [2/2]

virtual bool OdIfc2x2_final::IfcStructuralAction::testAttr ( const OdIfc::OdIfcAttribute explicitAttrDef) const
overridevirtual

Checks whether the specified attribute is set.

Parameters
explicitAttrDef[in] Attribute definition to test.
Returns
true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc2x2_final::IfcStructuralActivity.

Reimplemented in OdIfc2x2_final::IfcStructuralLinearActionVarying, and OdIfc2x2_final::IfcStructuralPlanarActionVarying.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x2_final::IfcStructuralAction::type ( ) const
overridevirtual

Returns the type of this entity.

Returns
A value of the <exref target=https://docs.opendesign.com/tkernel_api_cpp/OdIfc__OdIfcEntityType.html>>OdIfc::OdIfcEntityType</exref> type that represents type of this entity.

Reimplemented from OdIfc2x2_final::IfcStructuralActivity.

Reimplemented in OdIfc2x2_final::IfcStructuralLinearAction, OdIfc2x2_final::IfcStructuralLinearActionVarying, OdIfc2x2_final::IfcStructuralPlanarAction, OdIfc2x2_final::IfcStructuralPlanarActionVarying, and OdIfc2x2_final::IfcStructuralPointAction.

◆ unsetAttr() [1/2]

virtual void OdIfc2x2_final::IfcStructuralAction::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

Parameters
explicitAttrName[in] Explicit name of the attribute to reset.

Reimplemented from OdIfc2x2_final::IfcStructuralActivity.

Reimplemented in OdIfc2x2_final::IfcStructuralLinearActionVarying, and OdIfc2x2_final::IfcStructuralPlanarActionVarying.

◆ unsetAttr() [2/2]

virtual void OdIfc2x2_final::IfcStructuralAction::unsetAttr ( const OdIfc::OdIfcAttribute explicitAttrDef)
overridevirtual

Resets a value for the specified attribute.

Parameters
explicitAttrDef[in] Explicit definition that represents an attribute to reset.

Reimplemented from OdIfc2x2_final::IfcStructuralActivity.

Reimplemented in OdIfc2x2_final::IfcStructuralLinearActionVarying, and OdIfc2x2_final::IfcStructuralPlanarActionVarying.

Member Data Documentation

◆ m_CausedBy

OdDAIObjectId OdIfc2x2_final::IfcStructuralAction::m_CausedBy
protected

Definition at line 228 of file Ifc2x2_Final/IfcStructuralActionAutoImpl.h.

◆ m_DestabilizingLoad

OdDAI::Boolean OdIfc2x2_final::IfcStructuralAction::m_DestabilizingLoad
protected

Definition at line 226 of file Ifc2x2_Final/IfcStructuralActionAutoImpl.h.

◆ m_ProjectedOrTrue

OdDAI::Enum OdIfc2x2_final::IfcStructuralAction::m_ProjectedOrTrue
protected

Definition at line 227 of file Ifc2x2_Final/IfcStructuralActionAutoImpl.h.


The documentation for this class was generated from the following file: