prm()

Creates and returns a default parameter value. This is most frequently used in conjunction with create_parm() to assign a default value to an component parameter. Returns: A valid default parameter value for the given form.

Syntax:

prm(formName, paramValue1, paramValue2,..., paramValueN);

where

formName is a string; name of a form defined with create_form(). The form name must be one of the forms in the parameter's formset, specified in create_parm().

ParamvalueN is one or more default values for the parameter, depending on the construction of the form:

  • For text forms, the value is a single string, in quotes (see create_text_form()).
  • For constant forms, no value is required (see create_constant_form()).
  • For compound forms, the values of each field are described hierarchically, as with the default value of the create_parm ; that is, each field value requires a prm() function as is appropriate to the form set and desired form in the form set for the field (see create_compound_form()).

Example:

prm("stdForm", "500");
Typically used as in:

create_parm("depVar","DependentVariable", PARM_NO_DISPLAY,
 "StdFileFormSet", UNITLESS_UNIT, prm("StdForm", ""));
create_parm("Variable Value", "Variable equation",
 PARM_OPTIMIZABLE|PARM_RIGHT_HAND_ONLY|PARM_REPEATED|
 PSTM_STATISTICAL, "VarEqnForms", UNITLESS_UNIT,
 list(prm("VarFormEditCompPowerVar", prm("VarNameForm","X"),
 prm("editcompPowerVar", "1.0")))));

Download Example File:

The following link(s) lead to the Agilent EEsof EDA Knowledge center website. You will need to register at this site with a valid support contract to download an example file.

Generate SnP Component
PI Attenuator

Where Used:

Schematic

 

Privacy Statement  | Terms of Use  | Legal | Contact Us  | © Agilent 2000-2008 

Contents
Additional Resources