UDDInputData class
This class contains user input data and can be used in the generated document. UDDInputData has the constructor UDDInputData(string name) and the following properties accessors:
| Property accessor | Purpose | Form |
| Name | Get/Set the name of an input. | string Name(); |
| Type | Get/Set the type of an input | string Type(); |
The data can be any of the following types, based on the UDDInputParams type specified in the script.
UDDInputBool
| Method purpose | Return Value | Data type of the returned value in C# |
| Retrieves boolean value of the input data. | a boolean value of input data | string Data(); |
UDDInputDouble
| Method purpose | Return Value | Data type of the returned value in C# |
| Retrieves double data. | a double value of input data | double Data(); |
UDDInputSolution
| Method purpose | Return Value | Data type of the returned value in C# |
| Retrieves x and y double data for a probe | Data collection | IDictionary<double, double> DoubleData(string name); |
| Retrieves x and y double data for a probe for a particular variation | Data collection | IDictionary<double, double> DoubleData(string name, IDictionary<string, string> variation); |
| Retrieves x and y complex data for a probe | Data collection | IDictionary<double, double[]> ComplexData(string name); |
| Retrieves x and y complex data for a probe for a particular variation | Data collection | IDictionary<double, double[]> ComplexData(string name, IDictionary<string, string> variation); |
| Retrieves x and y text data for a probe | Data collection | IDictionary<string, string> TextData(string name, IDictionary<string, string> variation); |
| Retrieves x and y text data for a probe for a particular variation | Data collection | IDictionary<string, string> TextData(string name); |
| Retrieves a list of category names | A string collection | IList<string> CategoryNames(); |
| Retrieves a list of quantity names given a category name | A string collection | IList<string> QuantityNames(string category); |
| Retrieves a list of variable values | A string collection | IList<Dictionary<string, string>> VariableValues(); |
UDDInputText
| Method purpose | Return Value | Data type of the returned value in C# |
| Retrieves string data | a string value of input data | string Data(); |
UDDInputTrace
| Method purpose | Return Value | Data type of the returned value in C# |
| Retrieves x and y double data | Double | IDictionary<double, double> DoubleData(); |
| Retrieves x and y double data for a particular variation | Double | IDictionary<double, double> DoubleData(IDictionary<string, string> variation); |
| Retrieves x and y complex data | Double | IDictionary<double, double[]> ComplexData(); |
| Retrieves x and y complex data for a particular variation | Double | IDictionary<double, double[]> ComplexData(IDictionary<string, string> variation); |
| Retrieves x and y text data | Text | IDictionary<string, string> TextData(); |
| Retrieves x and y text data for a particular variation | Text | IDictionary<string, string> TextData(IDictionary<string, string> variation); |
| Retrieves a list of variable values | A string collection | IList<Dictionary<string, string>> VariableValues(); |
| Retrieves an image of the trace data in a plot | An image | string Image(); |