## On this page

  

 

 # MacroArg Class Reference

 Last update: 16.07.2025 

a function argument of a macro [More...](class_macro_arg.xhtml#details)

## <a name="pub-types"></a>Public Types

enum [eDataType](class_macro_arg.xhtml#acc461328b82c34604e8b428326a52183) {   
 **STRING** = 0, [INT](class_macro_arg.xhtml#acc461328b82c34604e8b428326a52183afd5a5f51ce25953f3db2c7e93eb7864a), [FLOAT](class_macro_arg.xhtml#acc461328b82c34604e8b428326a52183a9cf4a0866224b0bb4a7a895da27c9c4c), [BOOL](class_macro_arg.xhtml#acc461328b82c34604e8b428326a52183ae663dbb8f8244e122acb5bd6b2c216e1),   
 [MATRIX](class_macro_arg.xhtml#acc461328b82c34604e8b428326a52183a1d20a1221a789adf82ff0e890a403210), [I\_SCALAR\_IDENT](class_macro_arg.xhtml#acc461328b82c34604e8b428326a52183a7c2420d7c7137cc06efe15a56b1fc881), **I\_SCALAR\_IDENT\_VECTOR**, [I\_NODE\_IDENT](class_macro_arg.xhtml#acc461328b82c34604e8b428326a52183aa72282b0466f246c40b808d4dbc3e6c0),   
 **I\_NODE\_IDENT\_VECTOR**, **I\_ELEMENT\_IDENT**, **I\_ELEMENT\_IDENT\_VECTOR**, [O\_SCALAR\_IDENT](class_macro_arg.xhtml#acc461328b82c34604e8b428326a52183af09fda39fab3ac5d951ec84a6ab0353f),   
 **O\_SCALAR\_IDENT\_VECTOR**, **O\_NODE\_IDENT**, **O\_NODE\_IDENT\_VECTOR**, **O\_ELEMENT\_IDENT**,   
 **O\_ELEMENT\_IDENT\_VECTOR**, **REMOVE\_SCALAR\_IDENT**, **REMOVE\_NODE\_IDENT**, **REMOVE\_ELEMENT\_IDENT**,   
 **DATABASE**, **DESIGN\_IDENT**, **FIELDMOP\_NODE\_IDENT**, **FIELDMOP\_ELEMENT\_IDENT**,   
 **MOP\_SCALAR\_IDENT**, **RF\_NODE\_IDENT**, **RF\_ELEMENT\_IDENT**, **NAMED\_SELECTION\_NODE**,   
 **NAMED\_SELECTION\_ELEMENT**, **UNKNOWN**  
 } the enum data type for defining teh data type of the argument in script context [More...](class_macro_arg.xhtml#acc461328b82c34604e8b428326a52183)  
 ## <a name="pub-methods"></a>Public Member Functions

string [help](class_macro_arg.xhtml#a43d1a663cb090d6ed2d92e6c8b1e3006) () string [ident](class_macro_arg.xhtml#ad788420ef7464c550bfffb4e280eb417) ()  [MacroArg](class_macro_arg.xhtml#ae9e47fd6f7791974ed0375f66d0133be) ([eDataType](class_macro_arg.xhtml#acc461328b82c34604e8b428326a52183) p\_type, string p\_ident, string p\_help, string [start](class_macro_arg.xhtml#a39e6ecc475b63fbcb6444caf0586d177)="", string [min](class_macro_arg.xhtml#a263903e463638a5792d1a2340c72dbc5)="", string [max](class_macro_arg.xhtml#abf6330e35664e2ea7e368533df19500e)="") constructor [More...](#ae9e47fd6f7791974ed0375f66d0133be)  
 <a id="a88d12ab39b2bdc8e9befc2dfe8b81e9a"></a> [MacroArg](class_macro_arg.xhtml#a88d12ab39b2bdc8e9befc2dfe8b81e9a) () default constructor   
 string [max](class_macro_arg.xhtml#abf6330e35664e2ea7e368533df19500e) () Get the maximum value as a string. [More...](#abf6330e35664e2ea7e368533df19500e)  
 string [min](class_macro_arg.xhtml#a263903e463638a5792d1a2340c72dbc5) () Get the minimum value as a string. [More...](#a263903e463638a5792d1a2340c72dbc5)  
 bool [operator==](class_macro_arg.xhtml#acaf3cf4ffccd2f30ac43781d3369cdea) ([MacroArg](class_macro_arg.xhtml) arg) comparison operator [More...](#acaf3cf4ffccd2f30ac43781d3369cdea)  
 string [start](class_macro_arg.xhtml#a39e6ecc475b63fbcb6444caf0586d177) () Get the start value as a string. [More...](#a39e6ecc475b63fbcb6444caf0586d177)  
 [eDataType](class_macro_arg.xhtml#acc461328b82c34604e8b428326a52183) [type](class_macro_arg.xhtml#a1ac0f4dc9ae2493c2f505317116307f9) () string [type\_string](class_macro_arg.xhtml#ae5083b4b6dcb0966f2e262e03b42d79f) () ## <a name="pub-static-methods"></a>Static Public Member Functions

static [eDataType](class_macro_arg.xhtml#acc461328b82c34604e8b428326a52183) [type\_from\_string](class_macro_arg.xhtml#ad02f6c682c9debeb162943c742f3141e) (string s) <a id="details" name="details"></a>## Detailed Description

a function argument of a macro



## Member Enumeration Documentation

<a id="acc461328b82c34604e8b428326a52183"></a>## [◆ ](#acc461328b82c34604e8b428326a52183)eDataType

 enum [eDataType](class_macro_arg.xhtml#acc461328b82c34604e8b428326a52183)

the enum data type for defining teh data type of the argument in script context

Enumerator<a id="acc461328b82c34604e8b428326a52183afd5a5f51ce25953f3db2c7e93eb7864a"></a>INT &lt; integer number, e.g. x = 1

<a id="acc461328b82c34604e8b428326a52183a9cf4a0866224b0bb4a7a895da27c9c4c"></a>FLOAT &lt; floating point number, e.g. x = 1.1

<a id="acc461328b82c34604e8b428326a52183ae663dbb8f8244e122acb5bd6b2c216e1"></a>BOOL &lt; boolean, e.g. x = true

<a id="acc461328b82c34604e8b428326a52183a1d20a1221a789adf82ff0e890a403210"></a>MATRIX &lt; tmath.Matrix, e.g. x = tmath.Matrix({{1,1}{2,3}}

<a id="acc461328b82c34604e8b428326a52183a7c2420d7c7137cc06efe15a56b1fc881"></a>I\_SCALAR\_IDENT &lt; a string

<a id="acc461328b82c34604e8b428326a52183aa72282b0466f246c40b808d4dbc3e6c0"></a>I\_NODE\_IDENT &lt; a string

<a id="acc461328b82c34604e8b428326a52183af09fda39fab3ac5d951ec84a6ab0353f"></a>O\_SCALAR\_IDENT &lt;





## Constructor &amp; Destructor Documentation

<a id="ae9e47fd6f7791974ed0375f66d0133be"></a>## [◆ ](#ae9e47fd6f7791974ed0375f66d0133be)MacroArg()

 [MacroArg](class_macro_arg.xhtml)  ( [eDataType](class_macro_arg.xhtml#acc461328b82c34604e8b428326a52183)  *p\_type*,    string  *p\_ident*,    string  *p\_help*,    string  *start* = `""`,    string  *min* = `""`,    string  *max* = `""`   ) 

constructor

Parameters p\_typethe data type of the argument p\_identthe ident of ther argument/variable. This ident must be a single word, starting with a letter. It may contain numbers and underscores, and is case sensitive. p\_helpthe help string describing this parameter 



## Member Function Documentation

<a id="a43d1a663cb090d6ed2d92e6c8b1e3006"></a>## [◆ ](#a43d1a663cb090d6ed2d92e6c8b1e3006)help()

 string help  ( ) 

Returnsreturns the help string 



<a id="ad788420ef7464c550bfffb4e280eb417"></a>## [◆ ](#ad788420ef7464c550bfffb4e280eb417)ident()

 string ident  ( ) 

Returnsreturns the ident 



<a id="abf6330e35664e2ea7e368533df19500e"></a>## [◆ ](#abf6330e35664e2ea7e368533df19500e)max()

 string max  ( ) 

Get the maximum value as a string.

ReturnsA string, empty, "inf", "-inf" or convertible to number 



<a id="a263903e463638a5792d1a2340c72dbc5"></a>## [◆ ](#a263903e463638a5792d1a2340c72dbc5)min()

 string min  ( ) 

Get the minimum value as a string.

ReturnsA string, empty, "inf", "-inf" or convertible to number 



<a id="acaf3cf4ffccd2f30ac43781d3369cdea"></a>## [◆ ](#acaf3cf4ffccd2f30ac43781d3369cdea)operator==()

 bool operator==  ( [MacroArg](class_macro_arg.xhtml)  *arg*) 

comparison operator

Parameters argthe variable to be tested Returnstrue if both are equal 



<a id="a39e6ecc475b63fbcb6444caf0586d177"></a>## [◆ ](#a39e6ecc475b63fbcb6444caf0586d177)start()

 string start  ( ) 

Get the start value as a string.

ReturnsA string, empty, "inf", "-inf" or convertible to number 



<a id="a1ac0f4dc9ae2493c2f505317116307f9"></a>## [◆ ](#a1ac0f4dc9ae2493c2f505317116307f9)type()

 [eDataType](class_macro_arg.xhtml#acc461328b82c34604e8b428326a52183) type  ( ) 

Returnsreturns the type 



<a id="ad02f6c682c9debeb162943c742f3141e"></a>## [◆ ](#ad02f6c682c9debeb162943c742f3141e)type\_from\_string()

 static [eDataType](class_macro_arg.xhtml#acc461328b82c34604e8b428326a52183) type\_from\_string  ( string  *s*)   static 

Returnsreturns the enum from the given string Parameters sthe string to be converted. It is equal to s = type\_string(type\_from\_string(s)), else exception. 



<a id="ae5083b4b6dcb0966f2e262e03b42d79f"></a>## [◆ ](#ae5083b4b6dcb0966f2e262e03b42d79f)type\_string()

 string type\_string  ( ) 

Returnsreturns the type as human readable string