Ifcw::IfcElement Class Reference

This class provides several parameters for the next ifc entity to be written, as its custom property set, level, classification.
It must be provided to Ifcw::InitObject method. More...

Public Member Functions
void	AddProperty (Dtk_MetaDataPtr inProperty, Dtk_string inSetName="")
	Adds a property to IfcElement current property set. More...
const classification::IfcClassificationReference &	GetClassificationReference () const
	Getter for classification reference. More...
Dtk_RGB	GetColor () const
	Getter for IfcElement color. More...
const Dtk_string &	GetGUID () const
	Getter for IfcElement GUID. More...
const Dtk_transfo &	GetInstanceTrf () const
	Getter for IfcElement instance transformation matrice. More...
const Dtk_string &	GetLevel () const
	Getter for IfcElement level. More...
const Dtk_string &	GetName () const
	Getter for IfcElement name. More...
const Dtk_string &	GetPredefinedType () const
	Getter for IfcElement predefined type. More...
const Dtk_tab< Dtk_MetaDataPtr > &	GetPropertySet () const
	Getter for IfcElement propertySet. More...
const Dtk_string &	GetSubtype () const
	Getter for IfcElement subtype. More...
const Dtk_string &	GetTag () const
	Getter for IfcElement tag. More...
Dtk_ID	GetTypeID () const
	Getter for IfcElementType ID. More...
	IfcElement ()
	Default constructor. More...
void	SetClassificationReference (classification::IfcClassificationReference inClassificationRef)
	Setter for IfcElement classification reference. More...
void	SetColor (const Dtk_RGB &inColor)
	Setter for IfcElement color. More...
void	SetGUID (Dtk_string inGUID)
	Setter for IfcElement GUID. More...
void	SetInstanceTrf (const Dtk_transfo &inTrf)
	Setter for IfcElement instance transformation matrice. More...
void	SetLevel (Dtk_string inLevel)
	Setter for IfcElement level. More...
void	SetName (Dtk_string inName)
	Setter for IfcElement name. More...
void	SetPredefinedType (const Dtk_string &inType)
	Setter for IfcElement predefined type. More...
void	SetPropertySet (Dtk_tab< Dtk_MetaDataPtr > inProperties, const Dtk_string &inSetName="")
	Setter for IfcElement propertySet. More...
void	SetSubtype (Dtk_string inType)
	Setter for IfcElement subtype. More...
void	SetSubtype (typing::predefined::BuildingElement inEnum)
	Setter for IfcElement subtype. More...
void	SetSubtype (typing::predefined::DistributionElement inEnum)
	Setter for IfcElement subtype. More...
void	SetTag (Dtk_string inTag)
	Setter for IfcElement tag. More...
void	SetTypeID (const Dtk_ID &inID)
	Setter for IfcElement IfcElementType ID. More...

Detailed Description

This class provides several parameters for the next ifc entity to be written, as its custom property set, level, classification.
It must be provided to Ifcw::InitObject method.

Remarks

The propertySet can gather properties from different IfcPropertySet, we'll write as many set as there are different set names

See also

SetPropertySet, AddProperty

https://standards.buildingsmart.org/IFC/DEV/IFC4_2/FINAL/HTML/schema/ifcproductextension/lexical/ifcelement.htm

//...
Dtk_string ifcType = L"IFCWALL";
Ifcw::IfcElement* entityParams = new IfcElement();
entityParams->SetIfcType( ifcType );
Dtk_ErrorStatus err = Ifcw::InitObject( entityParams );
//...

Constructor & Destructor Documentation

IfcElement()

Ifcw::IfcElement::IfcElement

(

)

Default constructor.

Member Function Documentation

AddProperty()

void Ifcw::IfcElement::AddProperty	(	Dtk_MetaDataPtr	inProperty,
		Dtk_string	inSetName = ""
	)

Adds a property to IfcElement current property set.

Parameters

[in]	inProperty	: The property to be added to the property set
[in]	inSetName	: The name of the property set in which the property belong

GetClassificationReference()

const classification::IfcClassificationReference& Ifcw::IfcElement::GetClassificationReference

(

)

const

Getter for classification reference.

Returns

The classification reference assigned in the IfcElement

{ return classificationReference; }

GetColor()

Dtk_RGB Ifcw::IfcElement::GetColor

(

)

const

Getter for IfcElement color.

Returns

The color assigned in the IfcElement

{ return color; }

GetGUID()

const Dtk_string& Ifcw::IfcElement::GetGUID

(

)

const

Getter for IfcElement GUID.

Returns

The GUID assigned in the IfcElement.

{ return GUID; }

GetInstanceTrf()

const Dtk_transfo& Ifcw::IfcElement::GetInstanceTrf

(

)

const

Getter for IfcElement instance transformation matrice.

Returns

The instance transformation matrice assigned in the IfcElement

{ return instanceTrf; }

GetLevel()

const Dtk_string& Ifcw::IfcElement::GetLevel

(

)

const

Getter for IfcElement level.

Returns

The level assigned in the IfcElement.

{ return level; }

GetName()

const Dtk_string& Ifcw::IfcElement::GetName

(

)

const

Getter for IfcElement name.

Returns

The name assigned in the IfcElement

{ return name; }

GetPredefinedType()

const Dtk_string& Ifcw::IfcElement::GetPredefinedType

(

)

const

Getter for IfcElement predefined type.

Returns

The building element predefined type assigned in the IfcElement

{ return predefinedType; }

GetPropertySet()

const Dtk_tab<Dtk_MetaDataPtr>& Ifcw::IfcElement::GetPropertySet

(

)

const

Getter for IfcElement propertySet.

Returns

The table of propertySet assigned to the IfcElement

{ return propertySet; }

GetSubtype()

const Dtk_string& Ifcw::IfcElement::GetSubtype

(

)

const

Getter for IfcElement subtype.

Returns

The element subtype assigned in the IfcElement

{ return subtype; }

GetTag()

const Dtk_string& Ifcw::IfcElement::GetTag

(

)

const

Getter for IfcElement tag.

Returns

The tag assigned in the IfcElement.

{ return tag; }

GetTypeID()

Dtk_ID Ifcw::IfcElement::GetTypeID

(

)

const

Getter for IfcElementType ID.

Returns

The ID of the current object type

{ return typeID; }

SetClassificationReference()

void Ifcw::IfcElement::SetClassificationReference

(

classification::IfcClassificationReference

inClassificationRef

)

Setter for IfcElement classification reference.

Parameters

[in]

inClassificationRef

: The classification reference to be assigned in the IfcElement

SetColor()

void Ifcw::IfcElement::SetColor

(

const Dtk_RGB &

inColor

)

Setter for IfcElement color.

Parameters

[in]

inColor

: The color to be assigned in the IfcElement

SetGUID()

void Ifcw::IfcElement::SetGUID

(

Dtk_string

inGUID

)

Setter for IfcElement GUID.

Parameters

[in]

inGUID

: The GUID to be assigned in the IfcElement

SetInstanceTrf()

void Ifcw::IfcElement::SetInstanceTrf

(

const Dtk_transfo &

inTrf

)

Setter for IfcElement instance transformation matrice.

Parameters

[in]

inTrf

: The instance transformation matrice to be assigned in the IfcElement

SetLevel()

void Ifcw::IfcElement::SetLevel

(

Dtk_string

inLevel

)

Setter for IfcElement level.

Parameters

[in]

inLevel

: The level to be assigned in the IfcElement

SetName()

void Ifcw::IfcElement::SetName

(

Dtk_string

inName

)

Setter for IfcElement name.

Parameters

[in]

inName

: The name to be assigned in the IfcElement

SetPredefinedType()

void Ifcw::IfcElement::SetPredefinedType

(

const Dtk_string &

inType

)

Setter for IfcElement predefined type.

Parameters

[in]

inType

: The building element predefined type to be assigned in the IfcElement

SetPropertySet()

void Ifcw::IfcElement::SetPropertySet	(	Dtk_tab< Dtk_MetaDataPtr >	inProperties,
		const Dtk_string &	inSetName = ""
	)

Setter for IfcElement propertySet.

Parameters

[in]	inProperties	: The property set to be attached to the IfcElement
[in]	inSetName	: The name of the property set (default is "UserDefined")

SetSubtype() [1/3]

void Ifcw::IfcElement::SetSubtype

(

Dtk_string

inType

)

Setter for IfcElement subtype.

Parameters

[in]

inType

: The element subtype to be assigned in the IfcElement

SetSubtype() [2/3]

void Ifcw::IfcElement::SetSubtype

(

typing::predefined::BuildingElement

inEnum

)

Setter for IfcElement subtype.

Parameters

[in]

inEnum

: The building element subtype to be assigned in the IfcElement

SetSubtype() [3/3]

void Ifcw::IfcElement::SetSubtype

(

typing::predefined::DistributionElement

inEnum

)

Setter for IfcElement subtype.

Parameters

[in]

inEnum

: The distribution element subtype to be assigned in the IfcElement

SetTag()

void Ifcw::IfcElement::SetTag

(

Dtk_string

inTag

)

Setter for IfcElement tag.

Parameters

[in]

inTag

: The tag to be assigned in the IfcElement

SetTypeID()

void Ifcw::IfcElement::SetTypeID

(

const Dtk_ID &

inID

)

Setter for IfcElement IfcElementType ID.

Parameters

[in]

inID

: The type ID to be assigned in the IfcElement