DATAKIT API  V2025.1
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, const Dtk_string &inSetName="")
 Adds a property to IfcElement current property set. More...
 
const Dtk_stringGetBuildingElementType () const
 Getter for IfcElement building element type. More...
 
const classification::IfcClassificationReferenceGetClassificationReference () const
 Getter for classification reference. More...
 
Dtk_RGB GetColor () const
 Getter for IfcElement color. More...
 
const Dtk_stringGetGUID () const
 Getter for IfcElement GUID. More...
 
const Dtk_transfoGetInstanceTrf () const
 Getter for IfcElement instance transformation matrice. More...
 
const Dtk_stringGetLevel () const
 Getter for IfcElement level. More...
 
const Dtk_stringGetName () const
 Getter for IfcElement name. More...
 
const Dtk_stringGetPredefinedType () const
 Getter for IfcElement predefined type. More...
 
Dtk_MetaDataPtr GetPropertyAtPos (Dtk_Size_t pos) const
 Getter for a single IfcElement property. More...
 
const Dtk_tab< Dtk_MetaDataPtr > & GetPropertySet () const
 Getter for IfcElement propertySet. More...
 
const Dtk_stringGetTag () const
 Getter for IfcElement tag. More...
 
Dtk_ID GetTypeID () const
 Getter for IfcType ID. More...
 
 IfcElement ()
 Base constructor. More...
 
void SetBuildingElementType (const Dtk_string &inType)
 Setter for IfcElement building element type. More...
 
void SetBuildingElementType (IfcBuildingElement inTypeEnum)
 Setter for IfcElement building element type. 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 (const Dtk_string &inGUID)
 Setter for IfcElement GUID. More...
 
void SetInstanceTrf (const Dtk_transfo &inTrf)
 Setter for IfcElement instance transformation matrice. More...
 
void SetLevel (const Dtk_string &inLevel)
 Setter for IfcElement level. More...
 
void SetName (const 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 SetTag (const Dtk_string &inTag)
 Setter for IfcElement tag. More...
 
void SetTypeID (const Dtk_ID &inID)
 Setter for IfcElement IfcType ID. More...
 
 ~IfcElement ()
 Destructor. 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
//...
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 ( )

Base constructor.

◆ ~IfcElement()

Ifcw::IfcElement::~IfcElement ( )

Destructor.

Member Function Documentation

◆ AddProperty()

void Ifcw::IfcElement::AddProperty ( Dtk_MetaDataPtr  inProperty,
const 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

◆ GetBuildingElementType()

const Dtk_string& Ifcw::IfcElement::GetBuildingElementType ( ) const

Getter for IfcElement building element type.

Returns
The building element type assigned in the IfcElement

◆ GetClassificationReference()

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

Getter for classification reference.

Returns
The classification reference assigned in the IfcElement

◆ GetColor()

Dtk_RGB Ifcw::IfcElement::GetColor ( ) const

Getter for IfcElement color.

Returns
The color assigned in the IfcElement

◆ GetGUID()

const Dtk_string& Ifcw::IfcElement::GetGUID ( ) const

Getter for IfcElement GUID.

Returns
The GUID assigned in the IfcElement.

◆ GetInstanceTrf()

const Dtk_transfo& Ifcw::IfcElement::GetInstanceTrf ( ) const

Getter for IfcElement instance transformation matrice.

Returns
The instance transformation matrice assigned in the IfcElement

◆ GetLevel()

const Dtk_string& Ifcw::IfcElement::GetLevel ( ) const

Getter for IfcElement level.

Returns
The level assigned in the IfcElement.

◆ GetName()

const Dtk_string& Ifcw::IfcElement::GetName ( ) const

Getter for IfcElement name.

Returns
The name assigned in the IfcElement

◆ GetPredefinedType()

const Dtk_string& Ifcw::IfcElement::GetPredefinedType ( ) const

Getter for IfcElement predefined type.

Returns
The building element predefined type assigned in the IfcElement

◆ GetPropertyAtPos()

Dtk_MetaDataPtr Ifcw::IfcElement::GetPropertyAtPos ( Dtk_Size_t  pos) const

Getter for a single IfcElement property.

Parameters
[in]pos: The position in the table for the property to retrieve
Returns
The property at position pos

◆ GetPropertySet()

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

Getter for IfcElement propertySet.

Returns
The table of propertySet assigned to the IfcElement

◆ GetTag()

const Dtk_string& Ifcw::IfcElement::GetTag ( ) const

Getter for IfcElement tag.

Returns
The tag assigned in the IfcElement.

◆ GetTypeID()

Dtk_ID Ifcw::IfcElement::GetTypeID ( ) const

Getter for IfcType ID.

Returns
The ID of the current object type

◆ SetBuildingElementType() [1/2]

void Ifcw::IfcElement::SetBuildingElementType ( const Dtk_string inType)

Setter for IfcElement building element type.

Parameters
[in]inType: The building element type to be assigned in the IfcElement

◆ SetBuildingElementType() [2/2]

void Ifcw::IfcElement::SetBuildingElementType ( IfcBuildingElement  inTypeEnum)

Setter for IfcElement building element type.

Parameters
[in]inTypeEnum: The building element type to be assigned in the IfcElement

◆ 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 ( const 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 ( const Dtk_string inLevel)

Setter for IfcElement level.

Parameters
[in]inLevel: The level to be assigned in the IfcElement

◆ SetName()

void Ifcw::IfcElement::SetName ( const 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")

◆ SetTag()

void Ifcw::IfcElement::SetTag ( const 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 IfcType ID.

Parameters
[in]inID: The type ID to be assigned in the IfcElement
Ifcw::IfcElement
This class provides several parameters for the next ifc entity to be written, as its custom property ...
Definition: IFCWriter.h:356
Dtk_string
This is a high level string class.
Definition: dtk_string.hpp:58
Ifcw::IfcElement::IfcElement
IfcElement()
Base constructor.
Dtk_ErrorStatus
Dtk_ErrorStatus
Definition: error_dtk.hpp:6
Ifcw::InitObject
DtkErrorStatus InitObject(const IfcElement &inParameters)
Initialize an ifcobject with various information.