HFSS15: UDD Input interfaces

The Generate function takes in a list of inputs. These input interfaces allow the user to access data from the design.

IUDDInputBool : This interface exposes 3 methods

Name() : Gets the inputs name.

Type() : Gets the input type.

Data() : Gets the boolean data, set by the user in the setup dialog.

IUDDInputDouble : This interface exposes 3 methods

Name() : Gets the inputs name.

Type() : Gets the input type.

Data() : Gets the double data, set by the user in the setup dialog.

IUDDInputText : This interface exposes 3 methods

Name() : Gets the inputs name.

Type() : Gets the input type.

Data() : Gets the text data, set by the user in the setup dialog.

IUDDInputTrace : This interface exposes 3 methods

Name() : Gets the inputs name.

Type() : Gets the input type.

DoubleData() : Method used to return x and y double data as a IDictionary<double, double>

DoubleData(IDictionary<string, string> variation) : Method used to return x and y double data as a IDictionary<double, double>, given a variation.

ComplexData() : Method used to return x data and y complex data as a IDictionary<double, double[]>

ComplexData(IDictionary<string, string> variation) : Method used to return x data and y complex data as a IDictionary<double, double[]>, given a variation.

TextData() : Method used to return x data and y data as a IDictionary<string, string>

TextData(IDictionary<string, string> variation) : Method used to return x data and y data as a IDictionary<string, string>, given a variation.

VariableValues() : Method used to get a list of variations as a IList<Dictionary<string, string>>

IUDDInputSolution : This interface exposes 3 methods

Name() : Gets the inputs name.

Type() : Gets the input type.

DoubleData(string name) : Method used to return x and y double data as a IDictionary<double, double>, given a quantity name.

DoubleData(string name, IDictionary<string, string> variation) : Method used to return x and y double data as a IDictionary<double, double>, given a quantity name and a variation.

ComplexData(string name) : Method used to return x data and y complex data as a IDictionary<double, double[]>, given a quantity name.

ComplexData(string name, IDictionary<string, string> variation) : Method used to return x data and y complex data as a IDictionary<double, double[]>, given a quantity name and a variation.

TextData(string name) : Method used to return x data and y data as a IDictionary<string, string> given a quantity name.

TextData(string name, IDictionary<string, string> variation) : Method used to return x data and y data as a IDictionary<string, string>, given a quantity name and a variation.

CategoryNames() : Method to return a list of category names in the solution as an IList<string>

QuantityNames(string category) : Method to return a list of quantity names in the solution as an IList<string>, given a category.

VariableValues() : Method used to get alist of variations as a IList<Dictionary<string, string>>

Examples:

def Generate(self, input, docgen, progMon):

# Getting the boolean data set by the user

boolinput = input[0].Data()

# Getting the double data set by the user

dblinput = input[1].Data()

# Getting the text data set by the user

textinput = input[2].Data()

# Getting the category names in a solution

categories = input[3].CategoryNames()

# Getting the quantity names based on a category

quantities = input[3].QuantityNames(categories[0])

# Getting the XY data from the trace

xydata = input[4].DoubleData()