DATAKIT API  V2025.1
Ifcw::classification::IfcClassificationReference Class Reference

This class represent a classification reference to be used for an ifc object, e.g.: B2010 in OmniClass for exterior walls. It is link to a classification. More...

Public Member Functions

const Dtk_stringGetItemReference () const
 Getter for the reference item reference. More...
 
const Dtk_stringGetLocation () const
 Getter for the reference location. More...
 
const Dtk_stringGetName () const
 Getter for the reference name. More...
 
const IfcClassificationGetReferencedSource () const
 Getter for the classification the reference is linked to. More...
 
 IfcClassificationReference (const Dtk_string &inLocation="", const Dtk_string &inItemReference="", const Dtk_string &inName="", IfcClassification inReferencedSource=IfcClassification())
 Base constructor. More...
 
 IfcClassificationReference (const IfcClassificationReference &inRef)
 Copy constructor. More...
 
Dtk_bool operator== (IfcClassificationReference cr)
 
void SetItemReference (const Dtk_string &inItemReference)
 Setter for the reference item reference. More...
 
void SetLocation (const Dtk_string &inLocation)
 Setter for the reference location. More...
 
void SetName (const Dtk_string &inName)
 Setter for the reference name. More...
 
 ~IfcClassificationReference ()
 Destructor. More...
 

Detailed Description

This class represent a classification reference to be used for an ifc object, e.g.: B2010 in OmniClass for exterior walls. It is link to a classification.

See also
IfcClassification
Remarks
One of its parameter have to be assigned (all optionals).
See also
https://standards.buildingsmart.org/IFC/DEV/IFC4_3/RC1/HTML/schema/ifcexternalreferenceresource/lexical/ifcclassificationreference.htm
https://standards.buildingsmart.org/IFC/DEV/IFC4_3/RC1/HTML/schema/ifcexternalreferenceresource/lexical/ifcexternalreference.htm

Constructor & Destructor Documentation

◆ IfcClassificationReference() [1/2]

Ifcw::classification::IfcClassificationReference::IfcClassificationReference ( const Dtk_string inLocation = "",
const Dtk_string inItemReference = "",
const Dtk_string inName = "",
IfcClassification  inReferencedSource = IfcClassification() 
)

Base constructor.

Remarks
One of the parameter should be set, otherwise name will be set to 'Undefined'.

◆ IfcClassificationReference() [2/2]

Ifcw::classification::IfcClassificationReference::IfcClassificationReference ( const IfcClassificationReference inRef)

Copy constructor.

◆ ~IfcClassificationReference()

Ifcw::classification::IfcClassificationReference::~IfcClassificationReference ( )

Destructor.

Member Function Documentation

◆ GetItemReference()

const Dtk_string& Ifcw::classification::IfcClassificationReference::GetItemReference ( ) const

Getter for the reference item reference.

Returns
The reference item reference

◆ GetLocation()

const Dtk_string& Ifcw::classification::IfcClassificationReference::GetLocation ( ) const

Getter for the reference location.

Returns
The reference location

◆ GetName()

const Dtk_string& Ifcw::classification::IfcClassificationReference::GetName ( ) const

Getter for the reference name.

Returns
The reference name

◆ GetReferencedSource()

const IfcClassification& Ifcw::classification::IfcClassificationReference::GetReferencedSource ( ) const

Getter for the classification the reference is linked to.

Returns
The classification the reference is linked to

◆ operator==()

Dtk_bool Ifcw::classification::IfcClassificationReference::operator== ( IfcClassificationReference  cr)
214  {
215  return referencedSource == cr.referencedSource && location == cr.location && itemReference == cr.itemReference && name == cr.name;
216  };

◆ SetItemReference()

void Ifcw::classification::IfcClassificationReference::SetItemReference ( const Dtk_string inItemReference)

Setter for the reference item reference.

Parameters
[in]inItemReference: reference item reference to be used

◆ SetLocation()

void Ifcw::classification::IfcClassificationReference::SetLocation ( const Dtk_string inLocation)

Setter for the reference location.

Parameters
[in]inLocation: reference location to be used

◆ SetName()

void Ifcw::classification::IfcClassificationReference::SetName ( const Dtk_string inName)

Setter for the reference name.

Parameters
[in]inName: reference name to be used