Required Data
Parameter Script File
Port Definitions
Variable | Type | Description |
---|---|---|
ports | Cell |
A cell array containing structs which have information about each port. Every struct must contain the following fields:
|
Photonic Model
Variable | Type | Description |
---|---|---|
photonic_model |
string |
String containing the name of the photonic model used for this template. Please visit here for a list of all available photonic models. |
Cosmetic Variables
Variable | Type | Description |
---|---|---|
description | String | A string containing a brief description of the model, which will be displayed to the end user. |
prefix | String | A string containing the prefix of the model, which will be used within interconnect to provide incrementing element names for each successive element that is added to the simulation layout. |
notes | Cell |
A cell array which provides model notes that will be displayed to the end user. Each element of the cell is a struct with the fields:
|
Parameter Variables
Variable | Type | Description |
---|---|---|
parameters | Cell |
Cell arrays containing structs that describe each user-facing parameter to be added to the model. See below for more detail. |
enable_temperature_parameter | Boolean |
Enables temperature as a model parameter. |
temperature | Struct |
Struct with fields: default_value: a number in Kelvin or "%temperature%" to inherit from Root Element. unit: "C" or "K |
The parameters cell array contains structs which define parameters that will be added to the element, with values optionally accessible to end-users and inside the set-up script. Each structure defines properties of a single parameter, and contains the following fields:
Variable | Type | Description |
---|---|---|
name |
String |
A string which contains the name of the parameter |
category |
String |
A string which contains the name of the category that the parameter will be under within the property view of INTERCONNECT. The “CML” category is typically used for new properties. |
type |
String |
A string with the type of value allowed by this parameter. The options are given by the "Type" dropdown menu within the Property Editor in INTERCONNECT. Some examples:
|
kind |
String |
A string with the type of quantity described by this parameter. The values for this parameter correspond to the allowed values within the "Kind" dropdown menu within the Property Editor in INTERCONNECT. The "Kind" determines the units. Some example kinds are:
|
unit |
Sting |
A string with the unit of the parameter. This should be a valid unit with respect to the parameter kind set in the "kind" field, and must correspond to the allowed values for the "type" field. Some example units are:
|
annotate |
Boolean |
A boolean value which controls whether or not this parameter is annotated on the final INTERCONNECT element.
|
visible_to_user |
Boolean |
A boolean value which controls whether or not this parameter is present within the final INTERCONNECT element, or if it's hidden. |
default_value |
Number or String |
The default value of the parameter. Also, the fixed value of the parameter if visible_to_user is set to false. To inherit the value from a property in Root Element, set this to a string, e.g. "%temperature%".
|
min |
Number |
The minimum allowed parameter value. |
max |
Number |
The maximum allowed parameter value. |
Setup Script
Variable | Type | Description |
---|---|---|
setup_script |
String |
Loading string from setup script and adding required data using toscript command. |