Difference between revisions of "AxisSet getAxis"
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {{HelpFiles}} | |
| − | | ||
| − | ====AxisSet_getAxis==== | + | ==== AxisSet_getAxis ==== |
| − | Gets the axis by name from the axis-set belonging to the current DCS context. The axis object is returned as an array formated according to the description given for the axis object constructor function (see [[ | + | Gets the axis by name from the axis-set belonging to the current DCS context. The axis object is returned as an array formated according to the description given for the axis object constructor function (see [[Axis new|Axis_new]] for more information) |
| − | '''Syntax''' | + | '''Syntax''' |
| − | AxisSet_getAxis(''name'') | + | AxisSet_getAxis(''name'') |
| − | '''Arguments''' | + | '''Arguments''' |
| − | ''name'': Is a string expression, it is name of the axis to look up. | + | ''name'': Is a string expression, it is name of the axis to look up. |
| − | '''Return type''' | + | '''Return type''' |
| − | array | + | array |
| − | '''Examples''' | + | '''Examples''' |
| − | ''array axis = AxisSet_getAxis(" | + | ''array axis = AxisSet_getAxis("Sex");'' |
| − | '' | + | ''print(axis);'' |
| − | Version 5.5 | + | ''//Gets the axis by name from the axis-set belonging to the current DCS context (e.g : {0,Sex,Hvad er dit køn?,Sex,Sex != empty,False,{{1,Mand,Sex == [1],},{1,Kvinde,Sex == [2],}},} )'' |
| − | __NOTOC__ | + | |
| − | <!-- imported from file: 5233.htm--> | + | '''Availability''' |
| + | |||
| + | Version 5.5 __NOTOC__ <!-- imported from file: 5233.htm--> | ||
| + | |||
| + | [[Category:Axis_set_modifying_CGScript_functions]] | ||
Latest revision as of 10:32, 23 December 2011
AxisSet_getAxis
Gets the axis by name from the axis-set belonging to the current DCS context. The axis object is returned as an array formated according to the description given for the axis object constructor function (see Axis_new for more information)
Syntax
AxisSet_getAxis(name)
Arguments
name: Is a string expression, it is name of the axis to look up.
Return type
array
Examples
array axis = AxisSet_getAxis("Sex");
print(axis);
//Gets the axis by name from the axis-set belonging to the current DCS context (e.g : {0,Sex,Hvad er dit køn?,Sex,Sex != empty,False,{{1,Mand,Sex == [1],},{1,Kvinde,Sex == [2],}},} )
Availability
Version 5.5
