#include <IfcClassificationReferenceAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcClassificationReference:

Public Member Functions
IfcClassificationReferenceSelect	referencedSource ()

const OdAnsiString &	getDescription () const

void	setDescription (const OdAnsiString &Description)

const OdAnsiString &	getSort () const

void	setSort (const OdAnsiString &Sort)

void	getInvClassificationRefForObjects (OdDAIObjectIds &ClassificationRefForObjects) const

void	getInvHasReferences (OdDAIObjectIds &HasReferences) const

	IfcClassificationReference ()

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 OdIfc4x4::IfcExternalReference
const OdAnsiString &	getLocation () const

void	setLocation (const OdAnsiString &Location)

const OdAnsiString &	getIdentification () const

void	setIdentification (const OdAnsiString &Identification)

const OdAnsiString &	getName () const

void	setName (const OdAnsiString &Name)

void	getInvExternalReferenceForResources (OdDAIObjectIds &ExternalReferenceForResources) const

	IfcExternalReference ()

Public Member Functions inherited from OdIfc4x4::OdIFC4X4Instance
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
OdDAI::Select	m_ReferencedSource

OdAnsiString	m_Description

OdAnsiString	m_Sort

Protected Attributes inherited from OdIfc4x4::IfcExternalReference
OdAnsiString	m_Location

OdAnsiString	m_Identification

OdAnsiString	m_Name

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

Friends
class	IfcRelAssociatesClassification

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

IfcClassificationReference is a reference into a classification system or source (see IfcClassification) for a specific classification key (or notation). The inherited attributes: Identification: holds the key provided for a specific references to classification items (or tables). Name: provides a human-interpretable designation of a classification notation. Location: optionally holds a direct URI link into the classification system (or source) to hyperlink the classification key.

The IfcClassificationReference can either be assigned directly to the IfcClassification, such as if no classification hierarchy has to be included, or it references the parent classification notation, if the full classification hierarchy is included in the data set. The first is referred to as "lightweight classification", and the second as "full classification".

\changes

IFC4 changes: Type of the ReferencedSource attribute changed from "IfcClassification" to "IfcClassificationReferenceSelect"

Definition at line 55 of file IFC4X4/IfcClassificationReferenceAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcClassificationReference()

OdIfc4x4::IfcClassificationReference::IfcClassificationReference ( )

Default constructor for the IfcClassificationReference class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x4::IfcClassificationReference::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 OdIfc4x4::IfcExternalReference.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x4::IfcClassificationReference::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 OdIfc4x4::IfcExternalReference.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x4::IfcClassificationReference::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 OdIfc4x4::IfcExternalReference.

◆ getDescription()

const OdAnsiString & OdIfc4x4::IfcClassificationReference::getDescription ( ) const

Returns the value of Description attribute. This attribute represents description of the classification reference for informational purposes.

Returns: Returns the value of Description attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcClassificationReference::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 OdIfc4x4::IfcExternalReference.

◆ getInvClassificationRefForObjects()

void OdIfc4x4::IfcClassificationReference::getInvClassificationRefForObjects ( OdDAIObjectIds & ClassificationRefForObjects ) const

Returns the value of ClassificationRefForObjects attribute. This attribute represents the classification reference with which objects are associated.

Parameters

ClassificationRefForObjects [out] Receives the value of ClassificationRefForObjects attribute.

◆ getInvHasReferences()

void OdIfc4x4::IfcClassificationReference::getInvHasReferences ( OdDAIObjectIds & HasReferences ) const

Returns the value of HasReferences attribute. This attribute represents the parent classification references to which this child classification reference applies. It can either be the final classification item leaf node, or an intermediate classification item.

Parameters

HasReferences [out] Receives the value of HasReferences attribute.

◆ getSort()

const OdAnsiString & OdIfc4x4::IfcClassificationReference::getSort ( ) const

Returns the value of Sort attribute. This attribute represents optional identifier to sort the set of classification references within the referenced source (either a classification facet of higher level, or the classification system itself).

Returns: Returns the value of Sort attribute.

◆ inFields()

virtual OdResult OdIfc4x4::IfcClassificationReference::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 OdIfc4x4::IfcExternalReference.

◆ isKindOf()

virtual bool OdIfc4x4::IfcClassificationReference::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 OdIfc4x4::IfcExternalReference.

◆ outFields()

virtual OdResult OdIfc4x4::IfcClassificationReference::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 OdIfc4x4::IfcExternalReference.

◆ putAttr() [1/2]

virtual bool OdIfc4x4::IfcClassificationReference::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 OdIfc4x4::IfcExternalReference.

◆ putAttr() [2/2]

virtual bool OdIfc4x4::IfcClassificationReference::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 OdIfc4x4::IfcExternalReference.

◆ referencedSource()

IfcClassificationReferenceSelect OdIfc4x4::IfcClassificationReference::referencedSource ( )

Returns the value of ReferencedSource attribute. This attribute represents the classification system or source that is referenced.

Returns: Returns the value of ReferencedSource attribute.

◆ setDescription()

void OdIfc4x4::IfcClassificationReference::setDescription ( const OdAnsiString & Description )

Sets the value of Description attribute. This attribute represents description of the classification reference for informational purposes.

Parameters

Description [in] Description to set.

◆ setInverseCounterParts()

virtual void OdIfc4x4::IfcClassificationReference::setInverseCounterParts ( )

overridevirtual

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

◆ setSort()

void OdIfc4x4::IfcClassificationReference::setSort ( const OdAnsiString & Sort )

Sets the value of Sort attribute. This attribute represents optional identifier to sort the set of classification references within the referenced source (either a classification facet of higher level, or the classification system itself).

Parameters

Sort	[in] Sort to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x4::IfcClassificationReference::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 OdIfc4x4::IfcExternalReference.

◆ testAttr() [2/2]

virtual bool OdIfc4x4::IfcClassificationReference::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 OdIfc4x4::IfcExternalReference.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x4::IfcClassificationReference::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 OdIfc4x4::IfcExternalReference.

◆ unsetAttr() [1/2]

virtual void OdIfc4x4::IfcClassificationReference::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc4x4::IfcExternalReference.

◆ unsetAttr() [2/2]

virtual void OdIfc4x4::IfcClassificationReference::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 OdIfc4x4::IfcExternalReference.

Friends And Related Symbol Documentation

◆ IfcRelAssociatesClassification

friend class IfcRelAssociatesClassification

friend

Definition at line 263 of file IFC4X4/IfcClassificationReferenceAutoImpl.h.

Member Data Documentation

◆ m_Description

OdAnsiString OdIfc4x4::IfcClassificationReference::m_Description

protected

Definition at line 259 of file IFC4X4/IfcClassificationReferenceAutoImpl.h.

◆ m_ReferencedSource

OdDAI::Select OdIfc4x4::IfcClassificationReference::m_ReferencedSource

protected

Definition at line 258 of file IFC4X4/IfcClassificationReferenceAutoImpl.h.

◆ m_Sort

OdAnsiString OdIfc4x4::IfcClassificationReference::m_Sort

protected

Definition at line 260 of file IFC4X4/IfcClassificationReferenceAutoImpl.h.

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

IFC4X4/IfcClassificationReferenceAutoImpl.h

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcClassificationReference()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getDescription()

◆ getInstanceType()

◆ getInvClassificationRefForObjects()

◆ getInvHasReferences()

◆ getSort()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ referencedSource()

◆ setDescription()

◆ setInverseCounterParts()

◆ setSort()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Friends And Related Symbol Documentation

◆ IfcRelAssociatesClassification

Member Data Documentation

◆ m_Description

◆ m_ReferencedSource

◆ m_Sort