PWRSTEP.New()

<< Click to Display Table of Contents >>

Navigation:  Explain™ Control Language  > Library Routines > Signal classes > class PWRSTEP >

PWRSTEP.New()

Description

Create a new class PWRSTEP object.

 

Type

CLASS FUNCTION

 

Usage

Signal = PWRSTEP.New (Tag, Pstat, Value1, LimitValue1, Value2, LimitValue2, Gain, MinDif, MaxStep, TimeStep1, TimeStep2, SamplePeriod, PerturbationRate, PerturbationPulseWidth, TimerRes, ModeStep1, ModeStep2, WorkingPositive)

 

Tag

STRING

Tag for object identification.

Pstat

PSTAT

Pstat is an object with a class PSTAT license.

Value1

REAL

The first value to be set by the signal object. The units of this value depend upon the mode selected. The units are either volts, amperes, ohms, or watts.

LimitValue1

REAL

This value is used to specify a limit used in calculating the signal. It is not used for:

PWR_MODE_CURRENT_DISCHARGE

PWR_MODE_CURRENT_CHARGE. Enter 0.0.

 

For PWR_MODE_VOLTAGE it is the maximum current to be encountered, entered in amperes.

 

For PWR_MODE_POWER it is the minimum voltage to be encountered, entered in volts.

 

For PWR_MODE_RESISTANCE it is the maximum voltage to be encountered, entered in volts.

Value2

REAL

The second value to be set by the signal object. The units of this value depend upon the mode selected. The units are either volts, amperes, ohms, or watts.

LimitValue2

REAL

This value is used to specify a limit used in calculating the signal. It is not used for:

PWR_MODE_CURRENT_DISCHARGE

PWR_MODE_CURRENT_CHARGE. Enter 0.0.

 

For PWR_MODE_VOLTAGE it is the maximum current to be encountered, entered in amperes.

 

For PWR_MODE_POWER it is the minimum voltage to be encountered, entered in volts.

 

For PWR_MODE_RESISTANCE it is the maximum voltage to be encountered, entered in volts.

Gain

REAL

This is the gain used during the feedback loop. It should be left at the default value:

PWR800_DEFAULT_GAIN

MinDif

REAL

This is the percentage above/below the nominal value, used during a perturbation. The nominal value is the current that is being applied by the signal. It is entered as a decimal where 1.0 = 100%. It should be left at the default value:

PWR800_DEFAULT_MINIMUM_DIFFERENCE

MaxStep

REAL

This is the percentage of full scale that is used to limit the maximum step in current during the feedback loop. The I/E current range determines the full-scale value. The percentage is entered as a decimal where 1.0 = 100% of the scale. It should be left at the default value:

PWR800_DEFAULT_MAXIMUM_STEP

TimeStep1

REAL

This is the time that the first step of the signal is to be applied, entered in seconds.

TimeStep2

REAL

This is the time that the second step of the signal is to be applied, entered in seconds.

SamplePeriod

REAL

This is the sample period, entered in seconds. This signal performs a feedback loop. The TimerRes determines the speed of the timer. The SamplePeriod determines the timing of output points.

PerturbationRate

REAL

This is the time, entered in seconds, between perturbations of the signal. A perturbation is an increase followed by a matching decrease in the applied signal value. This perturbation allows the signal to determine the response of the cell so that the feedback loop can work properly. Perturbations are only necessary in feedback modes. These modes are:

PWR_MODE_RESISTANCE

PWR_MODE_POWER

PWR_MODE_VOLTAGE

 

Perturbations are skipped if the control algorithm determines they are not necessary. This value should be left at the default value:

PWR800_DEFAULT_PERTURBATION_RATE

PerturbationPulseWidth

REAL

This is the width of a perturbation, entered in seconds. A perturbation includes both an increase and a decrease, each will be held for this amount of time. This should be left at the default value:

PWR800_DEFAULT_PERTURBATION_WIDTH

TimerRes

REAL

This is the fundamental timer setting of the instrument in seconds. It should be left at the default:

PWR800_DEFAULT_TIMER_RESOLUTION

ModeStep1

INDEX

This is the control mode of the first step of the signal. The following constants are valid values:

PWR_MODE_CURRENT_DISCHARGE

PWR_MODE_RESISTANCE

PWR_MODE_POWER

PWR_MODE_VOLTAGE

PWR_MODE_CURRENT_CHARGE

ModeStep2

INDEX

This is the control mode of the second step of the signal. The following constants are valid values:

PWR_MODE_CURRENT_DISCHARGE

PWR_MODE_RESISTANCE

PWR_MODE_POWER

PWR_MODE_VOLTAGE

PWR_MODE_CURRENT_CHARGE

WorkingPositive

BOOL

This value specifies if the working connection is connected to the positive or negative terminal:

TRUE = Working connected to positive terminal.

FALSE = Working connected to negative terminal.

Signal

OBJECT

The created PWRSTEP object.