DescLevel Struct Reference

#include <lib_description.h>

Detailed Description

Represents a level within a DescID.

Public Member Functions

constexpr DescLevel (Int32 t_id)
 
constexpr DescLevel (Int32 t_id, Int32 t_datatype, Int32 t_creator)
 
Bool operator== (const DescLevel &d) const
 
Bool operator!= (const DescLevel &d) const
 
String ToString (const maxon::FormatStatement *formatStatement=nullptr) const
 

Public Attributes

Int32 id
 
Int32 dtype
 
Int32 creator
 

Constructor & Destructor Documentation

◆ DescLevel() [1/2]

constexpr DescLevel ( Int32  t_id)
constexpr

Constructor, specifying only the ID.

Parameters
[in]t_idInitial value for id.

◆ DescLevel() [2/2]

constexpr DescLevel ( Int32  t_id,
Int32  t_datatype,
Int32  t_creator 
)
constexpr
Parameters
[in]t_idInitial value for id.
[in]t_datatypeInitial value for dtype.
[in]t_creatorInitial value for creator.

Member Function Documentation

◆ operator==()

Bool operator== ( const DescLevel d) const

Equality operator. Checks if description levels are equals i.e all vales are equal.

Parameters
[in]dA description level to compare with.
Returns
true if description levels are equal, otherwise false.

◆ operator!=()

Bool operator!= ( const DescLevel d) const

Inequality operator. Checks if description levels are not equal i.e any vales is different.

Parameters
[in]dA description level to compare with.
Returns
true if description levels are not equal, otherwise false.

◆ ToString()

String ToString ( const maxon::FormatStatement formatStatement = nullptr) const

Member Data Documentation

◆ id

Int32 id

ID of the level.

◆ dtype

Int32 dtype

Data type. Either a custom ID or one of these: DTYPE.

◆ creator

Int32 creator

Creator ID.