#include <IfcStructuralActionAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcStructuralAction:

Public Member Functions
OdDAI::Boolean	getDestabilizingLoad () const

void	setDestabilizingLoad (OdDAI::Boolean DestabilizingLoad)

const OdDAIObjectId &	getCausedBy () const

void	setCausedBy (const OdDAIObjectId &CausedBy)

virtual OdResult	inFields (OdDAI::OdSpfFilerBase *rdFiler) override

virtual OdResult	outFields (OdDAI::OdSpfFilerBase *wrFiler) override

virtual void	setInverseCounterParts () override

virtual OdDAI::Entity *	getInstanceType () const override

virtual OdRxValue	getAttr (const char *attrName) const override

virtual bool	comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) 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 OdIfc2x3::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 OdIfc2x3::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 OdIfc2x3::IfcObject
const OdAnsiString &	getObjectType () const

void	setObjectType (const OdAnsiString &ObjectType)

void	getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const

	IfcObject ()

Public Member Functions inherited from OdIfc2x3::IfcObjectDefinition
void	getInvHasAssignments (OdDAIObjectIds &HasAssignments) const

void	getInvIsDecomposedBy (OdDAIObjectIds &IsDecomposedBy) const

void	getInvDecomposes (OdDAIObjectIds &Decomposes) const

void	getInvHasAssociations (OdDAIObjectIds &HasAssociations) const

Public Member Functions inherited from OdIfc2x3::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 OdIfc2x3::OdIfc2x3Instance
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 OdGsCache *	gsNode () const

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *traits) const

virtual bool	subWorldDraw (OdGiWorldDraw *wd) const

virtual OdDbStub *	ownerId () const

Protected Attributes
OdDAI::Boolean	m_DestabilizingLoad

OdDAIObjectId	m_CausedBy

Protected Attributes inherited from OdIfc2x3::IfcStructuralActivity
OdDAIObjectId	m_AppliedLoad

OdDAI::Enum	m_GlobalOrLocal

Protected Attributes inherited from OdIfc2x3::IfcProduct
OdDAIObjectId	m_ObjectPlacement

OdDAIObjectId	m_Representation

Protected Attributes inherited from OdIfc2x3::IfcObject
OdAnsiString	m_ObjectType

Protected Attributes inherited from OdIfc2x3::IfcRoot
OdDAI::CompressedGUID	m_GlobalId

OdDAIObjectId	m_OwnerHistory

OdAnsiString	m_Name

OdAnsiString	m_Description

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

Additional Inherited Members
Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3d *	asPoint3d (const OdIfcInstance *inst)

static const OdGePoint2d *	asPoint2d (const OdIfcInstance *inst)

static const OdGeVector3d *	asVector3d (const OdIfcInstance *inst)

static const OdGeVector2d *	asVector2d (const OdIfcInstance *inst)

static const OdGeMatrix2d *	asMatrix2d (const OdIfcInstance *inst)

static const OdGeMatrix3d *	asMatrix3d (const OdIfcInstance *inst)

static OdIfcCompoundPtr	asCompound (OdSmartPtr< OdIfcInstance > inst)

static const OdCmEntityColor *	asRgbColor (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 Ifc2x3/IfcStructuralActionAutoImpl.h.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc2x3::IfcStructuralAction::comparedToEarlyImpl	(	const OdDAI::ApplicationInstance *	pOther,
		OdRx::Ordering &	ordering ) const

overridevirtual

Early-bound version of instances comparison.

Parameters

pOther	[in] Other application instance.
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:

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.

Reimplemented from OdIfc2x3::IfcStructuralActivity.

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

◆ getAttr() [1/2]

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

Reimplemented in OdIfc2x3::IfcStructuralLinearAction, OdIfc2x3::IfcStructuralLinearActionVarying, OdIfc2x3::IfcStructuralPlanarAction, and OdIfc2x3::IfcStructuralPlanarActionVarying.

◆ getAttr() [2/2]

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

Reimplemented in OdIfc2x3::IfcStructuralLinearAction, OdIfc2x3::IfcStructuralLinearActionVarying, OdIfc2x3::IfcStructuralPlanarAction, and OdIfc2x3::IfcStructuralPlanarActionVarying.

◆ getCausedBy()

const OdDAIObjectId & OdIfc2x3::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 OdIfc2x3::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 * OdIfc2x3::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 OdIfc2x3::IfcStructuralActivity.

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

◆ inFields()

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

Reimplemented in OdIfc2x3::IfcStructuralLinearAction, OdIfc2x3::IfcStructuralLinearActionVarying, OdIfc2x3::IfcStructuralPlanarAction, and OdIfc2x3::IfcStructuralPlanarActionVarying.

◆ isKindOf()

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

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

◆ outFields()

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

Reimplemented in OdIfc2x3::IfcStructuralLinearAction, OdIfc2x3::IfcStructuralLinearActionVarying, OdIfc2x3::IfcStructuralPlanarAction, and OdIfc2x3::IfcStructuralPlanarActionVarying.

◆ putAttr() [1/2]

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

Reimplemented in OdIfc2x3::IfcStructuralLinearAction, OdIfc2x3::IfcStructuralLinearActionVarying, OdIfc2x3::IfcStructuralPlanarAction, and OdIfc2x3::IfcStructuralPlanarActionVarying.

◆ putAttr() [2/2]

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

Reimplemented in OdIfc2x3::IfcStructuralLinearAction, OdIfc2x3::IfcStructuralLinearActionVarying, OdIfc2x3::IfcStructuralPlanarAction, and OdIfc2x3::IfcStructuralPlanarActionVarying.

◆ setCausedBy()

void OdIfc2x3::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 OdIfc2x3::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.

◆ setInverseCounterParts()

virtual void OdIfc2x3::IfcStructuralAction::setInverseCounterParts ( )

overridevirtual

Sets the object ID of this instance to inverse attributes of related instances according to schema specification of inverse attributes.

Reimplemented from OdIfc2x3::IfcProduct.

◆ testAttr() [1/2]

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

Reimplemented in OdIfc2x3::IfcStructuralLinearAction, OdIfc2x3::IfcStructuralLinearActionVarying, OdIfc2x3::IfcStructuralPlanarAction, and OdIfc2x3::IfcStructuralPlanarActionVarying.

◆ testAttr() [2/2]

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

Reimplemented in OdIfc2x3::IfcStructuralLinearAction, OdIfc2x3::IfcStructuralLinearActionVarying, OdIfc2x3::IfcStructuralPlanarAction, and OdIfc2x3::IfcStructuralPlanarActionVarying.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::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 OdIfc2x3::IfcStructuralActivity.

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