IfcRelContainedInSpatialStructure Class

Syntax

C++

class IfcRelContainedInSpatialStructure : public IfcRelConnects;

Description

This objectified relationship is used to assign elements to a certain level of the spatial project structure. Any element can only be assigned once to a certain level of the spatial structure. The question, which level is relevant for which type of element, can only be answered within the context of a particular project and might vary within the various regions.

EXAMPLE: A multi-storey space is contained (or belongs to) the building storey at which its ground level is, but it is referenced by all the other building storeys, in which it spans. A lift shaft might be contained by the basement, but referenced by all storeys, through which it spans.

The containment relationship of an element within a spatial structure has to be a hierarchical relationship; an element can only be contained within a single spatial structure element. The reference relationship between an element and the spatial structure need not be hierarchical; that is, an element can reference many spatial structure elements.

Predefined spatial structure elements to which elements can be assigned are

site as IfcSite
building as IfcBuilding
storey as IfcBuildingStorey
space as IfcSpace

Occurrences of the same element type can be assigned to different spatial structure elements depending on the context of the occurrence.

EXAMPLE: A wall might be normally assigned to a storey, however the curtain wall might be assigned to the building and the retaining wall in the terrain might be assigned to the site.

Example

The next picture shows the use of IfcRelContainedInSpatialStructure to assign a stair and two walls to two different levels within the spatial structure.

Remarks

The reference relationship is expressed by IfcRelReferencedInSpatialStructure.

changes

IFC2X_FINAL changes: The data type of the attribute RelatedElements has been changed from IfcElement to its supertype IfcProduct with upward compatibility for file-based exchange.
IFC4 changes: Type of the RelatingStructure attribute type changed from IfcSpatialStructureElement to IfcSpatialElement.

Class Hierarchy

File: IfcRelContainedInSpatialStructureAutoImpl.h

Namespace: OdIfc4x3_rc4

Methods

Show:Inherited

No members matching the current filter

ApplicationInstance	Creates a new application instance with default parameters. (Inherited from ApplicationInstance)
IfcRoot	Default constructor for the IfcRoot class. (Inherited from IfcRoot)
OdIfcInstance	Creates a new IFC instance object with default parameters. (Inherited from OdIfcInstance)
~OdIfcInstance	Destroys the instance object. (Inherited from OdIfcInstance)

Methods

Show:Inherited

No members matching the current filter

asCompound	Returns the result of the instance resolution represented as a compound object. (Inherited from OdIfcInstance)
asMatrix2d	Returns the result of the instance resolution represented as a two-dimensional matrix. (Inherited from OdIfcInstance)
asMatrix3d	Returns the result of the instance resolution represented as a three-dimensional vector. (Inherited from OdIfcInstance)
asPoint2d	Returns the result of the instance resolution represented as a two-dimensional point. (Inherited from OdIfcInstance)
asPoint3d	Returns the result of the instance resolution represented as a three-dimensional point. (Inherited from OdIfcInstance)
asRgbColor	Returns the result of the instance resolution represented as an RGB color object. (Inherited from OdIfcInstance)
asVector2d	Returns the result of the instance resolution represented as a two-dimensional vector. (Inherited from OdIfcInstance)
asVector3d	Returns the result of the instance resolution represented as a three-dimensional vector. (Inherited from OdIfcInstance)
cleanDynamicAttributes	Cleans dynamic attributes. (Inherited from ApplicationInstance)
comparedTo	Compares the application instance object with another object. (Inherited from ApplicationInstance)
comparedToEarlyImpl	Early-bound version of instances comparison. (Inherited from IfcRelConnects)
comparedToEarlyImpl	Early-bound version of instances comparison.
comparedToEarlyImpl	Early-bound version of instances comparison. (Inherited from IfcRelationship)
comparedToEarlyImpl	Early-bound version of instances comparison. (Inherited from IfcRoot)
comparedToInverse	Compares the application instance object with another object by comparing their inverse attributes. (Inherited from ApplicationInstance)
copyFrom	details Copies the contents of the specified object into this object. (Inherited from ApplicationInstance)
findDataTypes	Retrieves the Named/Defined data types of the entity instance according to the schema types hierarchy. (Inherited from ApplicationInstance)
findRolesOf	Retrieves the identifiers of the attributes of entity instances which refer to the current entity instance within the model. (Inherited from ApplicationInstance)
findUsedIn	Retrieves the identifiers of all entity instances in the model which refer to the entity instance through the specified attribute. (Inherited from ApplicationInstance)
findUsedInBN	Retrieves the identifiers of all the entity instances in the model which refer to the entity instance through the specified attribute name. (Inherited from ApplicationInstance)
findUsers	Retrieves the identifiers of all the entity instances in the model that refer to the current entity instance. (Inherited from ApplicationInstance)
getAttr	Retrieves the current value of an attribute specified by its name. (Inherited from ApplicationInstance)
getAttr	Retrieves the current value of the attribute specified by its name. (Inherited from OdDAIObjectSDAI)
getAttr	Retrieves the current value of an attribute specified by its definition. (Inherited from OdIfcInstance)
getAttr(const OdIfc::OdIfcAttribute)	This is the overview for the getAttr method overload.
getAttr(const OdIfc::OdIfcAttribute)	This is the overview for the getAttr method overload.
getAttrCaseInsensitive	Retrieves the current value of an attribute specified by its name in case-insensitive mode. (Inherited from OdDAIObjectSDAI)
getDerivedAttr	Calculates a value of a derived attribute specified by its name. (Inherited from ApplicationInstance)
getDescription	Returns the description of an object. (Inherited from IfcRoot)
getGlobalId	Returns a globally unique identifier within the entire software world. (Inherited from IfcRoot)
getInstanceType	Retrieves the type of the Standard Data Access Interface (SDAI) object. (Inherited from OdDAIObjectSDAI)
getInstanceType	Returns a type of a class instance. (Inherited from IfcRelConnects)
getInstanceType	Returns a type of a class instance.
getInstanceType	Returns a type of a class instance. (Inherited from IfcRelationship)
getInstanceType	Returns a type of a class instance. (Inherited from IfcRoot)
getInverseAttr	Retrieves the current value of an inverse attribute with a specified name. (Inherited from ApplicationInstance)
getName	Returns a name that is used by the participating software systems or users. (Inherited from IfcRoot)
getOwnerHistory	Returns the information about the current ownership of that object, including owning actor, application, local identification and information captured about the recent changes of the object. (Inherited from IfcRoot)
getRelatedElements	Returns the value of RelatedElements attribute. This attribute represents set of products which are contained within this level of the spatial structure hierarchy.
getRelatingStructure	Returns the value of RelatingStructure attribute. This attribute represents spatial structure element, within which the element is contained. Any element can only be contained within one element of the project spatial structure.
gsNode	Retrieves the current Gs node object of the entity. (Inherited from ApplicationInstance)
gsNode	Retrieves the current Gs node object of the Standard Data Access Interface (SDAI) object. (Inherited from OdDAIObjectSDAI)
gsNode	Retrieves the current Gs node object of the instance. (Inherited from OdIfcInstance)
id	Retrieves the database object identifier of the application instance. (Inherited from ApplicationInstance)
id	Retrieves the database object identifier of the Standard Data Access Interface (SDAI) object. (Inherited from OdDAIObjectSDAI)
inFields	Reads values of the instance's explicit attribute fields from a file buffer that is associated with a specified filer object. (Inherited from ApplicationInstance)
inFields	Reads object's data from the specified filer.
inFields	Reads object's data from the specified filer. (Inherited from IfcRoot)
isInstanceOf	Retrieves whether the instance is an instance of a specified type. (Inherited from OdIfcInstance)
isInstanceOf(const Entity *)	This is the overview for the isInstanceOf method overload.
isInstanceOf(const Entity *)	This is the overview for the isInstanceOf method overload.
isKindOf	Checks whether the specified instance is the object derived from or belongs to this class. (Inherited from IfcRelConnects)
isKindOf	Checks whether the specified instance is the object derived from or belongs to this class.
isKindOf	Checks whether the specified instance is the object derived from or belongs to this class. (Inherited from IfcRelationship)
isKindOf	Checks whether the specified instance is the object derived from or belongs to this class. (Inherited from IfcRoot)
isKindOf	Retrieves whether the instance belongs to a specified entity type. (Inherited from OdIfcInstance)
isKindOf(const Entity *)	This is the overview for the isKindOf method overload.
isKindOf(const Entity *)	This is the overview for the isKindOf method overload.
isPersistent	Retrieves whether the Standard Data Access Interface (SDAI) object is a persistent one. (Inherited from OdDAIObjectSDAI)
outFields	Writes values of the instance's explicit attribute fields to a file buffer that is assigned to a specified filer object. (Inherited from ApplicationInstance)
outFields	Writes object's data the the specified filer.
outFields	Writes object's data the the specified filer. (Inherited from IfcRoot)
owningModel	Retrieves the model that contains the application instance. (Inherited from ApplicationInstance)
owningModel	Retrieves the model object that contains the Standard Data Access Interface (SDAI) object. (Inherited from OdDAIObjectSDAI)
owningStepFile	Retrieves the file that contains the model with this application instance. (Inherited from ApplicationInstance)
putAttr(const ExplicitAttributePtr &, const OdRxValue&)	This is the overview for the putAttr method overload.
putAttr(const OdIfc::OdIfcAttribute, const OdRxValue &)	This is the overview for the putAttr method overload.
putAttr(const OdIfc::OdIfcAttribute, const OdRxValue &)	This is the overview for the putAttr method overload.
putAttr(const OdIfcAttribute, const OdRxValue &)	This is the overview for the putAttr method overload.
putAttrCaseInsensitive	Sets a new value of an attribute that is specified by its name in the case insensitive mode. (Inherited from ApplicationInstance)
putAttrWithValidation	Sets a new value of an attribute specified with its name after the validation is performed. (Inherited from ApplicationInstance)
relatedElements	Returns the value of RelatedElements attribute. This attribute represents set of products which are contained within this level of the spatial structure hierarchy.
resetInverseCounterParts	Removes inverse attributes from related application instances. (Inherited from ApplicationInstance)
resolve	Resolves the instance and returns the result of the instance composition to a calling subroutine. (Inherited from OdIfcInstance)
resolved	Retrieves whether the instance is resolved into a compound object, into a Ge compound object, or is unresolved/visited. (Inherited from OdIfcInstance)
setDescription	Sets the object description. (Inherited from IfcRoot)
setGlobalId	Assigns a globally unique identifier within the entire software world. (Inherited from IfcRoot)
setGsNode	Sets a new Gs node cache for the entity. (Inherited from ApplicationInstance)
setGsNode	Sets a new Gs node cache for the Standard Data Access Interface (SDAI) object. (Inherited from OdDAIObjectSDAI)
setGsNode	Sets a new Gs node cache for the instance. (Inherited from OdIfcInstance)
setInverseCounterParts	Sets inverse attributes to related application instances. (Inherited from ApplicationInstance)
setInverseCounterParts	Sets the object ID of this instance to inverse attributes of related instances according to schema specification of inverse attributes.
setInverseCounterParts	Sets inverse attributes to related application instances. (Inherited from OdIfc4x3_RC4Instance)
setName	Sets the name of the object. (Inherited from IfcRoot)
setOwnerHistory	Assigns the information about the current ownership of that object, including owning actor, application, local identification and information captured about the recent changes of the object. (Inherited from IfcRoot)
setRelatingStructure	Sets the value of RelatingStructure attribute. This attribute represents spatial structure element, within which the element is contained. Any element can only be contained within one element of the project spatial structure.
subSetAttributes	Sets the values of the entity's sub-entity traits. (Inherited from ApplicationInstance)
subSetAttributes	Sets the values of the instance's sub-entity traits. (Inherited from OdIfcInstance)
subWorldDraw	Draws a graphical entity representation that is independent of any viewport context. (Inherited from ApplicationInstance)
subWorldDraw	Draws a graphical instance representation that is independent of any viewport context. (Inherited from OdIfcInstance)
testAttr(const AttributePtr&)	This is the overview for the testAttr method overload.
testAttr(const AttributePtr&)	This is the overview for the testAttr method overload.
testAttr(const OdIfc::OdIfcAttribute)	This is the overview for the testAttr method overload.
testAttr(const OdIfc::OdIfcAttribute)	This is the overview for the testAttr method overload.
testAttr(const OdIfcAttribute)	This is the overview for the testAttr method overload.
testAttrCaseInsensitive	Retrieves whether the attribute value is set or is unset. The specified attribute name is case-insensitive. (Inherited from OdDAIObjectSDAI)
type	Returns the type of this entity. (Inherited from IfcRelConnects)
type	Returns the type of this entity.
type	Returns the type of this entity. (Inherited from IfcRelationship)
type	Returns the type of this entity. (Inherited from IfcRoot)
type	Retrieves the current type of the instance. (Inherited from OdIfcInstance)
typeName	Retrieves the type name of the application instance. (Inherited from ApplicationInstance)
unresolve	Unresolves the instance. (Inherited from OdIfcInstance)
unsetAttr(const AttributePtr&)	This is the overview for the unsetAttr method overload.
unsetAttr(const OdIfc::OdIfcAttribute)	This is the overview for the unsetAttr method overload.
unsetAttr(const OdIfc::OdIfcAttribute)	This is the overview for the unsetAttr method overload.
unsetAttr(const OdIfcAttribute)	This is the overview for the unsetAttr method overload.
unsetAttrCaseInsensitive	Checks whether the value of a specified attribute is set. (Inherited from ApplicationInstance)
validateAggrSize	Checks whether the instance has aggregate attributes, which violate size constraints and retrieves the list of such attributes. (Inherited from ApplicationInstance)
validateAggrUniqueness	Checks whether application instance aggregate attributes has unique items in the case if aggregation type of attribute UNIQUE flag is turned on. (Inherited from ApplicationInstance)
validateArrayNotOptional	Checks whether a specified array instances which don't assume optional attributes (i.e. attributes that can't have unset value) have attribute values. (Inherited from ApplicationInstance)
validateBinaryWidth	Checks whether the instance has binary attributes with incorrect width and retrieves the list of such attributes. (Inherited from ApplicationInstance)
validateExplicitAttrsReferences	Checks whether each entity instance that represents the value of a specified instance attribute has a valid entity data type. (Inherited from ApplicationInstance)
validateInverseAttrs	Checks whether the instance has inverse attributes with violated size constraints and retrieves the list of such attributes. (Inherited from ApplicationInstance)
validateRequiredExplicitAttrsAssigned	Checks whether the instance has unset mandatory attributes and retrieves the list of such attributes. (Inherited from ApplicationInstance)
validateStringWidth	Checks whether the instance has string attributes with incorrect width and retrieves the list of such attributes. (Inherited from ApplicationInstance)
validateWhereRule(const WhereRule *)	This is the overview for the validateWhereRule method overload.

Links

IfcRelContainedInSpatialStructure Methods

Relief for ODA Team in Ukraine