Edit [component manager]

Modifies an existing component.

UI Access Tools > Edit Configured Libraries > Components > Edit Component
Parameters
Name Type  
<ComponentName> String Name of component to edit
<NewComponentName> String Name of the new component created from the edits
<Info> Array

Provides the component info. It includes the following:

"Type:=", <TypeInfo>,# see more information below

"NumTerminals:=", <int>,

"DataSource:=", <string>,

"ModifiedOn:=", <ModifiedOnInfo>,

"Manufacturer:=", "<string>,

"Symbol:=", <string>,

"Footprint:=", <string>,

"Description:=", <string>,

"InfoTopic:=", <string>,

"InfoHelpFile:=", <string>,

"IconFile:=", <string>,

"LibraryName:=", <string>,

"OriginalLocation:=", <string>, // Project Location

"Author:=", <string>,

"OriginalAuthor:=", <string>,

"CreationDate:= ", <int>)

<RefBase> String Reference designator
<NumParts> Integer

Parts per component

<OriginalComponent> String Name of the original component
<Terminal> Array  
<Parameters> Array

Optional; defines the parameters of the new component. It can include any or all of the following:

"VariableProp:=", <VariableInfo>,

"CheckboxProp:=", <CheckBoxInfo>,

"ButtonProp:=", <ButtonInfo>,

"TextProp:=", <TextInfo>,

"NumberProp:=", <NumberInfo>,

"SeparatorProp:=", <SeparatorInfo>,

"ValueProp:=", <ValueInfo>,

"MenuProp:=", <MenuInfo>

<Properties> Array

Optional; defines the properties of the new component. It can include any or all of the following:

"CheckboxProp:=", <CheckBoxInfo>,

"TextProp:=", <TextInfo>,

"NumberProp:=", <NumberInfo>,

"SeparatorProp:=",<SeparatorInfo>,

"ValueProp:=", <ValueInfo>,

"MenuProp:=", <MenuInfo>),

"VPointProp:=", <VPointInfo>,

"PointProp:=", <PointInfo>

The array structure for each property is defined below.

<Quantities> Array

("Quantities","QuantityProp:=", <QuantityPropInfo>...)

The <QuantityPropInfo> array is defined below.

<CosimDefInfo> Array

("NAME:CosimDefinitions", <CosimDefInfo>,<CosimDefInfo>...)

The<CosimDefInfo> array is defined below.

Return Value

The composite name of the component. If the name requested conflicts with the name of an existing component, the requested name is altered to be unique. The name returned reflects any change made to be unique.

<TypeInfo>:

An integer that is the or-ing of bits for each product listed below. The default setting is 0xffffffff (4294967295), which indicates valid for all products. In the component editing dialog box, checking different boxes in the "Specify products for which this component is valid" grid control sets specific flags that correspond to the following hex/decimal settings:

Nexxim – 100 binary, 4 decimal, 0x4

SIwaveDeNovo – 1000 binary, 8 decimal, 0x8

Simplorer – 10000 binary, 16 decimal, 0x10

MaxwellCircuit – 100000 binary, 32 decimal, 0x20

<ModifiedOnInfo>:

An integer that corresponds to the number of seconds that have elapsed since 00:00 hours, Jan 1, 1970 UTC from the system clock.

<TerminalInfo>:

[<string>, // symbol pin

<string> // footprint pin

<string >, // gate name

<bool>, // shared

<int>, // equivalence number

<int>, // what to do if unconnected: flag as error:0, ignore:1

<string>, // description

<Nature>]

 

<Nature>:

<string> // content varies as follows

 

Nexxim/Circuit:

"Electrical" // the only choice

 

Simplorer:

# choices include "Electrical", "Magnetic", "Fluidic", "Translational",

"Translational_V", "Rotational", "Rotational_V",

""Radiant", "Thermal", or <VHDLPackageName>

 

<VHDLPackageName>:

<string> # in the form <Library>.<Package>

<Library>:

<string> # name of the VHDL library

<Package>:

<string> # name of the VHDL package

<VariableInfo>:

[<string>, # name

<FlagLetters>,

<string>, # description

"CB:=", <string>, # optional - script for call back

<string>] # value: number, variable, or expression

 

<FlagLetters>:

<string> # "D" - has description parameter,

# "RD" - readonly & has description parameter,

# or "RHD" - readonly, hidden, & has description parameter

<CheckBoxInfo>:

[<string>, # name

<FlagLetters>,

<string>, # description

"CB:=", <string>, # optional - script for call back

<bool>] # value: true or false

 

<ButtonInfo>:

[<string>, # name

<FlagLetters>,

<string>, # description

<string>, # button title

<string>, # extra text

<ClientID>,

"ButtonPropClientData:= ", <ClientDataArray>]

 

<ClientID>:

<int> # specifies Button Prop Client:

# 0 - unknown, "ButtonPropClientData" array will be empty

# 1 - Netlist Prop Client

# 2 - not used

# 3 - File Name Prop Client

 

<ClientDataArray>:

varies with <ClientID>

 

<ClientID> is 0 or 1: empty array[]

<ClientID> is 3:

["InternalFormatText:=", "<prefix><RelativePath>"]

<prefix>:

<string> # "<Project>", "<PersonalLib>", "<UserLib>", or "<SysLib>"

<RelativePath>:

<string> # relative path to file from <prefix>

 

<TextInfo>:

[<string>, # name

<FlagLetters>,

<string>, # description

"CB:=", <string>, # optional - script for call back

<string>] # value: a text string

 

<NumberInfo>:

[<string>, # name

<FlagLetters>,

<string>, # description

"CB:=", <string>, # optional - script for call back

<real>, # value: a number

<string>] # units

<SeparatorInfo>:

[<string>, # name

<FlagLetters>,

<string>, # description

"CB:=", <string>, # optional - script for call back

<string>] # value: a text string

<ValueInfo>:

[<string>, # name

<FlagLetters>,

<string>, # description

"CB:=", <string>, # optional - script for call back

<string>] # value: a number, variable or expression

 

<MenuPropInfo>:

[<string>, # name

<FlagLetters>,

<string>, # description

<string>, # menu choices - separated by commas

<int>] # 0 based index of current menu choice

<VPointInfo>:

[<string>, # name

<FlagLetters>,

<string>, # description

"CB:=", <string>, # optional - script for call back

<string>, # x value: number with length units

<string>] # y value: number with length units

 

<PointInfo>:

[<string>, # name

<FlagLetters>,

<string>, # description

"CB:=", <string>, # optional - script for call back

<real>, # x value

<real>] # y value

 

<QuantityPropInfo>:

[<string>, # name

<FlagLetters>,

<string>, # description

<string>, # value

<TypeString>, # string, options are "Across", "Through", or "Free"

<TypeStringDependentInfo>]

 

<TypeStringDependentInfo>:

"Free" :

<string>, # direction: "In", "Out", "InOut", or "DontCare"

# Following <string> is not present if direction is "DontCare"

<string> # when to calculate: "BeforeAnalogSolver",

// "BeforeStateGraph", "AfterStateGraph", or "DontCareWhen"

"Across" or "Through"

<int>, # terminal 1

<int> # terminal 2

<CosimDefInfo>:

["NAME:CosimDefinition",

"CosimulatorType:=", <int>,

"CosimDefName:=", <string> # "HFSS3D", "Circuit", "Custom", or "Netlist"

"IsDefinition:=", <bool>,

final array members]

Final array member(s) vary with CosimDefName:

Python Syntax

Edit (<ComponentName>, [<NewComponentName>", <Info>, <RefBase>,<NumParts>, <Terminals>, <Parameters>,<Properties>, <Quantities>,<CosimDefInfo>])

Python Example

name = oComponentManager.Edit ("Simplorer Circuit Elements\BJTs:Level01_NPN",

["NAME:Level01_NPN",

"Info:=", ["Type:=", 4294901764,

"NumTerminals:=", 3,

"DataSource:=", "Ansoft built-in component",

"ModifiedOn:=", 1152722112,

"Manufacturer:=", "",

"Symbol:=", "nexx_bjt_npn",

"Footprint:=", "",

"Description:=", "BJT, GP, NPN",

"InfoTopic:=", "NXBJT1.htm",

"InfoHelpFile:=", "nexximcomponents.chm",

"IconFile:=", "bjtsn.bmp",

"Library:=", "Nexxim Circuit Elements\BJTs",

"OriginalLocation:=", "SysLibrary ",

"Author:=", "",

"OriginalAuthor:=", "",

"CreationDate:=", 1152722102

],

"Refbase:=", "Q",

"NumParts:=", 1,

"Terminal:=", ["collector", "collector", "A", false, 6, 0, "", "Electrical"],

"Terminal:=", ["base", "base", "A", false, 7, 0, "", "Electrical"],

"Terminal:=", ["emitter", "emitter", "A", false, 8, 0, "", "Electrical"],

["NAME:Parameters",

"TextProp:=", ["LabelID","HD", "Property string for netlist ID", "Q@ID"],

"TextProp:=", ["MOD", "D","Name of model data reference", "required"],

"VariableProp:=", ["AREA", "D","Emitter area multiplying factor, which affects currents, resistances, and capacitances", "1"],

"VariableProp:=", ["AREAB", "D", "Base AREA","1"],

"VariableProp:=", ["AREAC", "D", "Collector AREA","1"],

"VariableProp:=", ["DTEMP", "D","The difference between element and circuit temperature (deg Cel)","0"],

"VariableProp:=", ["M", "D","Multiplier factor to simulate multiple BJTs in parallel","1"],

"ButtonProp:=", ["NexximNetlist", "HD", "", "Q@ID %0 %1 %2 *MOD(@MOD) *AREA(AREA=@AREA)"& " *AREAB(AREAB=@AREAB) *AREAC(AREAC=@" & "AREAC)*DTEMP(DTEMP=@DTEMP) *M(M=@M)","Q@ID %0 %1 %2 *MOD(@MOD) " & "*AREA(AREA=@AREA) *AREAB(AREAB=@AREAB) *AREAC(AREAC=@" &"AREAC) *DTEMP(DTEMP=@DTEMP) *M(M=@M)", 1,"ButtonPropClientData:=", []],

"TextProp:=", ["ModelName", "HD", "", "Q"]

]

])

Python Example

name2 = oComponentManager.Edit ("MyComponent",

["NAME:MyOtherComponent",

"Info:=", ["Type:=", 4294901767,

"NumTerminals:=", 2,

"DataSource:=", "",

"ModifiedOn:=", 1071096503,

"Manufacturer:=", "Ansys",

"Symbol:=", "bendo",

"Footprint:=", "BENDO",

"Description:=", "",

"InfoTopic:=", "",

"InfoHelpFile:=", "",

"IconFile:=", "",

"LibraryName:=", "",

"OriginalLocation:=", "Project",

"Author:=", "",

"OriginalAuthor:=", "",

"CreationDate:= ", 1147460679

],

"Refbase:=", "U",

"NumParts:=", 1,

"OriginalComponent:=", "",

"Terminal:=", ["n1", "n1", "A", false, 0, 0, "", "Electrical"],

"Terminal:=", ["n2", "n2", "A", false, 1, 0, "", Electrical"],

["NAME:Parameters",

"MenuProp:=", ["CoSimulator", "D","", "Default, Custom, Netlist", 0],

"ButtonProp:=", ["CosimDefinition", "D", "", "", "Edit", 0, "ButtonPropClientData:=", []]

],

["NAME:CosimDefinitions",

["NAME:CosimDefinition",

"CosimulatorType:=", 0,

"CosimDefName:=", "HFSS3D",

"IsDefinition:=", true,

"CosimStackup:=", "Layout stackup",

"CosimDmbedRatio:=", 3],

["NAME:CosimDefinition",

"CosimulatorType:=", 1,

"CosimDefName:=", "",

"IsDefinition:=", true,

"ExportAsNport:=", 0,

"UsePjt:=", 0],

["NAME:CosimDefinition",

"CosimulatorType:=", 2,

"CosimDefName:=", "Custom",

"IsDefinition:=", true, "DefinitionCompName:=", ""],

["NAME:CosimDefinition",

"CosimulatorType:=", 3,

"CosimDefName:=", "Netlist",

"IsDefinition:=", true, "NetlistString:=", ""]

]

])