#include <IfcSpatialElementAutoImpl.h>

Inheritance diagram for OdIfc4x2::IfcSpatialElement:

Public Member Functions
const OdAnsiString &	getLongName () const

void	setLongName (const OdAnsiString &LongName)

void	getInvContainsElements (OdDAIObjectIds &ContainsElements) const

void	getInvServicedBySystems (OdDAIObjectIds &ServicedBySystems) const

void	getInvReferencesElements (OdDAIObjectIds &ReferencesElements) const

	IfcSpatialElement ()

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 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 OdIfc4x2::IfcProduct
const OdDAIObjectId &	getObjectPlacement () const

void	setObjectPlacement (const OdDAIObjectId &ObjectPlacement)

const OdDAIObjectId &	getRepresentation () const

void	setRepresentation (const OdDAIObjectId &Representation)

void	getInvReferencedBy (OdDAIObjectIds &ReferencedBy) const

void	getInvPositionedRelativeTo (OdDAIObjectIds &PositionedRelativeTo) const

virtual void	setInverseCounterParts () override

Public Member Functions inherited from OdIfc4x2::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 OdIfc4x2::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 OdIfc4x2::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 OdIfc4x2::OdIfc4x2Instance
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
OdAnsiString	m_LongName

Protected Attributes inherited from OdIfc4x2::IfcProduct
OdDAIObjectId	m_ObjectPlacement

OdDAIObjectId	m_Representation

Protected Attributes inherited from OdIfc4x2::IfcObject
OdAnsiString	m_ObjectType

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

class	IfcRelServicesBuildings

class	IfcRelReferencedInSpatialStructure

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

A spatial element is the generalization of all spatial elements that might be used to define a spatial structure or to define spatial zones.

A hierarchical spatial structure element as IfcSpatialStructureElement A spatial structure is a hierarchical decomposition of the project. That spatial structure is often used to provide a project structure to organize a building project. A spatial project structure might define as many levels of decomposition as necessary for the building project. Elements within the spatial project structure are site, building, storey, and space or alternatively, site, bridge and bridge part. A spatial zone as IfcSpatialZone A spatial zone is a non-hierarchical and potentially overlapping decomposition of the project under some functional consideration. A spatial zone might be used to represent a thermal zone, a lighting zone, a usable area zone. A spatial zone might be used to represent a horizontal spatial structure as used in civil works. A spatial zone might have its independent placement and shape representation.

Remarks: This definition cannot be instantiated.

Definition at line 55 of file Ifc4x2/IfcSpatialElementAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcSpatialElement()

OdIfc4x2::IfcSpatialElement::IfcSpatialElement ( )

Default constructor for the IfcSpatialElement class.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x2::IfcSpatialElement::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 OdIfc4x2::IfcProduct.

Reimplemented in OdIfc4x2::IfcBridge, OdIfc4x2::IfcBridgePart, OdIfc4x2::IfcBuilding, OdIfc4x2::IfcBuildingStorey, OdIfc4x2::IfcExternalSpatialElement, OdIfc4x2::IfcSite, OdIfc4x2::IfcSpace, OdIfc4x2::IfcSpatialStructureElement, and OdIfc4x2::IfcSpatialZone.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x2::IfcSpatialElement::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 OdIfc4x2::IfcProduct.

Reimplemented in OdIfc4x2::IfcBridge, OdIfc4x2::IfcBridgePart, OdIfc4x2::IfcBuilding, OdIfc4x2::IfcBuildingStorey, OdIfc4x2::IfcExternalSpatialElement, OdIfc4x2::IfcSite, OdIfc4x2::IfcSpace, OdIfc4x2::IfcSpatialStructureElement, and OdIfc4x2::IfcSpatialZone.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x2::IfcSpatialElement::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 OdIfc4x2::IfcProduct.

Reimplemented in OdIfc4x2::IfcBridge, OdIfc4x2::IfcBridgePart, OdIfc4x2::IfcBuilding, OdIfc4x2::IfcBuildingStorey, OdIfc4x2::IfcExternalSpatialElement, OdIfc4x2::IfcExternalSpatialStructureElement, OdIfc4x2::IfcFacility, OdIfc4x2::IfcFacilityPart, OdIfc4x2::IfcSite, OdIfc4x2::IfcSpace, OdIfc4x2::IfcSpatialStructureElement, and OdIfc4x2::IfcSpatialZone.

◆ getInvContainsElements()

void OdIfc4x2::IfcSpatialElement::getInvContainsElements ( OdDAIObjectIds & ContainsElements ) const

Returns the value of ContainsElements attribute. This attribute represents set of spatial containment relationships, that holds those elements, which are contained within this element of the project spatial structure.

Parameters

ContainsElements [out] Receives the value of ContainsElements attribute.

Remarks: The spatial containment relationship, established by IfcRelContainedInSpatialStructure, is required to be an hierarchical relationship, where each element can only be assigned to 0 or 1 spatial structure element.

◆ getInvReferencesElements()

void OdIfc4x2::IfcSpatialElement::getInvReferencesElements ( OdDAIObjectIds & ReferencesElements ) const

Returns the value of ReferencesElements attribute. This attribute represents a set of spatial reference relationships, that holds those elements, which are referenced, but not contained, within this element of the project spatial structure.

Parameters

ReferencesElements [out] Receives the value of ReferencesElements attribute.

Remarks: The spatial reference relationship, established by IfcRelReferencedInSpatialStructure, is not required to be an hierarchical relationship, i.e. each element can be assigned to 0, 1 or many spatial structure elements. IFC2x3 CHANGE: The inverse attribute has been added with upward compatibility for file-based exchange.

◆ getInvServicedBySystems()

void OdIfc4x2::IfcSpatialElement::getInvServicedBySystems ( OdDAIObjectIds & ServicedBySystems ) const

Returns the value of ServicedBySystems attribute. This attribute represents a set of relationships to systems, that provides a certain service to the spatial element for which it is defined. The relationship is handled by the objectified relationship IfcRelServicesBuildings.

Parameters

ServicedBySystems [out] Receives the value of ServicedBySystems attribute.

Remarks: IFC4 CHANGE: The inverse attribute has been promoted to the new supertype IfcSpatialElement with upward compatibility for file-based exchange.

◆ getLongName()

const OdAnsiString & OdIfc4x2::IfcSpatialElement::getLongName ( ) const

Returns the value of LongName attribute. This attribute represents long name for a spatial structure element, used for informal purposes. It should be used, if available, in conjunction with the inherited Name attribute.

Returns: Returns the value of LongName attribute.

Remarks: In many scenarios the Name attribute refers to the short name or number of a spacial element, and the LongName refers to the full descriptive name.

◆ inFields()

virtual OdResult OdIfc4x2::IfcSpatialElement::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 OdIfc4x2::IfcProduct.

Reimplemented in OdIfc4x2::IfcBridge, OdIfc4x2::IfcBridgePart, OdIfc4x2::IfcBuilding, OdIfc4x2::IfcBuildingStorey, OdIfc4x2::IfcExternalSpatialElement, OdIfc4x2::IfcSite, OdIfc4x2::IfcSpace, OdIfc4x2::IfcSpatialStructureElement, and OdIfc4x2::IfcSpatialZone.

◆ isKindOf()

virtual bool OdIfc4x2::IfcSpatialElement::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 OdIfc4x2::IfcProduct.

Reimplemented in OdIfc4x2::IfcBridge, OdIfc4x2::IfcBridgePart, OdIfc4x2::IfcBuilding, OdIfc4x2::IfcBuildingStorey, OdIfc4x2::IfcExternalSpatialElement, OdIfc4x2::IfcExternalSpatialStructureElement, OdIfc4x2::IfcFacility, OdIfc4x2::IfcFacilityPart, OdIfc4x2::IfcSite, OdIfc4x2::IfcSpace, OdIfc4x2::IfcSpatialStructureElement, and OdIfc4x2::IfcSpatialZone.

◆ outFields()

virtual OdResult OdIfc4x2::IfcSpatialElement::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 OdIfc4x2::IfcProduct.

Reimplemented in OdIfc4x2::IfcBridge, OdIfc4x2::IfcBridgePart, OdIfc4x2::IfcBuilding, OdIfc4x2::IfcBuildingStorey, OdIfc4x2::IfcExternalSpatialElement, OdIfc4x2::IfcSite, OdIfc4x2::IfcSpace, OdIfc4x2::IfcSpatialStructureElement, and OdIfc4x2::IfcSpatialZone.

◆ putAttr() [1/2]

virtual bool OdIfc4x2::IfcSpatialElement::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 OdIfc4x2::IfcProduct.

Reimplemented in OdIfc4x2::IfcBridge, OdIfc4x2::IfcBridgePart, OdIfc4x2::IfcBuilding, OdIfc4x2::IfcBuildingStorey, OdIfc4x2::IfcExternalSpatialElement, OdIfc4x2::IfcSite, OdIfc4x2::IfcSpace, OdIfc4x2::IfcSpatialStructureElement, and OdIfc4x2::IfcSpatialZone.

◆ putAttr() [2/2]

virtual bool OdIfc4x2::IfcSpatialElement::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 OdIfc4x2::IfcProduct.

Reimplemented in OdIfc4x2::IfcBridge, OdIfc4x2::IfcBridgePart, OdIfc4x2::IfcBuilding, OdIfc4x2::IfcBuildingStorey, OdIfc4x2::IfcExternalSpatialElement, OdIfc4x2::IfcSite, OdIfc4x2::IfcSpace, OdIfc4x2::IfcSpatialStructureElement, and OdIfc4x2::IfcSpatialZone.

◆ setLongName()

void OdIfc4x2::IfcSpatialElement::setLongName ( const OdAnsiString & LongName )

Sets the value of LongName attribute. This attribute represents long name for a spatial structure element, used for informal purposes. It should be used, if available, in conjunction with the inherited Name attribute.

Parameters

LongName [in] Long name to set.

Remarks: In many scenarios the Name attribute refers to the short name or number of a spacial element, and the LongName refers to the full descriptive name.

◆ testAttr() [1/2]

virtual bool OdIfc4x2::IfcSpatialElement::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 OdIfc4x2::IfcProduct.

Reimplemented in OdIfc4x2::IfcBridge, OdIfc4x2::IfcBridgePart, OdIfc4x2::IfcBuilding, OdIfc4x2::IfcBuildingStorey, OdIfc4x2::IfcExternalSpatialElement, OdIfc4x2::IfcSite, OdIfc4x2::IfcSpace, OdIfc4x2::IfcSpatialStructureElement, and OdIfc4x2::IfcSpatialZone.

◆ testAttr() [2/2]

virtual bool OdIfc4x2::IfcSpatialElement::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 OdIfc4x2::IfcProduct.

Reimplemented in OdIfc4x2::IfcBridge, OdIfc4x2::IfcBridgePart, OdIfc4x2::IfcBuilding, OdIfc4x2::IfcBuildingStorey, OdIfc4x2::IfcExternalSpatialElement, OdIfc4x2::IfcSite, OdIfc4x2::IfcSpace, OdIfc4x2::IfcSpatialStructureElement, and OdIfc4x2::IfcSpatialZone.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x2::IfcSpatialElement::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 OdIfc4x2::IfcProduct.

Reimplemented in OdIfc4x2::IfcBridge, OdIfc4x2::IfcBridgePart, OdIfc4x2::IfcBuilding, OdIfc4x2::IfcBuildingStorey, OdIfc4x2::IfcExternalSpatialElement, OdIfc4x2::IfcExternalSpatialStructureElement, OdIfc4x2::IfcFacility, OdIfc4x2::IfcFacilityPart, OdIfc4x2::IfcSite, OdIfc4x2::IfcSpace, OdIfc4x2::IfcSpatialStructureElement, and OdIfc4x2::IfcSpatialZone.