CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4x4::IfcStructuralAnalysisModel Class Reference

#include <IfcStructuralAnalysisModelAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcStructuralAnalysisModel:
OdIfc4x4::IfcSystem OdIfc4x4::IfcGroup OdIfc4x4::IfcObject OdIfc4x4::IfcObjectDefinition OdIfc4x4::IfcRoot OdIfc4x4::OdIFC4X4Instance OdIfc::OdIfcInstance

Public Member Functions

IfcAnalysisModelTypeEnum getPredefinedType () const
 
void setPredefinedType (IfcAnalysisModelTypeEnum PredefinedType)
 
const OdDAIObjectId & getOrientationOf2DPlane () const
 
void setOrientationOf2DPlane (const OdDAIObjectId &OrientationOf2DPlane)
 
void getLoadedBy (OdDAIObjectIds &LoadedBy) const
 
OdDAI::SetOfOdDAIObjectId & loadedBy ()
 
void getHasResults (OdDAIObjectIds &HasResults) const
 
OdDAI::SetOfOdDAIObjectId & hasResults ()
 
const OdDAIObjectId & getSharedPlacement () const
 
void setSharedPlacement (const OdDAIObjectId &SharedPlacement)
 
 IfcStructuralAnalysisModel ()
 
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 OdIfc4x4::IfcSystem
void getInvServicesBuildings (OdDAIObjectIds &ServicesBuildings) const
 
void getInvServicesFacilities (OdDAIObjectIds &ServicesFacilities) const
 
- Public Member Functions inherited from OdIfc4x4::IfcGroup
void getInvIsGroupedBy (OdDAIObjectIds &IsGroupedBy) const
 
void getInvReferencedInStructures (OdDAIObjectIds &ReferencedInStructures) const
 
- Public Member Functions inherited from OdIfc4x4::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 OdIfc4x4::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 OdIfc4x4::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 OdIfc4x4::OdIFC4X4Instance
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

OdDAI::Enum m_PredefinedType
 
OdDAIObjectId m_OrientationOf2DPlane
 
OdDAI::SetOfOdDAIObjectId m_LoadedBy
 
OdDAI::SetOfOdDAIObjectId m_HasResults
 
OdDAIObjectId m_SharedPlacement
 
- Protected Attributes inherited from OdIfc4x4::IfcObject
OdAnsiString m_ObjectType
 
- Protected Attributes inherited from OdIfc4x4::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)
 
- Protected Member Functions inherited from OdIfc4x4::IfcSystem
virtual OdRxValue getAttr (const char *attrName) const override
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val) override
 

Detailed Description

The IfcStructuralAnalysisModel is used to assemble all information needed to represent a structural analysis model. It encompasses certain general properties (such as analysis type), references to all contained structural members, structural supports or connections, as well as loads and the respective load results.

Important functionalities for the description of an analysis model are derived from existing IFC entities: From IfcSystem it inherits the ability to couple the built system via IfcRelReferencedInSpatialStructure to one or more IfcSpatialElement subtypes as necessary. From IfcGroup it inherits the inverse attribute IsGroupedBy, pointing to the relationship class IfcRelAssignsToGroup. This allows the grouping of structural members (instances of IfcStructuralMember), and supports (instances of IfcStructuralConnection which belong to a specific analysis model. From IfcObjectDefinition it inherits the inverse attribute IsDecomposedBy pointing to the relationship class IfcRelAggregates. It provides the hierarchy between the separate (partial) analysis models.

Definition at line 51 of file IFC4X4/IfcStructuralAnalysisModelAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcStructuralAnalysisModel()

OdIfc4x4::IfcStructuralAnalysisModel::IfcStructuralAnalysisModel ( )

Default constructor for the IfcStructuralAnalysisModel class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x4::IfcStructuralAnalysisModel::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 OdIfc4x4::IfcSystem.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x4::IfcStructuralAnalysisModel::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 OdIfc4x4::IfcGroup.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x4::IfcStructuralAnalysisModel::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 OdIfc4x4::IfcSystem.

◆ getHasResults()

void OdIfc4x4::IfcStructuralAnalysisModel::getHasResults ( OdDAIObjectIds & HasResults) const

Gets the value of HasResults attribute. This attribute represents references to all result groups available for this structural analysis model.

Parameters
HasResults[out] Receives the HasResults attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcStructuralAnalysisModel::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 OdIfc4x4::IfcSystem.

◆ getLoadedBy()

void OdIfc4x4::IfcStructuralAnalysisModel::getLoadedBy ( OdDAIObjectIds & LoadedBy) const

Sets the value of LoadedBy attribute. This attribute represents references to all load groups to be analyzed.

Parameters
LoadedBy[out] Receives the LoadedBy attribute.

◆ getOrientationOf2DPlane()

const OdDAIObjectId & OdIfc4x4::IfcStructuralAnalysisModel::getOrientationOf2DPlane ( ) const

Returns the value of OrientationOf2DPlane attribute. This attribute defines the upright direction to the focused plane (z-axes) if the selected model type (PredefinedType) describes a 2D system.

Returns
Returns the value of OrientationOf2DPlane attribute.
Remarks
This attribute is needed because all data for the structural analysis model (structural members, structural activities) are defined by using 3D space. The orientation is given in relation to the coordinate system of the project. With 3D systems this value is not asserted.

◆ getPredefinedType()

IfcAnalysisModelTypeEnum OdIfc4x4::IfcStructuralAnalysisModel::getPredefinedType ( ) const

Returns the value of PredefinedType attribute. This attribute represents a type of the structural analysis model.

Returns
Returns the value of PredefinedType attribute.

◆ getSharedPlacement()

const OdDAIObjectId & OdIfc4x4::IfcStructuralAnalysisModel::getSharedPlacement ( ) const

Returns the value of SharedPlacement attribute. This attribute allows easy retrieval of the common object placement.

Returns
Returns the value of SharedPlacement attribute.

◆ hasResults()

OdDAI::SetOfOdDAIObjectId & OdIfc4x4::IfcStructuralAnalysisModel::hasResults ( )

Returns the value of HasResults attribute. This attribute represents references to all result groups available for this structural analysis model.

Returns
Returns the value of HasResults attribute.

◆ inFields()

virtual OdResult OdIfc4x4::IfcStructuralAnalysisModel::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 OdIfc4x4::IfcSystem.

◆ isKindOf()

virtual bool OdIfc4x4::IfcStructuralAnalysisModel::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 OdIfc4x4::IfcSystem.

◆ loadedBy()

OdDAI::SetOfOdDAIObjectId & OdIfc4x4::IfcStructuralAnalysisModel::loadedBy ( )

Returns the value of LoadedBy attribute. This attribute represents references to all load groups to be analyzed.

Returns
Returns the value of LoadedBy attribute.

◆ outFields()

virtual OdResult OdIfc4x4::IfcStructuralAnalysisModel::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 OdIfc4x4::IfcSystem.

◆ putAttr() [1/2]

virtual bool OdIfc4x4::IfcStructuralAnalysisModel::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 OdIfc4x4::IfcGroup.

◆ putAttr() [2/2]

virtual bool OdIfc4x4::IfcStructuralAnalysisModel::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 OdIfc4x4::IfcSystem.

◆ setInverseCounterParts()

virtual void OdIfc4x4::IfcStructuralAnalysisModel::setInverseCounterParts ( )
overridevirtual

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

◆ setOrientationOf2DPlane()

void OdIfc4x4::IfcStructuralAnalysisModel::setOrientationOf2DPlane ( const OdDAIObjectId & OrientationOf2DPlane)

Sets the value of OrientationOf2DPlane attribute. This attribute defines the upright direction to the focused plane (z-axes) if the selected model type (PredefinedType) describes a 2D system.

Parameters
OrientationOf2DPlane[in] Orientation of 2D plane to set.
Remarks
This attribute is needed because all data for the structural analysis model (structural members, structural activities) are defined by using 3D space. The orientation is given in relation to the coordinate system of the project. With 3D systems this value is not asserted.

◆ setPredefinedType()

void OdIfc4x4::IfcStructuralAnalysisModel::setPredefinedType ( IfcAnalysisModelTypeEnum PredefinedType)

Sets the value of PredefinedType attribute. This attribute represents a type of the structural analysis model.

Parameters
PredefinedType[in] Predefined type to set.

◆ setSharedPlacement()

void OdIfc4x4::IfcStructuralAnalysisModel::setSharedPlacement ( const OdDAIObjectId & SharedPlacement)

Sets the value of SharedPlacement attribute. This attribute allows easy retrieval of the common object placement.

Parameters
SharedPlacement[in] Shared placement to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x4::IfcStructuralAnalysisModel::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 OdIfc4x4::IfcSystem.

◆ testAttr() [2/2]

virtual bool OdIfc4x4::IfcStructuralAnalysisModel::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 OdIfc4x4::IfcSystem.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x4::IfcStructuralAnalysisModel::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 OdIfc4x4::IfcSystem.

◆ unsetAttr() [1/2]

virtual void OdIfc4x4::IfcStructuralAnalysisModel::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc4x4::IfcSystem.

◆ unsetAttr() [2/2]

virtual void OdIfc4x4::IfcStructuralAnalysisModel::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 OdIfc4x4::IfcSystem.

Member Data Documentation

◆ m_HasResults

OdDAI::SetOfOdDAIObjectId OdIfc4x4::IfcStructuralAnalysisModel::m_HasResults
protected

Definition at line 284 of file IFC4X4/IfcStructuralAnalysisModelAutoImpl.h.

◆ m_LoadedBy

OdDAI::SetOfOdDAIObjectId OdIfc4x4::IfcStructuralAnalysisModel::m_LoadedBy
protected

Definition at line 282 of file IFC4X4/IfcStructuralAnalysisModelAutoImpl.h.

◆ m_OrientationOf2DPlane

OdDAIObjectId OdIfc4x4::IfcStructuralAnalysisModel::m_OrientationOf2DPlane
protected

Definition at line 281 of file IFC4X4/IfcStructuralAnalysisModelAutoImpl.h.

◆ m_PredefinedType

OdDAI::Enum OdIfc4x4::IfcStructuralAnalysisModel::m_PredefinedType
protected

Definition at line 280 of file IFC4X4/IfcStructuralAnalysisModelAutoImpl.h.

◆ m_SharedPlacement

OdDAIObjectId OdIfc4x4::IfcStructuralAnalysisModel::m_SharedPlacement
protected

Definition at line 286 of file IFC4X4/IfcStructuralAnalysisModelAutoImpl.h.


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