nlInitialize

nlInitialize( 
o_formatter 
) 
=> o_formatter / nil

Description

For the nlFormatter class, this method initializes the netlister. This method can be redefined for the simulator-specific netlister and is called by nlCreateFormatter. This method initializes all simulator-specific aspects of netlisting such as name mapping. For the nlAnalogFormatter class, this method sets a number of netlist options. These options and their values are shown in the table below.

To inspect the value of an option, use nlGetOption.

Option	Value
hierarchyDelimiter	"."
globalParamPrefix	"_gpar"
globalNetPrefix	""
instNamePrefix	"_inst"
invalidNetNames	'(("gnd!" "0"))
inhModelName	t / nil specifies whether the simulator provides support for model name passing. A nil value would result in an error if model name is passed through the hierarchy for a stopping instance.
linePrefix	"+"
linePostfix	nil
netNamePrefix	"_net"
mapInstFirstChar	special characters and numbers
mapInstInName	all special characters
mapModelFirstChar	all special characters and numbers
mapModelInName	all special characters
mapNetFirstChar	all special characters and numbers
mapNetInName	special characters
maxNameLength	1024
modulePrefix	"_sub"
paramNamePrefix	"_par"
subcktIndentString	four spaces
useInstNamePrefix	t

To change any of these settings, use callNextMethod() to inherit as much as possible and then make the changes.

Arguments

o_formatter

The formatter object.

Value Returned

o_formatter	The formatter object.
nil	The operation failed.

Examples

The following example uses callNextMethod to do the initialization in the nlAnalogFormatter class and then:

• Changes the hierarchy delimiter from “.” to “:”
• Changes the maximum name length from 1024 chars to 64 chars

defmethod( nlInitialize((formatter <yourSimulator>Formatter))
    let( (nlForm)
callNextMethod( formatter)
nlForm=nlGetNetlister( formatter ) 
nlSetOption( nlForm 'hierarchyDelimiter ":")
nlSetOption( nlForm 'maxNameLength 64)
formatter
) )

=> formatter1

Related Topics

The Netlister Object

Return to top