#include <IfcStructuralLoadGroupAutoImpl.h>

Inheritance diagram for OdIfc4::IfcStructuralLoadGroup:

Public Member Functions
IfcLoadGroupTypeEnum	getPredefinedType () const

void	setPredefinedType (IfcLoadGroupTypeEnum PredefinedType)

IfcActionTypeEnum	getActionType () const

void	setActionType (IfcActionTypeEnum ActionType)

IfcActionSourceTypeEnum	getActionSource () const

void	setActionSource (IfcActionSourceTypeEnum ActionSource)

double	getCoefficient () const

void	setCoefficient (double Coefficient)

const OdAnsiString &	getPurpose () const

void	setPurpose (const OdAnsiString &Purpose)

void	getInvSourceOfResultGroup (OdDAIObjectIds &SourceOfResultGroup) const

void	getInvLoadGroupFor (OdDAIObjectIds &LoadGroupFor) const

	IfcStructuralLoadGroup ()

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 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 OdIfc4::IfcGroup
void	getInvIsGroupedBy (OdDAIObjectIds &IsGroupedBy) const

Public Member Functions inherited from OdIfc4::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 OdIfc4::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 OdIfc4::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 OdIfc4::OdIfc4Instance
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::Enum	m_PredefinedType

OdDAI::Enum	m_ActionType

OdDAI::Enum	m_ActionSource

double	m_Coefficient

OdAnsiString	m_Purpose

Protected Attributes inherited from OdIfc4::IfcObject
OdAnsiString	m_ObjectType

Protected Attributes inherited from OdIfc4::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

Friends
class	IfcStructuralResultGroup

class	IfcStructuralAnalysisModel

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

The entity IfcStructuralLoadGroup is used to structure the physical impacts. By using the grouping features inherited from IfcGroup, instances of IfcStructuralAction (or its subclasses) and of IfcStructuralLoadGroup can be used to define load groups, load cases and load combinations. (See also IfcLoadGroupTypeEnum.)

\changes

IFC4 changes: Subtype IfcStructuralLoadCase added. Informal propositions and WHERE rule added. Predefined type LOAD_COMBINATION_GROUP made obsolete and removed.

Definition at line 48 of file Ifc4/IfcStructuralLoadGroupAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcStructuralLoadGroup()

OdIfc4::IfcStructuralLoadGroup::IfcStructuralLoadGroup ( )

Default constructor for the IfcStructuralLoadGroup class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4::IfcStructuralLoadGroup::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 OdIfc4::IfcGroup.

Reimplemented in OdIfc4::IfcStructuralLoadCase.

◆ getActionSource()

IfcActionSourceTypeEnum OdIfc4::IfcStructuralLoadGroup::getActionSource ( ) const

Returns the value of ActionSource attribute. This attribute represents source of actions in the group. Normally needed if 'PredefinedType' specifies a LOAD_CASE.

Returns: Returns the value of ActionSource attribute.

◆ getActionType()

IfcActionTypeEnum OdIfc4::IfcStructuralLoadGroup::getActionType ( ) const

Returns the value of ActionType attribute. This attribute represents type of actions in the group. Normally needed if 'PredefinedType' specifies a LOAD_CASE.

Returns: Returns the value of ActionType attribute.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4::IfcStructuralLoadGroup::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 OdIfc4::IfcGroup.

Reimplemented in OdIfc4::IfcStructuralLoadCase.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4::IfcStructuralLoadGroup::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 OdIfc4::IfcGroup.

Reimplemented in OdIfc4::IfcStructuralLoadCase.

◆ getCoefficient()

double OdIfc4::IfcStructuralLoadGroup::getCoefficient ( ) const

Returns the value of Coefficient attribute. This attribute represents load factor. If omitted, a factor is not yet known or not specified. A load factor of 1.0 shall be explicitly exported as Coefficient = 1.0.

Returns: Returns the value of Coefficient attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcStructuralLoadGroup::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 OdIfc4::IfcGroup.

Reimplemented in OdIfc4::IfcStructuralLoadCase.

◆ getInvLoadGroupFor()

void OdIfc4::IfcStructuralLoadGroup::getInvLoadGroupFor ( OdDAIObjectIds & LoadGroupFor ) const

Returns the value of LoadGroupFor attribute. This attribute represents analysis models in which this load group is used.

Parameters

LoadGroupFor [out] Receives the value of LoadGroupFor attribute.

◆ getInvSourceOfResultGroup()

void OdIfc4::IfcStructuralLoadGroup::getInvSourceOfResultGroup ( OdDAIObjectIds & SourceOfResultGroup ) const

Returns the value of SourceOfResultGroup attribute. This attribute represents results which were computed using this load group.

Parameters

SourceOfResultGroup [out] Receives the value of SourceOfResultGroup attribute.

◆ getPredefinedType()

IfcLoadGroupTypeEnum OdIfc4::IfcStructuralLoadGroup::getPredefinedType ( ) const

Returns the value of PredefinedType attribute. This attribute represents selects a predefined type for the load group. It can be differentiated between load groups, load cases, load combinations, or user-defined grouping levels.

Returns: Returns the value of PredefinedType attribute.

◆ getPurpose()

const OdAnsiString & OdIfc4::IfcStructuralLoadGroup::getPurpose ( ) const

Returns the value of Purpose attribute. This attribute represents description of the purpose of this instance. Among else, possible values of the Purpose of load combinations are 'SLS', 'ULS', 'ALS' to indicate serviceability, ultimate, or accidental limit state.

Returns: Returns the value of Purpose attribute.

◆ inFields()

virtual OdResult OdIfc4::IfcStructuralLoadGroup::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 OdIfc4::IfcGroup.

Reimplemented in OdIfc4::IfcStructuralLoadCase.

◆ isKindOf()

virtual bool OdIfc4::IfcStructuralLoadGroup::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 OdIfc4::IfcGroup.

Reimplemented in OdIfc4::IfcStructuralLoadCase.

◆ outFields()

virtual OdResult OdIfc4::IfcStructuralLoadGroup::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 OdIfc4::IfcGroup.

Reimplemented in OdIfc4::IfcStructuralLoadCase.

◆ putAttr() [1/2]

virtual bool OdIfc4::IfcStructuralLoadGroup::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 OdIfc4::IfcGroup.

Reimplemented in OdIfc4::IfcStructuralLoadCase.

◆ putAttr() [2/2]

virtual bool OdIfc4::IfcStructuralLoadGroup::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 OdIfc4::IfcGroup.

Reimplemented in OdIfc4::IfcStructuralLoadCase.

◆ setActionSource()

void OdIfc4::IfcStructuralLoadGroup::setActionSource ( IfcActionSourceTypeEnum ActionSource )

Sets the value of ActionSource attribute. This attribute represents source of actions in the group. Normally needed if 'PredefinedType' specifies a LOAD_CASE.

Parameters

ActionSource [in] Action source to set.

◆ setActionType()

void OdIfc4::IfcStructuralLoadGroup::setActionType ( IfcActionTypeEnum ActionType )

Sets the value of ActionType attribute. This attribute represents type of actions in the group. Normally needed if 'PredefinedType' specifies a LOAD_CASE.

Parameters

ActionType [in] Action type to set.

◆ setCoefficient()

void OdIfc4::IfcStructuralLoadGroup::setCoefficient ( double Coefficient )

Sets the value of Coefficient attribute. This attribute represents load factor. If omitted, a factor is not yet known or not specified. A load factor of 1.0 shall be explicitly exported as Coefficient = 1.0.

Parameters

Coefficient [in] Coefficient to set.

◆ setPredefinedType()

void OdIfc4::IfcStructuralLoadGroup::setPredefinedType ( IfcLoadGroupTypeEnum PredefinedType )

Sets the value of PredefinedType attribute. This attribute represents selects a predefined type for the load group. It can be differentiated between load groups, load cases, load combinations, or user-defined grouping levels.

Parameters

PredefinedType [in] Predefined type to set.

◆ setPurpose()

void OdIfc4::IfcStructuralLoadGroup::setPurpose ( const OdAnsiString & Purpose )

Sets the value of Purpose attribute. This attribute represents description of the purpose of this instance. Among else, possible values of the Purpose of load combinations are 'SLS', 'ULS', 'ALS' to indicate serviceability, ultimate, or accidental limit state.

Parameters

Purpose [in] Purpose to set.

◆ testAttr() [1/2]

virtual bool OdIfc4::IfcStructuralLoadGroup::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 OdIfc4::IfcGroup.

Reimplemented in OdIfc4::IfcStructuralLoadCase.

◆ testAttr() [2/2]

virtual bool OdIfc4::IfcStructuralLoadGroup::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 OdIfc4::IfcGroup.

Reimplemented in OdIfc4::IfcStructuralLoadCase.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcStructuralLoadGroup::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 OdIfc4::IfcGroup.

Reimplemented in OdIfc4::IfcStructuralLoadCase.

◆ unsetAttr() [1/2]

virtual void OdIfc4::IfcStructuralLoadGroup::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc4::IfcGroup.

Reimplemented in OdIfc4::IfcStructuralLoadCase.

◆ unsetAttr() [2/2]

virtual void OdIfc4::IfcStructuralLoadGroup::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 OdIfc4::IfcGroup.

Reimplemented in OdIfc4::IfcStructuralLoadCase.

Friends And Related Symbol Documentation

◆ IfcStructuralAnalysisModel

friend class IfcStructuralAnalysisModel

friend

Definition at line 300 of file Ifc4/IfcStructuralLoadGroupAutoImpl.h.

◆ IfcStructuralResultGroup

friend class IfcStructuralResultGroup

friend

Definition at line 299 of file Ifc4/IfcStructuralLoadGroupAutoImpl.h.

Member Data Documentation

◆ m_ActionSource

OdDAI::Enum OdIfc4::IfcStructuralLoadGroup::m_ActionSource

protected

Definition at line 294 of file Ifc4/IfcStructuralLoadGroupAutoImpl.h.

◆ m_ActionType

OdDAI::Enum OdIfc4::IfcStructuralLoadGroup::m_ActionType

protected

Definition at line 293 of file Ifc4/IfcStructuralLoadGroupAutoImpl.h.

◆ m_Coefficient

double OdIfc4::IfcStructuralLoadGroup::m_Coefficient

protected

Definition at line 295 of file Ifc4/IfcStructuralLoadGroupAutoImpl.h.

◆ m_PredefinedType

OdDAI::Enum OdIfc4::IfcStructuralLoadGroup::m_PredefinedType

protected

Definition at line 292 of file Ifc4/IfcStructuralLoadGroupAutoImpl.h.

◆ m_Purpose

OdAnsiString OdIfc4::IfcStructuralLoadGroup::m_Purpose

protected

Definition at line 296 of file Ifc4/IfcStructuralLoadGroupAutoImpl.h.

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

Ifc4/IfcStructuralLoadGroupAutoImpl.h

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcStructuralLoadGroup()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getActionSource()

◆ getActionType()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getCoefficient()

◆ getInstanceType()

◆ getInvLoadGroupFor()

◆ getInvSourceOfResultGroup()

◆ getPredefinedType()

◆ getPurpose()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setActionSource()

◆ setActionType()

◆ setCoefficient()

◆ setPredefinedType()

◆ setPurpose()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Friends And Related Symbol Documentation

◆ IfcStructuralAnalysisModel

◆ IfcStructuralResultGroup

Member Data Documentation

◆ m_ActionSource

◆ m_ActionType

◆ m_Coefficient

◆ m_PredefinedType

◆ m_Purpose