CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4x2::IfcStructuralActivity Class Reference

#include <IfcStructuralActivityAutoImpl.h>

Inheritance diagram for OdIfc4x2::IfcStructuralActivity:
OdIfc4x2::IfcProduct OdIfc4x2::IfcObject OdIfc4x2::IfcObjectDefinition OdIfc4x2::IfcRoot OdIfc4x2::OdIfc4x2Instance OdIfc::OdIfcInstance OdIfc4x2::IfcStructuralAction OdIfc4x2::IfcStructuralReaction OdIfc4x2::IfcStructuralCurveAction OdIfc4x2::IfcStructuralPointAction OdIfc4x2::IfcStructuralSurfaceAction OdIfc4x2::IfcStructuralCurveReaction OdIfc4x2::IfcStructuralPointReaction OdIfc4x2::IfcStructuralSurfaceReaction OdIfc4x2::IfcStructuralLinearAction OdIfc4x2::IfcStructuralPlanarAction

Public Member Functions

const OdDAIObjectId & getAppliedLoad () const
 
void setAppliedLoad (const OdDAIObjectId &AppliedLoad)
 
IfcGlobalOrLocalEnum getGlobalOrLocal () const
 
void setGlobalOrLocal (IfcGlobalOrLocalEnum GlobalOrLocal)
 
void getInvAssignedToStructuralItem (OdDAIObjectIds &AssignedToStructuralItem) const
 
 IfcStructuralActivity ()
 
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 OdIfc4x2::IfcProduct
const OdDAIObjectId & getObjectPlacement () const
 
void setObjectPlacement (const OdDAIObjectId &ObjectPlacement)
 
const OdDAIObjectId & getRepresentation () const
 
void setRepresentation (const OdDAIObjectId &Representation)
 
void getInvReferencedBy (OdDAIObjectIds &ReferencedBy) const
 
void getInvPositionedRelativeTo (OdDAIObjectIds &PositionedRelativeTo) const
 
virtual void setInverseCounterParts () override
 
- Public Member Functions inherited from OdIfc4x2::IfcObject
const OdAnsiString & getObjectType () const
 
void setObjectType (const OdAnsiString &ObjectType)
 
void getInvIsDeclaredBy (OdDAIObjectIds &IsDeclaredBy) const
 
void getInvDeclares (OdDAIObjectIds &Declares) const
 
void getInvIsTypedBy (OdDAIObjectIds &IsTypedBy) const
 
void getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const
 
 IfcObject ()
 
- Public Member Functions inherited from OdIfc4x2::IfcObjectDefinition
void getInvHasAssignments (OdDAIObjectIds &HasAssignments) const
 
void getInvNests (OdDAIObjectIds &Nests) const
 
void getInvIsNestedBy (OdDAIObjectIds &IsNestedBy) const
 
void getInvHasContext (OdDAIObjectIds &HasContext) const
 
void getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const
 
void getInvDecomposes (OdDAIObjectIds &Decomposes) const
 
void getInvHasAssociations (OdDAIObjectIds &HasAssociations) const
 
- Public Member Functions inherited from OdIfc4x2::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 OdIfc4x2::OdIfc4x2Instance
void setInverseCounterParts () override
 
- 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

OdDAIObjectId m_AppliedLoad
 
OdDAI::Enum m_GlobalOrLocal
 
- Protected Attributes inherited from OdIfc4x2::IfcProduct
OdDAIObjectId m_ObjectPlacement
 
OdDAIObjectId m_Representation
 
- Protected Attributes inherited from OdIfc4x2::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc4x2::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
 

Friends

class IfcRelConnectsStructuralActivity
 

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

The abstract entity IfcStructuralActivity combines the definition of actions (such as forces, displacements, etc.) and reactions (support reactions, internal forces, deflections, etc.) which are specified by using the basic load definitions from the IfcStructuralLoadResource.

  • Coordinate Systems - The following coordinate systems are distinguished: The so-called global coordinate system is the coordinate system shared by all items and activities which are grouped in a common IfcStructuralAnalysisModel. This coordinate system is established by SELF\IfcProduct.ObjectPlacement. (This coordinate system is not necessarily the same as the IfcProject's world coordinate system.) The so-called local coordinate system is a coordinate system local to a structural item. This coordinate system is established by a Representation (attribute inherited from IfcProduct) in conjunction with further use definitions and attributes of subtypes of IfcStructuralItem.

Representation items in topology representations are always given within the ObjectPlacement, i.e. in so-called global coordinates (global with respect to the IfcStructuralAnalysisModel to which this item belongs). The usage of local coordinate systems is further defined in subtypes.

  • Topology Use Definitions - Instances of IfcStructuralItem have a topology representation. It includes a placement and a product representation. The IfcProductRepresentation is given by an item in a Representation of type IfcTopologyRepresentation.
  • Local Placement - The local placement for IfcStructuralItem is defined in its supertype IfcProduct. It is defined by the IfcLocalPlacement, which establishes a global coordinate system which is common to all items and activities in an IfcStructuralAnalysisModel.
  • Topology Representation - Instances of IfcStructuralItem have a topology representation given by an instance of a subtype of IfcTopologicalRepresentationItem, which should be the single item of IfcTopologyRepresentation.Items. Depending on the dimensionality of the structural item, one of the following types of toplogical representation items is used:

    Point connections are represented by an IfcVertexPoint with an underlying IfcCartesianPoint. The Cartesian point is the reference point of the connection in the so-called global coordinate system. The following labels are used in the IfcTopologyRepresentation: RepresentationIdentifier: 'Reference' RepresentationType: 'Vertex'
    Curve members and curve connections can either be represented by an IfcOrientedEdge, IfcEdgeCurve, or IfcEdge. The curve to which the IfcEdgeCurve (or an IfcOrientedEdge's underlying IfcEdgeCurve) refers to is the reference curve of the structural item in the global coordinate system. Start and end vertex of the edge is _IfcVertexPoint_s with underlying _IfcCartesianPoint_s. The following labels are used in the IfcTopologyRepresentation: RepresentationIdentifier: 'Reference' RepresentationType: 'Edge' Surface members and surface connections is represented by an IfcFaceSurface. The underlying surface defines the reference surface of the structural surface item in the global coordiante system. All edges in the bounds of the face conform to the rules for edge representations of structural curve item. The following labels are used in the IfcTopologyRepresentation: RepresentationIdentifier: 'Reference' RepresentationType: 'Face'

The reference point, reference curve, or reference surface partially or completely defines the local coordinate system of the represented structural item according to the following rules. In all cases, The local x,y,z directions form a right-handed Cartesian coordinate system.

Structural point items

The reference point in the representation is the origin of the local coordinate system of the structural item. The axes of the local coordinate system are either parallel with and directed like the so-called global coordinate axes, or are oriented according to definitions at the respective subtype of IfcStructuralItem.

Structural curve items

The u parameter origin of the reference curve in the representation is the origin of the local coordinate system of the structural item. The local x axis is parallel with the tangent on the curve and directed like the u parameter direction. The local y and z axes are oriented according to definitions at the respective subtypes of IfcStructuralItem.

Structural surface items

The u,v parameter origin of the reference surface in the representation is the origin of the local coordinate system of the structural item. The local x and y directions follow the tangents on the surface and are in parallel with and directed like u and v respectively. The local z direction is in parallel with and directed like the surface normal.

\changes

IFC4 changes: Type of the inverse attribute AssignedToStructuralItem changed from "IfcRelConnectsStructuralActivity FOR RelatedStructuralActivity" to "SET OF [0:1] IfcRelConnectsStructuralActivity FOR RelatedStructuralActivity"

Definition at line 118 of file Ifc4x2/IfcStructuralActivityAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcStructuralActivity()

OdIfc4x2::IfcStructuralActivity::IfcStructuralActivity ( )

Default constructor for the IfcStructuralActivity class.

Member Function Documentation

◆ getAppliedLoad()

const OdDAIObjectId & OdIfc4x2::IfcStructuralActivity::getAppliedLoad ( ) const

Returns the value of AppliedLoad attribute. This attribute represents load or result resource object which defines the load type, direction, and load values. In case of activities which are variably distributed over curves or surfaces, IfcStructuralLoadConfiguration is used which provides a list of load samples and their locations within the load distribution, measured in local coordinates of the curve or surface on which this activity acts. The contents of this load or result distribution can be further restricted by definitions at subtypes of IfcStructuralActivity.

Returns
Returns the value of AppliedLoad attribute.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x2::IfcStructuralActivity::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 OdIfc4x2::IfcProduct.

Reimplemented in OdIfc4x2::IfcStructuralAction, OdIfc4x2::IfcStructuralCurveAction, OdIfc4x2::IfcStructuralCurveReaction, OdIfc4x2::IfcStructuralSurfaceAction, and OdIfc4x2::IfcStructuralSurfaceReaction.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x2::IfcStructuralActivity::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 OdIfc4x2::IfcProduct.

Reimplemented in OdIfc4x2::IfcStructuralAction, OdIfc4x2::IfcStructuralCurveAction, OdIfc4x2::IfcStructuralCurveReaction, OdIfc4x2::IfcStructuralSurfaceAction, and OdIfc4x2::IfcStructuralSurfaceReaction.

◆ getGlobalOrLocal()

IfcGlobalOrLocalEnum OdIfc4x2::IfcStructuralActivity::getGlobalOrLocal ( ) const

Returns the value of GlobalOrLocal attribute. This attribute represents indicates whether the load directions refer to the global coordinate system (global to the analysis model, i.e. as established by IfcStructuralAnalysisModel.SharedPlacement) or to the local coordinate system (local to the activity or connected item, as established by an explicit or implied representation and its parameter space).

Returns
Returns the value of GlobalOrLocal attribute.
Remarks
The informal definition of IfcRepresentationResource.IfcGlobalOrLocalEnum does not distinguish between global coordinate system and world coordinate system. On the other hand, this distinction is necessary in the IfcStructuralAnalysisDomain where the shared global coordinate system of an analysis model not be the same as the project-wide world coordinate system.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x2::IfcStructuralActivity::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 OdIfc4x2::IfcProduct.

Reimplemented in OdIfc4x2::IfcStructuralAction, OdIfc4x2::IfcStructuralCurveAction, OdIfc4x2::IfcStructuralCurveReaction, OdIfc4x2::IfcStructuralLinearAction, OdIfc4x2::IfcStructuralPlanarAction, OdIfc4x2::IfcStructuralPointAction, OdIfc4x2::IfcStructuralPointReaction, OdIfc4x2::IfcStructuralReaction, OdIfc4x2::IfcStructuralSurfaceAction, and OdIfc4x2::IfcStructuralSurfaceReaction.

◆ getInvAssignedToStructuralItem()

void OdIfc4x2::IfcStructuralActivity::getInvAssignedToStructuralItem ( OdDAIObjectIds & AssignedToStructuralItem) const

Returns the value of AssignedToStructuralItem attribute. This attribute represents reference to the IfcRelConnectsStructuralActivity relationship by which activities are connected with structural items.

Parameters
AssignedToStructuralItem[out] Receives the value of AssignedToStructuralItem attribute.

◆ inFields()

virtual OdResult OdIfc4x2::IfcStructuralActivity::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 OdIfc4x2::IfcProduct.

Reimplemented in OdIfc4x2::IfcStructuralAction, OdIfc4x2::IfcStructuralCurveAction, OdIfc4x2::IfcStructuralCurveReaction, OdIfc4x2::IfcStructuralSurfaceAction, and OdIfc4x2::IfcStructuralSurfaceReaction.

◆ isKindOf()

virtual bool OdIfc4x2::IfcStructuralActivity::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 OdIfc4x2::IfcProduct.

Reimplemented in OdIfc4x2::IfcStructuralAction, OdIfc4x2::IfcStructuralCurveAction, OdIfc4x2::IfcStructuralCurveReaction, OdIfc4x2::IfcStructuralLinearAction, OdIfc4x2::IfcStructuralPlanarAction, OdIfc4x2::IfcStructuralPointAction, OdIfc4x2::IfcStructuralPointReaction, OdIfc4x2::IfcStructuralReaction, OdIfc4x2::IfcStructuralSurfaceAction, and OdIfc4x2::IfcStructuralSurfaceReaction.

◆ outFields()

virtual OdResult OdIfc4x2::IfcStructuralActivity::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 OdIfc4x2::IfcProduct.

Reimplemented in OdIfc4x2::IfcStructuralAction, OdIfc4x2::IfcStructuralCurveAction, OdIfc4x2::IfcStructuralCurveReaction, OdIfc4x2::IfcStructuralSurfaceAction, and OdIfc4x2::IfcStructuralSurfaceReaction.

◆ putAttr() [1/2]

virtual bool OdIfc4x2::IfcStructuralActivity::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 OdIfc4x2::IfcProduct.

Reimplemented in OdIfc4x2::IfcStructuralAction, OdIfc4x2::IfcStructuralCurveAction, OdIfc4x2::IfcStructuralCurveReaction, OdIfc4x2::IfcStructuralSurfaceAction, and OdIfc4x2::IfcStructuralSurfaceReaction.

◆ putAttr() [2/2]

virtual bool OdIfc4x2::IfcStructuralActivity::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 OdIfc4x2::IfcProduct.

Reimplemented in OdIfc4x2::IfcStructuralAction, OdIfc4x2::IfcStructuralCurveAction, OdIfc4x2::IfcStructuralCurveReaction, OdIfc4x2::IfcStructuralSurfaceAction, and OdIfc4x2::IfcStructuralSurfaceReaction.

◆ setAppliedLoad()

void OdIfc4x2::IfcStructuralActivity::setAppliedLoad ( const OdDAIObjectId & AppliedLoad)

Sets the value of AppliedLoad attribute. This attribute represents load or result resource object which defines the load type, direction, and load values. In case of activities which are variably distributed over curves or surfaces, IfcStructuralLoadConfiguration is used which provides a list of load samples and their locations within the load distribution, measured in local coordinates of the curve or surface on which this activity acts. The contents of this load or result distribution can be further restricted by definitions at subtypes of IfcStructuralActivity.

Parameters
AppliedLoad[in] AppliedLoad attribute to set.

◆ setGlobalOrLocal()

void OdIfc4x2::IfcStructuralActivity::setGlobalOrLocal ( IfcGlobalOrLocalEnum GlobalOrLocal)

Sets the value of GlobalOrLocal attribute. This attribute represents indicates whether the load directions refer to the global coordinate system (global to the analysis model, i.e. as established by IfcStructuralAnalysisModel.SharedPlacement) or to the local coordinate system (local to the activity or connected item, as established by an explicit or implied representation and its parameter space).

Parameters
GlobalOrLocal[in] GlobalOrLocal attribute to set.
Remarks
The informal definition of IfcRepresentationResource.IfcGlobalOrLocalEnum does not distinguish between global coordinate system and world coordinate system. On the other hand, this distinction is necessary in the IfcStructuralAnalysisDomain where the shared global coordinate system of an analysis model not be the same as the project-wide world coordinate system.

◆ testAttr() [1/2]

virtual bool OdIfc4x2::IfcStructuralActivity::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 OdIfc4x2::IfcProduct.

Reimplemented in OdIfc4x2::IfcStructuralAction, OdIfc4x2::IfcStructuralCurveAction, OdIfc4x2::IfcStructuralCurveReaction, OdIfc4x2::IfcStructuralSurfaceAction, and OdIfc4x2::IfcStructuralSurfaceReaction.

◆ testAttr() [2/2]

virtual bool OdIfc4x2::IfcStructuralActivity::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 OdIfc4x2::IfcProduct.

Reimplemented in OdIfc4x2::IfcStructuralAction, OdIfc4x2::IfcStructuralCurveAction, OdIfc4x2::IfcStructuralCurveReaction, OdIfc4x2::IfcStructuralSurfaceAction, and OdIfc4x2::IfcStructuralSurfaceReaction.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x2::IfcStructuralActivity::type ( ) const
overridevirtual

◆ unsetAttr() [1/2]

virtual void OdIfc4x2::IfcStructuralActivity::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc4x2::IfcProduct.

Reimplemented in OdIfc4x2::IfcStructuralAction, OdIfc4x2::IfcStructuralCurveAction, OdIfc4x2::IfcStructuralCurveReaction, OdIfc4x2::IfcStructuralSurfaceAction, and OdIfc4x2::IfcStructuralSurfaceReaction.

◆ unsetAttr() [2/2]

virtual void OdIfc4x2::IfcStructuralActivity::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 OdIfc4x2::IfcProduct.

Reimplemented in OdIfc4x2::IfcStructuralAction, OdIfc4x2::IfcStructuralCurveAction, OdIfc4x2::IfcStructuralCurveReaction, OdIfc4x2::IfcStructuralSurfaceAction, and OdIfc4x2::IfcStructuralSurfaceReaction.

Friends And Related Symbol Documentation

◆ IfcRelConnectsStructuralActivity

friend class IfcRelConnectsStructuralActivity
friend

Definition at line 303 of file Ifc4x2/IfcStructuralActivityAutoImpl.h.

Member Data Documentation

◆ m_AppliedLoad

OdDAIObjectId OdIfc4x2::IfcStructuralActivity::m_AppliedLoad
protected

Definition at line 299 of file Ifc4x2/IfcStructuralActivityAutoImpl.h.

◆ m_GlobalOrLocal

OdDAI::Enum OdIfc4x2::IfcStructuralActivity::m_GlobalOrLocal
protected

Definition at line 300 of file Ifc4x2/IfcStructuralActivityAutoImpl.h.


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