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

#include <IfcRelInteractionRequirementsAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcRelInteractionRequirements:
OdIfc2x3::IfcRelConnects OdIfc2x3::IfcRelationship OdIfc2x3::IfcRoot OdIfc2x3::OdIfc2x3Instance OdIfc::OdIfcInstance

Public Member Functions

OdDAI::Number getDailyInteraction () const
 
void setDailyInteraction (OdDAI::Number DailyInteraction)
 
double getImportanceRating () const
 
void setImportanceRating (double ImportanceRating)
 
const OdDAIObjectId & getLocationOfInteraction () const
 
void setLocationOfInteraction (const OdDAIObjectId &LocationOfInteraction)
 
const OdDAIObjectId & getRelatedSpaceProgram () const
 
void setRelatedSpaceProgram (const OdDAIObjectId &RelatedSpaceProgram)
 
const OdDAIObjectId & getRelatingSpaceProgram () const
 
void setRelatingSpaceProgram (const OdDAIObjectId &RelatingSpaceProgram)
 
 IfcRelInteractionRequirements ()
 
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::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::Number m_DailyInteraction
 
IfcNormalisedRatioMeasure m_ImportanceRating
 
OdDAIObjectId m_LocationOfInteraction
 
OdDAIObjectId m_RelatedSpaceProgram
 
OdDAIObjectId m_RelatingSpaceProgram
 
- 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
 

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 interaction requirement (IfcRelInteractionRequirements) is provided as a relationship that defines the requirements for the interaction (adjacency) of two spaces in the architectural program. Also, this relationship can define the interaction between two parties, such as persons, departments, organizations, that are associated to the space programs (interaction relations between workstations, workstation groups, floor blocks, or spaces, are defined through their associated space programs).

The interaction requirement is encoded as an normalized ratio measure between 0 and 1.

Definition at line 48 of file Ifc2x3/IfcRelInteractionRequirementsAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcRelInteractionRequirements()

OdIfc2x3::IfcRelInteractionRequirements::IfcRelInteractionRequirements ( )

Default constructor for the IfcRelInteractionRequirements class.

Member Function Documentation

◆ comparedToEarlyImpl()

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

◆ getAttr() [1/2]

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

◆ getAttr() [2/2]

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

◆ getDailyInteraction()

OdDAI::Number OdIfc2x3::IfcRelInteractionRequirements::getDailyInteraction ( ) const

Returns the value of DailyInteraction attribute. This attribute represents the number of interactions occurring on a daily basis.

Returns
Returns the value of DailyInteraction attribute.

◆ getImportanceRating()

double OdIfc2x3::IfcRelInteractionRequirements::getImportanceRating ( ) const

Returns the value of ImportanceRating attribute. This attribute represents the level of importance of interaction. 0 represents the lowest importance, 1 represents the highest importance.

Returns
Returns the value of ImportanceRating attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcRelInteractionRequirements::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::IfcRelConnects.

◆ getLocationOfInteraction()

const OdDAIObjectId & OdIfc2x3::IfcRelInteractionRequirements::getLocationOfInteraction ( ) const

Returns the value of LocationOfInteraction attribute. This attribute represents the location where this interaction happens.

Returns
Returns the value of LocationOfInteraction attribute.

◆ getRelatedSpaceProgram()

const OdDAIObjectId & OdIfc2x3::IfcRelInteractionRequirements::getRelatedSpaceProgram ( ) const

Returns the value of RelatedSpaceProgram attribute. This attribute represents the related space program for the interaction requirement.

Returns
Returns the value of RelatedSpaceProgram attribute.

◆ getRelatingSpaceProgram()

const OdDAIObjectId & OdIfc2x3::IfcRelInteractionRequirements::getRelatingSpaceProgram ( ) const

Returns the value of RelatingSpaceProgram attribute. This attribute represents the relating space program for the interaction requirement.

Returns
Returns the value of RelatingSpaceProgram attribute.

◆ inFields()

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

◆ isKindOf()

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

◆ outFields()

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

◆ putAttr() [1/2]

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

◆ putAttr() [2/2]

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

◆ setDailyInteraction()

void OdIfc2x3::IfcRelInteractionRequirements::setDailyInteraction ( OdDAI::Number DailyInteraction)

Sets the value of DailyInteraction attribute. This attribute represents the number of interactions occurring on a daily basis.

Parameters
DailyInteraction[in] DailyInteraction attribute to set.

◆ setImportanceRating()

void OdIfc2x3::IfcRelInteractionRequirements::setImportanceRating ( double ImportanceRating)

Sets the value of ImportanceRating attribute. This attribute represents the level of importance of interaction. 0 represents the lowest importance, 1 represents the highest importance.

Parameters
ImportanceRating[in] ImportanceRating attribute to set.

◆ setInverseCounterParts()

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

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

◆ setLocationOfInteraction()

void OdIfc2x3::IfcRelInteractionRequirements::setLocationOfInteraction ( const OdDAIObjectId & LocationOfInteraction)

Sets the value of LocationOfInteraction attribute. This attribute represents the location where this interaction happens.

Parameters
LocationOfInteraction[in] LocationOfInteraction attribute to set.

◆ setRelatedSpaceProgram()

void OdIfc2x3::IfcRelInteractionRequirements::setRelatedSpaceProgram ( const OdDAIObjectId & RelatedSpaceProgram)

Sets the value of RelatedSpaceProgram attribute. This attribute represents the related space program for the interaction requirement.

Parameters
RelatedSpaceProgram[in] RelatedSpaceProgram attribute to set.

◆ setRelatingSpaceProgram()

void OdIfc2x3::IfcRelInteractionRequirements::setRelatingSpaceProgram ( const OdDAIObjectId & RelatingSpaceProgram)

Sets the value of RelatingSpaceProgram attribute. This attribute represents the relating space program for the interaction requirement.

Parameters
RelatingSpaceProgram[in] RelatingSpaceProgram attribute to set.

◆ testAttr() [1/2]

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

◆ testAttr() [2/2]

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

◆ type()

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

◆ unsetAttr() [1/2]

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

◆ unsetAttr() [2/2]

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

Member Data Documentation

◆ m_DailyInteraction

OdDAI::Number OdIfc2x3::IfcRelInteractionRequirements::m_DailyInteraction
protected

◆ m_ImportanceRating

IfcNormalisedRatioMeasure OdIfc2x3::IfcRelInteractionRequirements::m_ImportanceRating
protected

◆ m_LocationOfInteraction

OdDAIObjectId OdIfc2x3::IfcRelInteractionRequirements::m_LocationOfInteraction
protected

◆ m_RelatedSpaceProgram

OdDAIObjectId OdIfc2x3::IfcRelInteractionRequirements::m_RelatedSpaceProgram
protected

◆ m_RelatingSpaceProgram

OdDAIObjectId OdIfc2x3::IfcRelInteractionRequirements::m_RelatingSpaceProgram
protected

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