CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc2x3::IfcStructuralResultGroup Class Reference

#include <IfcStructuralResultGroupAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcStructuralResultGroup:
OdIfc2x3::IfcGroup OdIfc2x3::IfcObject OdIfc2x3::IfcObjectDefinition OdIfc2x3::IfcRoot OdIfc2x3::OdIfc2x3Instance OdIfc::OdIfcInstance

Public Member Functions

IfcAnalysisTheoryTypeEnum getTheoryType () const
 
void setTheoryType (IfcAnalysisTheoryTypeEnum TheoryType)
 
const OdDAIObjectId & getResultForLoadGroup () const
 
void setResultForLoadGroup (const OdDAIObjectId &ResultForLoadGroup)
 
OdDAI::Boolean getIsLinear () const
 
void setIsLinear (OdDAI::Boolean IsLinear)
 
void getInvResultGroupFor (OdDAIObjectIds &ResultGroupFor) const
 
 IfcStructuralResultGroup ()
 
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::IfcGroup
OdDAIObjectId getInvIsGroupedBy () 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 OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Protected Attributes

OdDAI::Enum m_TheoryType
 
OdDAIObjectId m_ResultForLoadGroup
 
OdDAI::Boolean m_IsLinear
 
- 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
voidm_resPtr
 
IfcOpResult m_resolved
 

Friends

class IfcStructuralAnalysisModel
 

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

Instances of the entity IfcStructuralResultGroup are used to group results of structural analysis calculations and to capture the connection to the underlying basic load group. The basic functionality for grouping inherited from IfcGroup is used to collect instances from IfcStructuralReaction or its respective subclasses.

  • Group Assignment - The Group Assignment concept template applies to this entity as shown in the table below.
    IsGrouped

RelatedObjects Description Structural reactions of the result group.

Definition at line 51 of file Ifc2x3/IfcStructuralResultGroupAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcStructuralResultGroup()

OdIfc2x3::IfcStructuralResultGroup::IfcStructuralResultGroup ( )

Default constructor for the IfcStructuralResultGroup class.

Member Function Documentation

◆ comparedToEarlyImpl()

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

◆ getAttr() [1/2]

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

◆ getAttr() [2/2]

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

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcStructuralResultGroup::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::IfcGroup.

◆ getInvResultGroupFor()

void OdIfc2x3::IfcStructuralResultGroup::getInvResultGroupFor ( OdDAIObjectIds & ResultGroupFor) const

Returns the value of ResultGroupFor attribute. This attribute represents reference to an instance of IfcStructuralAnalysisModel for which this instance captures a result.

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

◆ getIsLinear()

OdDAI::Boolean OdIfc2x3::IfcStructuralResultGroup::getIsLinear ( ) const

Returns the value of IsLinear attribute. This attribute represents this value allows to easily recognize whether a linear analysis has been applied (allowing the superposition of analysis results).

Returns
Returns the value of IsLinear attribute.

◆ getResultForLoadGroup()

const OdDAIObjectId & OdIfc2x3::IfcStructuralResultGroup::getResultForLoadGroup ( ) const

Returns the value of ResultForLoadGroup attribute. This attribute represents reference to an instance of IfcStructuralLoadGroup for which this instance represents the result.

Returns
Returns the value of ResultForLoadGroup attribute.

◆ getTheoryType()

IfcAnalysisTheoryTypeEnum OdIfc2x3::IfcStructuralResultGroup::getTheoryType ( ) const

Returns the value of TheoryType attribute. This attribute represents specifies the analysis theory used to obtain the respective results.

Returns
Returns the value of TheoryType attribute.

◆ inFields()

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

◆ isKindOf()

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

◆ outFields()

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

◆ putAttr() [1/2]

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

◆ putAttr() [2/2]

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

◆ setInverseCounterParts()

virtual void OdIfc2x3::IfcStructuralResultGroup::setInverseCounterParts ( )
overridevirtual

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

◆ setIsLinear()

void OdIfc2x3::IfcStructuralResultGroup::setIsLinear ( OdDAI::Boolean IsLinear)

Sets the value of IsLinear attribute. This attribute represents this value allows to easily recognize whether a linear analysis has been applied (allowing the superposition of analysis results).

Parameters
IsLinear[in] IsLinear attribute to set.

◆ setResultForLoadGroup()

void OdIfc2x3::IfcStructuralResultGroup::setResultForLoadGroup ( const OdDAIObjectId & ResultForLoadGroup)

Sets the value of ResultForLoadGroup attribute. This attribute represents reference to an instance of IfcStructuralLoadGroup for which this instance represents the result.

Parameters
ResultForLoadGroup[in] Result for load group to set.

◆ setTheoryType()

void OdIfc2x3::IfcStructuralResultGroup::setTheoryType ( IfcAnalysisTheoryTypeEnum TheoryType)

Sets the value of TheoryType attribute. This attribute represents specifies the analysis theory used to obtain the respective results.

Parameters
TheoryType[in] Theory type to set.

◆ testAttr() [1/2]

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

◆ testAttr() [2/2]

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

◆ type()

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

◆ unsetAttr() [1/2]

virtual void OdIfc2x3::IfcStructuralResultGroup::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc2x3::IfcGroup.

◆ unsetAttr() [2/2]

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

Friends And Related Symbol Documentation

◆ IfcStructuralAnalysisModel

friend class IfcStructuralAnalysisModel
friend

Definition at line 259 of file Ifc2x3/IfcStructuralResultGroupAutoImpl.h.

Member Data Documentation

◆ m_IsLinear

OdDAI::Boolean OdIfc2x3::IfcStructuralResultGroup::m_IsLinear
protected

Definition at line 256 of file Ifc2x3/IfcStructuralResultGroupAutoImpl.h.

◆ m_ResultForLoadGroup

OdDAIObjectId OdIfc2x3::IfcStructuralResultGroup::m_ResultForLoadGroup
protected

Definition at line 255 of file Ifc2x3/IfcStructuralResultGroupAutoImpl.h.

◆ m_TheoryType

OdDAI::Enum OdIfc2x3::IfcStructuralResultGroup::m_TheoryType
protected

Definition at line 254 of file Ifc2x3/IfcStructuralResultGroupAutoImpl.h.


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