Ifcw::classification::IfcClassification Class Reference

A class that represents a classification system, like UniFormat, Omniclass, SfB...
More...

Public Member Functions
const Dtk_string &	GetEdition () const
	Getter for the classification edition. More...
const IfcCalendarDate &	GetEditionDate () const
	Getter for the classification edition date. More...
const Dtk_string &	GetName () const
	Getter for the classification name. More...
const Dtk_string &	GetSource () const
	Getter for the classification source. More...
	IfcClassification ()
	Base constructor. More...
	IfcClassification (Dtk_string inSource, Dtk_string inEdition, Dtk_string inName="")
	Constructor taking 3 parameters. More...
void	SetEdition (Dtk_string inEdition)
	Setter for the classification edition. More...
void	SetEditionDate (IfcCalendarDate inDate)
	Setter for the classification edition date. More...
void	SetEditionDate (int inDay, int inMonth, int inYear)
	Setter for the classification edition date. More...
void	SetName (Dtk_string inName)
	Setter for the classification name. More...
void	SetSource (Dtk_string inSource)
	Setter for the classification source. More...

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

Detailed Description

A class that represents a classification system, like UniFormat, Omniclass, SfB...

Remarks

Ifc objects are not directly link to IfcClassification in 2x3 and have to be linked to IfcClassificationReference

See also

IfcClassificationReference

https://standards.buildingsmart.org/IFC/DEV/IFC4_3/RC1/HTML/schema/ifcexternalreferenceresource/lexical/ifcclassification.htm

Constructor & Destructor Documentation

IfcClassification() [1/2]

Ifcw::classification::IfcClassification::IfcClassification

(

)

Base constructor.

Remarks

Should not be used because at classification source and edition are mandatory parameter.

IfcClassification() [2/2]

Ifcw::classification::IfcClassification::IfcClassification	(	Dtk_string	inSource,
		Dtk_string	inEdition,
		Dtk_string	inName = ""
	)

Constructor taking 3 parameters.

Parameters

[in]	inSource	: Classification source.
[in]	inEdition	: Classification edition.
[in]	inName	: Classification name.

Remarks

name is optionnal.

Member Function Documentation

GetEdition()

const Dtk_string& Ifcw::classification::IfcClassification::GetEdition

(

)

const

Getter for the classification edition.

Returns

The classification edition

GetEditionDate()

const IfcCalendarDate& Ifcw::classification::IfcClassification::GetEditionDate

(

)

const

Getter for the classification edition date.

Returns

The classification edition date

GetName()

const Dtk_string& Ifcw::classification::IfcClassification::GetName

(

)

const

Getter for the classification name.

Returns

The classification name

GetSource()

const Dtk_string& Ifcw::classification::IfcClassification::GetSource

(

)

const

Getter for the classification source.

Returns

The classification source

SetEdition()

void Ifcw::classification::IfcClassification::SetEdition

(

Dtk_string

inEdition

)

Setter for the classification edition.

Parameters

[in]

inEdition

: The classification edition to be used

SetEditionDate() [1/2]

void Ifcw::classification::IfcClassification::SetEditionDate

(

IfcCalendarDate

inDate

)

Setter for the classification edition date.

Parameters

[in]

inDate

: The ifc date to be used

SetEditionDate() [2/2]

void Ifcw::classification::IfcClassification::SetEditionDate	(	int	inDay,
		int	inMonth,
		int	inYear
	)

Setter for the classification edition date.

Parameters

[in]	inDay	: The day of date to be used
[in]	inMonth	: The month of date to be used
[in]	inYear	: The year of date to be used

SetName()

void Ifcw::classification::IfcClassification::SetName

(

Dtk_string

inName

)

Setter for the classification name.

Parameters

[in]

inName

: The classification name to be used

SetSource()

void Ifcw::classification::IfcClassification::SetSource

(

Dtk_string

inSource

)

Setter for the classification source.

Parameters

[in]

inSource

: The classification source to be used

Friends And Related Function Documentation

operator==

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

friend

               {
                    return lhs.editionDate == rhs.editionDate && lhs.source == rhs.source && lhs.edition == rhs.edition && lhs.name == rhs.name;
               };