Field | Type | Description |
---|---|---|
photonic_model |
string |
The name of the photonic model used for this template. Please visit here for a list of all available photonic models. |
get_compound
|
string |
A string containing the name of the compound element build solution. Available solutions are:
Note: Please note that in “file” the name of the compound should be the same as a “prefix” variable. |
debug_mode
|
boolean |
A Boolean value which controls whether to enter the debug mode for building the compound element. Note:
|
elements (optional for “script” solution)
|
cell |
Cell array containing structs that describe each element used in the internal circuit of the compound element. These elements can either be from the same library as the compound element or from the primitives library. Each element in this cell follows the structure described in the elements table. |
connection (optional for “script” solution)
|
cell |
Cell array containing structs that describe the connection of the elements of the internal circuit elements to each other and to the defined ports of the compound element (see port definitions). In this cell array, each cell defines one connection between two ports. Each element in this cell follows the structure described in the connections table. Note: The connection between ports of the internal circuit and compound element ports (see port definition) must be defined as structs in this cell array. To define a connection between an internal circuit port and an external compound element port, “name” variable and “port name” variable of the compound element must be used. |
setup_script_file (optional for “script” solution)
|
string |
The name of the .lsf file containing the setup script to be loaded into the Compound element Setup script. The setup script must be self-contained and include all the required data for the model. It also can reference user_defined parameters and statistical parameters. |
data (optional for “script” solution)
|
struct |
This struct can include the data required by the setup script. These data can be used in the setup script using "toscript" command. |
elements:
Field | Type | Description |
---|---|---|
element |
string |
A string which contains the name of the element to be added to the internal circuit. This element can either be from the same library as the compound element or from the primitives library |
name |
string |
A string which contains the name of the element after it is added to the schematic. |
property |
cell |
Cell array containing structs that describe the parameters of the added element that user wishes to modify and their values. These properties can be any modifiable properties of the specified element. Each struct contains the following fields:
|
connections:
Field | Type | Description |
---|---|---|
E1_name |
string |
The schematic name of the first element |
E1_port |
string |
The name of the port of the first element. |
E2_name |
string |
The user-defined name of the second element |
E2_port |
string |
The name of the port of the second element. |