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_string &	GetItemReference () const
	Getter for the reference item reference. More...
const Dtk_string &	GetLocation () const
	Getter for the reference location. More...
const Dtk_string &	GetName () const
	Getter for the reference name. More...
const IfcClassification &	GetReferencedSource () const
	Getter for the classification the reference is linked to. More...
	IfcClassificationReference (Dtk_string inLocation="", Dtk_string inItemReference="", Dtk_string inName="", IfcClassification inReferencedSource=IfcClassification())
	Base constructor. More...
void	SetItemReference (Dtk_string inItemReference)
	Setter for the reference item reference. More...
void	SetLocation (Dtk_string inLocation)
	Setter for the reference location. More...
void	SetName (Dtk_string inName)
	Setter for the reference name. More...

Friends
bool	operator== (IfcClassificationReference const &lhs, IfcClassificationReference const &rhs)

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()

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

Base constructor.

Remarks

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

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

SetItemReference()

void Ifcw::classification::IfcClassificationReference::SetItemReference

(

Dtk_string

inItemReference

)

Setter for the reference item reference.

Parameters

[in]

inItemReference

: reference item reference to be used

SetLocation()

void Ifcw::classification::IfcClassificationReference::SetLocation

(

Dtk_string

inLocation

)

Setter for the reference location.

Parameters

[in]

inLocation

: reference location to be used

SetName()

void Ifcw::classification::IfcClassificationReference::SetName

(

Dtk_string

inName

)

Setter for the reference name.

Parameters

[in]

inName

: reference name to be used

Friends And Related Function Documentation

operator==

bool operator== ( IfcClassificationReference const &  lhs, IfcClassificationReference const &  rhs  )

friend

               {
                    return lhs.referencedSource == rhs.referencedSource
                    && lhs.location == rhs.location
                    && lhs.itemReference == rhs.itemReference && lhs.name == rhs.name;
               };