Product Documentation
Virtuoso Studio Design Environment SKILL Reference
Product Version IC23.1, November 2023

phoTechLoadModePropDataTable

phoTechLoadModePropDataTable(
d_techID
t_path(
[ ?waveguideDefName t_waveguideDefName ]
[ ?localOnly g_localOnly ]
[ ?overwrite g_overwrite ]
)
=> t / nil

Description

(Virtuoso Photonics Option) Loads the modeProp table from the specified data file for the given waveguide definition and stores it in the library data.dm file. If no waveguideDef is specified, the modeProp table is loaded for all the waveguide definitions encountered in the data file.

Arguments

d_techID

ID of the technology database file in which the specified waveguideDef is stored.

t_path

Path to the data file.

?localOnly g_localOnly

A boolean parameter indicating how modeProp table is retrieved.

  • When set to t, the contents of the specified modeProp table is retrieved only from the local technology database. This is the default.
  • When set to nil, the table is assembled from the modeProp tables in the technology database hierarchy.

The value of this parameter is saved in the technology database so that every individual modeProp table has its localOnly flag. Once set, this flag permanently affects the modeProp table contents exposed to the modeProp APIs.

This default value t is in effect for the modeProp tables created by the older versions of this API.

?overwrite g_overwrite

A boolean parameter indicating whether content of the data file  overwrites the existing modeProp table.

  • When set to t, the content of the data file completely overwrites the existing modeProp table. This is the default.
  • When set to nil, the content of the data file is merged into the existing modeProp table.

t_waveguideDefName

Name of the waveguide definition.

Value Returned

t

At least one waveguideDef table was loaded successfully.

nil

No waveguideDef table was loaded successfully.

Example

(system "cat data.txt")
> waveguideDefName "SiN Waveguide"
> mode 99 = "TE"
> mode 100 = "TM"
> 1 0 0 0  99 0 0 0 0
> 1 0 0 0 100 0 0 0 0
>
phoTechLoadModePropDataTable(tech "data.txt" ?waveguideDefName "SiN Waveguide")
> t

Additional Information

To successfully load a waveguideDef table, here are a few related prerequisites that should be fulfilled:

Related Topics

Photonics Flow Functions


Return to top
 ⠀
X