#include <IfcRelNestsAutoImpl.h>

Inheritance diagram for OdIfc4x2::IfcRelNests:

Public Member Functions
const OdDAIObjectId &	getRelatingObject () const

void	setRelatingObject (const OdDAIObjectId &RelatingObject)

void	getRelatedObjects (OdDAIObjectIds &RelatedObjects) const

OdDAI::ListOfOdDAIObjectId &	relatedObjects ()

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 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::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
OdDAIObjectId	m_RelatingObject

OdDAI::ListOfOdDAIObjectId	m_RelatedObjects

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

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 nesting relationship IfcRelNests is a special type of the general composition/decomposition (or whole/part) relationship IfcRelDecomposes. The nesting relationship can be applied to all non physical subtypes of object and object types, namely processes, controls (like cost items), and resources. It can also be applied to physical subtypes of object and object types, namely elements having ports. The nesting implies an order among the nested parts.

Remarks: EXAMPLE: A nesting of costs items in an IfcCostSchedule is the composition of complex cost items from other cost items. The order of the nested cost items underneath the parent cost item is determined by the order of the list of RelatedObjects. EXAMPLE: A nesting of IfcTask's within a work schedule is the composition of a parent work task from more specific sub work tasks. The order of the sub tasks underneath the parent task is determined by the order of the list of RelatedObjects. EXAMPLE: A series of IfcDistributionPort's can be nested within an IfcDistributionElement. They decompose the distribution element and have an implied order.

\changes

IFC4 changes: The attributes RelatingObject and RelatedObjects are demoted from the supertype IfcRelDecomposes, and RelatedObjects is refined to be a list. The use of IfcRelNests is re-purposed to be a nesting of an ordered collections of parts.

Definition at line 58 of file Ifc4x2/IfcRelNestsAutoImpl.h.

Member Function Documentation

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x2::IfcRelNests::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::IfcRoot.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x2::IfcRelNests::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::IfcRoot.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x2::IfcRelNests::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::IfcRelDecomposes.

◆ getRelatedObjects()

void OdIfc4x2::IfcRelNests::getRelatedObjects ( OdDAIObjectIds & RelatedObjects ) const

Sets the value of RelatedObjects attribute. This attribute represents the object definitions, either non-product object occurrences or non-product object types, that are being nestes. They are defined as the parts in the ordered whole/part relationship -i.e. there is an implied order among the parts expressed by the position within the list of RelatedObjects.

Parameters

RelatedObjects [out] Receives the related objects.

Remarks: IFC4 CHANGE: The attribute has been demoted from the supertype IfcRelDecomposes and defines the ordered set of parts within the nest.

◆ getRelatingObject()

const OdDAIObjectId & OdIfc4x2::IfcRelNests::getRelatingObject ( ) const

Returns the value of RelatingObject attribute. This attribute represents the object definition, either an non-product object type or a non-product object occurrence, that represents the nest. It is the whole within the whole/part relationship.

Returns: Returns the value of RelatingObject attribute.

Remarks: IFC4 CHANGE: The attribute has been demoted from the supertype IfcRelDecomposes and defines the ordered nesting relationship.

◆ inFields()

virtual OdResult OdIfc4x2::IfcRelNests::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::IfcRoot.

◆ isKindOf()

virtual bool OdIfc4x2::IfcRelNests::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::IfcRelDecomposes.

◆ outFields()

virtual OdResult OdIfc4x2::IfcRelNests::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::IfcRoot.

◆ putAttr() [1/2]

virtual bool OdIfc4x2::IfcRelNests::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::IfcRoot.

◆ putAttr() [2/2]

virtual bool OdIfc4x2::IfcRelNests::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::IfcRoot.

◆ relatedObjects()

OdDAI::ListOfOdDAIObjectId & OdIfc4x2::IfcRelNests::relatedObjects ( )

Returns the value of RelatedObjects attribute. This attribute represents the object definitions, either non-product object occurrences or non-product object types, that are being nestes. They are defined as the parts in the ordered whole/part relationship -i.e. there is an implied order among the parts expressed by the position within the list of RelatedObjects.

Returns: Returns the value of RelatingObject attribute.

Remarks: IFC4 CHANGE: The attribute has been demoted from the supertype IfcRelDecomposes and defines the ordered set of parts within the nest.

◆ setInverseCounterParts()

virtual void OdIfc4x2::IfcRelNests::setInverseCounterParts ( )

overridevirtual

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

◆ setRelatingObject()

void OdIfc4x2::IfcRelNests::setRelatingObject ( const OdDAIObjectId & RelatingObject )

Sets the value of RelatingObject attribute. This attribute represents the object definition, either an non-product object type or a non-product object occurrence, that represents the nest. It is the whole within the whole/part relationship.

Parameters

RelatingObject [in] Relating object to set.

Remarks: IFC4 CHANGE: The attribute has been demoted from the supertype IfcRelDecomposes and defines the ordered nesting relationship.

◆ testAttr() [1/2]

virtual bool OdIfc4x2::IfcRelNests::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::IfcRoot.

◆ testAttr() [2/2]

virtual bool OdIfc4x2::IfcRelNests::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::IfcRoot.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x2::IfcRelNests::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::IfcRelDecomposes.

◆ unsetAttr() [1/2]

virtual void OdIfc4x2::IfcRelNests::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc4x2::IfcRoot.

◆ unsetAttr() [2/2]

virtual void OdIfc4x2::IfcRelNests::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 OdIfc4x2::IfcRoot.

Member Data Documentation

◆ m_RelatedObjects

OdDAI::ListOfOdDAIObjectId OdIfc4x2::IfcRelNests::m_RelatedObjects

protected

Definition at line 227 of file Ifc4x2/IfcRelNestsAutoImpl.h.

◆ m_RelatingObject

OdDAIObjectId OdIfc4x2::IfcRelNests::m_RelatingObject

protected

Definition at line 226 of file Ifc4x2/IfcRelNestsAutoImpl.h.

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

Ifc4x2/IfcRelNestsAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getInstanceType()

◆ getRelatedObjects()

◆ getRelatingObject()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ relatedObjects()

◆ setInverseCounterParts()

◆ setRelatingObject()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_RelatedObjects

◆ m_RelatingObject