#include <IfcClassificationAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcClassification:

Public Member Functions
const OdAnsiString &	getSource () const

void	setSource (const OdAnsiString &Source)

const OdAnsiString &	getEdition () const

void	setEdition (const OdAnsiString &Edition)

const OdAnsiString &	getEditionDate () const

void	setEditionDate (const OdAnsiString &EditionDate)

const OdAnsiString &	getName () const

void	setName (const OdAnsiString &Name)

const OdAnsiString &	getDescription () const

void	setDescription (const OdAnsiString &Description)

const OdAnsiString &	getLocation () const

void	setLocation (const OdAnsiString &Location)

void	getReferenceTokens (OdArray< OdAnsiString > &ReferenceTokens) const

OdDAI::ListOfOdAnsiString &	referenceTokens ()

void	getInvClassificationForObjects (OdDAIObjectIds &ClassificationForObjects) const

void	getInvHasReferences (OdDAIObjectIds &HasReferences) const

	IfcClassification ()

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 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
OdAnsiString	m_Source

OdAnsiString	m_Edition

OdAnsiString	m_EditionDate

OdAnsiString	m_Name

OdAnsiString	m_Description

OdAnsiString	m_Location

OdDAI::ListOfOdAnsiString	m_ReferenceTokens

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

Friends
class	IfcRelAssociatesClassification

class	IfcClassificationReference

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

An IfcClassification is used for the arrangement of objects into a class or category according to a common purpose or their possession of common characteristics. A category of objects relates to other categories in a generalization-specialization relationship. The classification items in an classification are organized in a tree structure.

\changes

IFC4 changes: Attribute Edition is optional Type of the EditionDate attribute changed from "IfcCalendarDate" to "IfcDate" Attribute Source is optional Inverse attribute Contains renamed to ClassificationForObjects Type of the inverse attribute Contains Changed from "SET OF [0:?] IfcClassificationItem FOR ItemOf" to "SET OF [0:?] IfcRelAssociatesClassification FOR RelatingClassification" IFC4X3_RC1 changes: Attribute Location renamed to Specification

Definition at line 54 of file IFC4X4/IfcClassificationAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcClassification()

OdIfc4x4::IfcClassification::IfcClassification ( )

Default constructor for the IfcClassification class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x4::IfcClassification::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::IfcExternalInformation.

◆ getAttr() [1/2]

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

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x4::IfcClassification::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 OdIfc::OdIfcInstance.

◆ getDescription()

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

Returns the value of Description attribute. This attribute represents additional description provided for the classification.

Returns: Returns the value of Description attribute.

◆ getEdition()

const OdAnsiString & OdIfc4x4::IfcClassification::getEdition ( ) const

Returns the value of Edition attribute. This attribute represents the edition or version of the classification system from which the classification notation is derived.

Returns: Returns the value of Edition attribute.

Remarks: The version labeling system is specific to the classification system.

◆ getEditionDate()

const OdAnsiString & OdIfc4x4::IfcClassification::getEditionDate ( ) const

Returns the value of EditionDate attribute. This attribute represents the date on which the edition of the classification became valid.

Returns: Returns the value of EditionDate attribute.

Remarks: The edition date is provided as an optional attribute to enable more precise identification where required.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcClassification::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::IfcExternalInformation.

◆ getInvClassificationForObjects()

void OdIfc4x4::IfcClassification::getInvClassificationForObjects ( OdDAIObjectIds & ClassificationForObjects ) const

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

Parameters

ClassificationForObjects [out] Receives the value of ClassificationForObjects attribute.

◆ getInvHasReferences()

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

Returns the value of HasReferences attribute. This attribute represents the classification references to which the classification applies. It can either be the final classification notation, or an intermediate classification item.

Parameters

HasReferences [out] Receives the value of HasReferences attribute.

◆ getLocation()

const OdAnsiString & OdIfc4x4::IfcClassification::getLocation ( ) const

Returns the value of Location attribute. This attribute represents resource identifier or locator, provided as URI, URN or URL, of the classification.

Returns: Returns the value of Location attribute.

◆ getName()

const OdAnsiString & OdIfc4x4::IfcClassification::getName ( ) const

Returns the value of Name attribute. This attribute represents the name or label by which the classification is normally known.

Returns: Returns the value of Name attribute.

Remarks: Examples of names include CI/SfB, Masterformat, BSAB, Uniclass, STABU, DIN276, DIN277, etc.

◆ getReferenceTokens()

void OdIfc4x4::IfcClassification::getReferenceTokens ( OdArray< OdAnsiString > & ReferenceTokens ) const

Gets the value of ReferenceTokens attribute. This attribute represents the delimiter tokens that are used to mark the boundaries of individual facets (substrings) in a classification reference.

Parameters

ReferenceTokens [out] Receives reference tokens.

Remarks: This typically applies when the IfcClassification is used together with IfcClassificationReference's. If only one reference token is provided, it applies to all boundaries of individual facets, if more than one, then the first token applies to the first boundary, the second token to the second boundary, and the nth token to the nth and any additional boundary.

◆ getSource()

const OdAnsiString & OdIfc4x4::IfcClassification::getSource ( ) const

Returns the value of Source attribute. This attribute represents source (or publisher) for this classification.

Returns: Returns the value of Source attribute.

Remarks: The source of the classification means the person or organization that is the original author or the person or organization currently acting as the publisher.

◆ inFields()

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

◆ isKindOf()

virtual bool OdIfc4x4::IfcClassification::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::IfcExternalInformation.

◆ outFields()

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

◆ putAttr() [1/2]

virtual bool OdIfc4x4::IfcClassification::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 OdIfc::OdIfcInstance.

◆ putAttr() [2/2]

virtual bool OdIfc4x4::IfcClassification::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 OdIfc::OdIfcInstance.

◆ referenceTokens()

OdDAI::ListOfOdAnsiString & OdIfc4x4::IfcClassification::referenceTokens ( )

Returns the value of ReferenceTokens attribute. This attribute represents the delimiter tokens that are used to mark the boundaries of individual facets (substrings) in a classification reference.

Returns: Returns the value of ReferenceTokens attribute.

Remarks: This typically applies when the IfcClassification is used together with IfcClassificationReference's. If only one reference token is provided, it applies to all boundaries of individual facets, if more than one, then the first token applies to the first boundary, the second token to the second boundary, and the nth token to the nth and any additional boundary.

◆ setDescription()

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

Sets the value of Description attribute. This attribute represents additional description provided for the classification.

Parameters

Description [in] Description to set.

◆ setEdition()

void OdIfc4x4::IfcClassification::setEdition ( const OdAnsiString & Edition )

Sets the value of Edition attribute. This attribute represents the edition or version of the classification system from which the classification notation is derived.

Parameters

Edition [in] Edition to set.

Remarks: The version labeling system is specific to the classification system.

◆ setEditionDate()

void OdIfc4x4::IfcClassification::setEditionDate ( const OdAnsiString & EditionDate )

Sets the value of EditionDate attribute. This attribute represents the date on which the edition of the classification became valid.

Parameters

EditionDate [in] Edition date to set.

Remarks: The edition date is provided as an optional attribute to enable more precise identification where required.

◆ setLocation()

void OdIfc4x4::IfcClassification::setLocation ( const OdAnsiString & Location )

Sets the value of Location attribute. This attribute represents resource identifier or locator, provided as URI, URN or URL, of the classification.

Parameters

Location [in] Location to set.

◆ setName()

void OdIfc4x4::IfcClassification::setName ( const OdAnsiString & Name )

Sets the value of Name attribute. This attribute represents the name or label by which the classification is normally known.

Parameters

Name	[in] Name to set.

Remarks: Examples of names include CI/SfB, Masterformat, BSAB, Uniclass, STABU, DIN276, DIN277, etc.

◆ setSource()

void OdIfc4x4::IfcClassification::setSource ( const OdAnsiString & Source )

Sets the value of Source attribute. This attribute represents source (or publisher) for this classification.

Parameters

Source [in] Source to set.

Remarks: The source of the classification means the person or organization that is the original author or the person or organization currently acting as the publisher.

◆ testAttr() [1/2]

virtual bool OdIfc4x4::IfcClassification::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 OdIfc::OdIfcInstance.

◆ testAttr() [2/2]

virtual bool OdIfc4x4::IfcClassification::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 OdIfc::OdIfcInstance.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x4::IfcClassification::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::IfcExternalInformation.

◆ unsetAttr() [1/2]

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

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc::OdIfcInstance.

◆ unsetAttr() [2/2]

virtual void OdIfc4x4::IfcClassification::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 OdIfc::OdIfcInstance.

Friends And Related Symbol Documentation

◆ IfcClassificationReference

friend class IfcClassificationReference

friend

Definition at line 358 of file IFC4X4/IfcClassificationAutoImpl.h.

◆ IfcRelAssociatesClassification

friend class IfcRelAssociatesClassification

friend

Definition at line 357 of file IFC4X4/IfcClassificationAutoImpl.h.

Member Data Documentation

◆ m_Description

OdAnsiString OdIfc4x4::IfcClassification::m_Description

protected

Definition at line 351 of file IFC4X4/IfcClassificationAutoImpl.h.

◆ m_Edition

OdAnsiString OdIfc4x4::IfcClassification::m_Edition

protected

Definition at line 348 of file IFC4X4/IfcClassificationAutoImpl.h.

◆ m_EditionDate

OdAnsiString OdIfc4x4::IfcClassification::m_EditionDate

protected

Definition at line 349 of file IFC4X4/IfcClassificationAutoImpl.h.

◆ m_Location

OdAnsiString OdIfc4x4::IfcClassification::m_Location

protected

Definition at line 352 of file IFC4X4/IfcClassificationAutoImpl.h.

◆ m_Name

OdAnsiString OdIfc4x4::IfcClassification::m_Name

protected

Definition at line 350 of file IFC4X4/IfcClassificationAutoImpl.h.

◆ m_ReferenceTokens

OdDAI::ListOfOdAnsiString OdIfc4x4::IfcClassification::m_ReferenceTokens

protected

Definition at line 353 of file IFC4X4/IfcClassificationAutoImpl.h.

◆ m_Source

OdAnsiString OdIfc4x4::IfcClassification::m_Source

protected

Definition at line 347 of file IFC4X4/IfcClassificationAutoImpl.h.

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

IFC4X4/IfcClassificationAutoImpl.h

Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcClassification()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getDescription()

◆ getEdition()

◆ getEditionDate()

◆ getInstanceType()

◆ getInvClassificationForObjects()

◆ getInvHasReferences()

◆ getLocation()

◆ getName()

◆ getReferenceTokens()

◆ getSource()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ referenceTokens()

◆ setDescription()

◆ setEdition()

◆ setEditionDate()

◆ setLocation()

◆ setName()

◆ setSource()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Friends And Related Symbol Documentation

◆ IfcClassificationReference

◆ IfcRelAssociatesClassification

Member Data Documentation

◆ m_Description

◆ m_Edition

◆ m_EditionDate

◆ m_Location

◆ m_Name

◆ m_ReferenceTokens

◆ m_Source