MULTIPARAM
MULTIPARAM
Class Functions
New
MyVariable = MULTIPARAM.New (Tag, Desc1, Desc2, Index, Value, Prompt)
Tag | STRING |
Unique Identifier |
Desc1 | VECTOR |
Vector of STRING containing the user selections |
Desc2 | VECTOR | Vector of STRING containing the extra description which is displayed when the user switches the selection |
Index | INDEX |
Initial selection of the multiparam |
Value | REAL |
Initial value of the multiparam |
Prompt | STRING | Used by setup to prompt operator input |
Example Inputs
Tag = “DISCHARGEMODE”
Desc1 = VectorNew(3)
Desc1 [0] = “Constant Current”
Desc1 [1] = “Constant Resistance”
Desc1 [2] = “Constant Power”
Desc2= VectorNew(3)
Desc2 [0] = “A”
Desc2 [1] = “ohm”
Desc2 [2] = “W”
Index = 0
Value = 1.0
Prompt = “Discharge Mode”
Instance Functions
Printl
Tag | STRING |
Optional. Used to print a different tag than the one used in the call to .New |
The output for the Printl will look like
Tag<tab>MULTIPARAM<tab>Value <tab>Count<tab>Desc1_1<tab>..Desc1_[Count- 1]<tab>Desc2_1<tab>…Desc2_[Count – 1]<tab>Index<tab>Prompt
Using Example Inputs the output would look like:
DISCHARGEMODE<tab>1.0<tab>3<tab>Constant Current<tab>Constant Resistance<tab>Constant Power<tab>A<tab>ohm<tab>W<tab>0<tab>Discharge Mode
Value
Value | REAL |
The current value of the Multiparam object |
Using Example Inputs the Value would equal 1.0
SetValue
Value | REAL |
New value of the Multiparam object |
SetIndex
Index | INDEX |
New Index of the Multiparam object |
Index
Index | INDEX |
The current Index of the Multiparam object |
Using Example Inputs the Index would equal 0.
Desc1
Desc1 | VECTOR | A Vector of STRING containing the different selections specified during the call to .New |
Using Example Inputs the Desc1would be a vector of 3 containing:
Desc1 [0] = “Constant Current”
Desc1 [1] = “Constant Resistance”
Desc1 [2] = “Constant Power”
Desc2
Desc2 = Multiparam.Multipliers()
Desc2 | VECTOR |
A vector of STRING containing the different extra descriptions specified during the call to .New |
Using Example Inputs the Desc2 would be a vector of 3 containing:
Desc2 [0] = “A”
Desc2 [1] = “ohm”
Desc2 [2] = “W”
Comments are closed.