#include <IfcContextAutoImpl.h>

Inheritance diagram for OdIfc4::IfcContext:

Public Member Functions
const OdAnsiString &	getObjectType () const

void	setObjectType (const OdAnsiString &ObjectType)

const OdAnsiString &	getLongName () const

void	setLongName (const OdAnsiString &LongName)

const OdAnsiString &	getPhase () const

void	setPhase (const OdAnsiString &Phase)

void	getRepresentationContexts (OdDAIObjectIds &RepresentationContexts) const

OdDAI::SetOfOdDAIObjectId &	representationContexts ()

const OdDAIObjectId &	getUnitsInContext () const

void	setUnitsInContext (const OdDAIObjectId &UnitsInContext)

void	getInvIsDefinedBy (OdDAIObjectIds &IsDefinedBy) const

void	getInvDeclares (OdDAIObjectIds &Declares) const

	IfcContext ()

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::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
OdAnsiString	m_ObjectType

OdAnsiString	m_LongName

OdAnsiString	m_Phase

OdDAI::SetOfOdDAIObjectId	m_RepresentationContexts

OdDAIObjectId	m_UnitsInContext

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	IfcRelDefinesByProperties

class	IfcRelDeclares

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)

Protected Member Functions inherited from OdIfc4::IfcObjectDefinition
virtual OdRxValue	getAttr (const char *attrName) const override

virtual bool	putAttr (const char *explicitAttrName, const OdRxValue &val) override

Detailed Description

IfcContext is the generalization of a project context in which objects, type objects, property sets, and properties are defined. The IfcProject as subtype of IfcContext provides the context for all information on a construction project, it can include one or several IfcProjectLibrary's as subtype of IfcContext to register the included libraries for the project. A library of products that is referenced is declared within the IfcProjectLibrary as the context of that library.

A context is declared by the IfcRelDeclares object that refers to the corresponding objects within the context. More specific relationships are introduced at the level of subtypes.

Definition at line 47 of file Ifc4/IfcContextAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcContext()

OdIfc4::IfcContext::IfcContext ( )

Default constructor for the IfcContext class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4::IfcContext::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::IfcObjectDefinition.

Reimplemented in OdIfc4::IfcProject, and OdIfc4::IfcProjectLibrary.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4::IfcContext::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::IfcRoot.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4::IfcContext::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::IfcObjectDefinition.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcContext::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::IfcObjectDefinition.

Reimplemented in OdIfc4::IfcProject, and OdIfc4::IfcProjectLibrary.

◆ getInvDeclares()

void OdIfc4::IfcContext::getInvDeclares ( OdDAIObjectIds & Declares ) const

Returns the value of Declares attribute. This attribute represents reference to the IfcRelDeclares relationship that assigns the uppermost entities of includes hierarchies to this context instance.

Parameters

Declares [out] Receives the value of Declares attribute.

Remarks: The spatial hierarchy is assigned to IfcProject using the IfcRelAggregates relationship.

◆ getInvIsDefinedBy()

void OdIfc4::IfcContext::getInvIsDefinedBy ( OdDAIObjectIds & IsDefinedBy ) const

Returns the value of IsDefinedBy attribute. This attribute represents a set of relationships to property set definitions that are attached to this context. Those statically or dynamically defined properties contain alphanumeric information content that further defines the context.

Parameters

IsDefinedBy [out] Receives the value of IsDefinedBy attribute.

Remarks: IFC4 CHANGE: The data type has been changed from IfcRelDefines to IfcRelDefinesByProperties with upward compatibility for file-based exchange.

◆ getLongName()

const OdAnsiString & OdIfc4::IfcContext::getLongName ( ) const

Returns the value of LongName attribute. This attribute represents long name for the context as used for reference purposes.

Returns: Returns the value of LongName attribute.

◆ getObjectType()

const OdAnsiString & OdIfc4::IfcContext::getObjectType ( ) const

Returns the value of ObjectType attribute. This attribute represents the object type denotes a particular type that indicates the object further. The use has to be established at the level of instantiable subtypes.

Returns: Returns the value of ObjectType attribute.

Remarks: Subtypes of IfcContext do not introduce a PredefinedType attribute, therefore the usage of ObjectType is not bound to the selection of USERDEFINED within the PredefinedType enumeration.

◆ getPhase()

const OdAnsiString & OdIfc4::IfcContext::getPhase ( ) const

Returns the value of Phase attribute. This attribute represents current project phase, or life-cycle phase of this project. Applicable values have to be agreed upon by view definitions or implementer agreements.

Returns: Returns the value of Phase attribute.

◆ getRepresentationContexts()

void OdIfc4::IfcContext::getRepresentationContexts ( OdDAIObjectIds & RepresentationContexts ) const

Returns the value of RepresentationContexts attribute. This attribute represents context of the representations used within the context. When the context is a project and it includes shape representations for its components, one or several geometric representation contexts need to be included that define e.g. the world coordinate system, the coordinate space dimensions, and/or the precision factor.

Parameters

RepresentationContexts [out] Receives representation contexts.

Remarks: IFC4 CHANGE: The attribute has been changed to be optional. Change made with upward compatibility for file-based exchange.

◆ getUnitsInContext()

const OdDAIObjectId & OdIfc4::IfcContext::getUnitsInContext ( ) const

Returns the value of UnitsInContext attribute. This attribute represents units globally assigned to measure types used within the context.

Returns: Returns the value of UnitsInContext attribute.

Remarks: IFC4 CHANGE: The attribute has been changed to be optional. Change made with upward compatibility for file-based exchange.

◆ inFields()

virtual OdResult OdIfc4::IfcContext::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::IfcObjectDefinition.

◆ isKindOf()

virtual bool OdIfc4::IfcContext::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::IfcObjectDefinition.

Reimplemented in OdIfc4::IfcProject, and OdIfc4::IfcProjectLibrary.

◆ outFields()

virtual OdResult OdIfc4::IfcContext::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::IfcObjectDefinition.

◆ putAttr() [1/2]

virtual bool OdIfc4::IfcContext::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::IfcRoot.

◆ putAttr() [2/2]

virtual bool OdIfc4::IfcContext::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::IfcObjectDefinition.

◆ representationContexts()

OdDAI::SetOfOdDAIObjectId & OdIfc4::IfcContext::representationContexts ( )

Returns the value of RepresentationContexts attribute. This attribute represents context of the representations used within the context. When the context is a project and it includes shape representations for its components, one or several geometric representation contexts need to be included that define e.g. the world coordinate system, the coordinate space dimensions, and/or the precision factor.

Returns: Returns the value of RepresentationContexts attribute.

Remarks: IFC4 CHANGE: The attribute has been changed to be optional. Change made with upward compatibility for file-based exchange.

◆ setLongName()

void OdIfc4::IfcContext::setLongName ( const OdAnsiString & LongName )

Sets the value of LongName attribute. This attribute represents long name for the context as used for reference purposes.

Parameters

LongName [in] Long name to set.

◆ setObjectType()

void OdIfc4::IfcContext::setObjectType ( const OdAnsiString & ObjectType )

Sets the value of ObjectType attribute. This attribute represents the object type denotes a particular type that indicates the object further. The use has to be established at the level of instantiable subtypes.

Parameters

ObjectType [in] Object type to set.

Remarks: Subtypes of IfcContext do not introduce a PredefinedType attribute, therefore the usage of ObjectType is not bound to the selection of USERDEFINED within the PredefinedType enumeration.

◆ setPhase()

void OdIfc4::IfcContext::setPhase ( const OdAnsiString & Phase )

Sets the value of Phase attribute. This attribute represents current project phase, or life-cycle phase of this project. Applicable values have to be agreed upon by view definitions or implementer agreements.

Parameters

Phase [in] Phase to set.

◆ setUnitsInContext()

void OdIfc4::IfcContext::setUnitsInContext ( const OdDAIObjectId & UnitsInContext )

Sets the value of UnitsInContext attribute. This attribute represents units globally assigned to measure types used within the context.

Parameters

UnitsInContext [in] Units in context to set.

Remarks: IFC4 CHANGE: The attribute has been changed to be optional. Change made with upward compatibility for file-based exchange.

◆ testAttr() [1/2]

virtual bool OdIfc4::IfcContext::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::IfcObjectDefinition.

◆ testAttr() [2/2]

virtual bool OdIfc4::IfcContext::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::IfcObjectDefinition.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcContext::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::IfcObjectDefinition.

Reimplemented in OdIfc4::IfcProject, and OdIfc4::IfcProjectLibrary.

◆ unsetAttr() [1/2]

virtual void OdIfc4::IfcContext::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::IfcObjectDefinition.

◆ unsetAttr() [2/2]

virtual void OdIfc4::IfcContext::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::IfcObjectDefinition.

Friends And Related Symbol Documentation

◆ IfcRelDeclares

friend class IfcRelDeclares

friend

Definition at line 320 of file Ifc4/IfcContextAutoImpl.h.

◆ IfcRelDefinesByProperties

friend class IfcRelDefinesByProperties

friend

Definition at line 319 of file Ifc4/IfcContextAutoImpl.h.

Member Data Documentation

◆ m_LongName

OdAnsiString OdIfc4::IfcContext::m_LongName

protected

Definition at line 312 of file Ifc4/IfcContextAutoImpl.h.

◆ m_ObjectType

OdAnsiString OdIfc4::IfcContext::m_ObjectType

protected

Definition at line 311 of file Ifc4/IfcContextAutoImpl.h.

◆ m_Phase

OdAnsiString OdIfc4::IfcContext::m_Phase

protected

Definition at line 313 of file Ifc4/IfcContextAutoImpl.h.

◆ m_RepresentationContexts

OdDAI::SetOfOdDAIObjectId OdIfc4::IfcContext::m_RepresentationContexts

protected

Definition at line 314 of file Ifc4/IfcContextAutoImpl.h.

◆ m_UnitsInContext

OdDAIObjectId OdIfc4::IfcContext::m_UnitsInContext

protected

Definition at line 316 of file Ifc4/IfcContextAutoImpl.h.

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

Ifc4/IfcContextAutoImpl.h

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcContext()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getInstanceType()

◆ getInvDeclares()

◆ getInvIsDefinedBy()

◆ getLongName()

◆ getObjectType()

◆ getPhase()

◆ getRepresentationContexts()

◆ getUnitsInContext()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ representationContexts()

◆ setLongName()

◆ setObjectType()

◆ setPhase()

◆ setUnitsInContext()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Friends And Related Symbol Documentation

◆ IfcRelDeclares

◆ IfcRelDefinesByProperties

Member Data Documentation

◆ m_LongName

◆ m_ObjectType

◆ m_Phase

◆ m_RepresentationContexts

◆ m_UnitsInContext