TimeSignalCollection

INTERNAL:A collection of TimeSignal.

Usage locations (collections)

The following objects contain the TimeSignalCollection collection:

Property List

Count
The number of TimeSignal items in the collection. (Read only number)
Type
The object type string. (Read only string)

Method List

AddDoubleExpDifferencePulse (unit Unit, duration Expression, amplitude Expression, pulsedelay Expression, timeconstant1 Expression, timeconstant2 Expression)
Adds a difference double exponential pulse time signal. See above mentioned user manual section for the definition. (Returns a TimeSignal object.)
AddDoubleExpPiecewisePulse (unit Unit, duration Expression, amplitude Expression, pulsedelay Expression, chargeduration Expression, chargetimeconstant1 Expression, chargetimeconstant2 Expression)
Adds a piecewise double exponential pulse time signal. See above mentioned user manual section for the definition. (Returns a TimeSignal object.)
AddGaussianPulse (unit Unit, duration Expression, amplitude Expression, pulsedelay Expression, pulsewidth Expression)
Adds a Gaussian pulse (normal distribution) time signal. See above mentioned user manual section for the definition. (Returns a TimeSignal object.)
AddMathDefinedPulse (unit Unit, duration number, functiondefinition Expression)
Adds a time signal pulse with a custom mathematical definition. See above mentioned user manual section for the definition. (Returns a TimeSignal object.)
AddRampPulse (unit Unit, duration Expression, amplitude Expression, pulsedelay Expression, pulsewidth Expression, risetime Expression, falltime Expression)
Adds a ramp pulse time signal. See above mentioned user manual section for the definition. (Returns a TimeSignal object.)
AddSpecifiedPointsPulse (unit Unit, scaletime Expression, scaleamplitude Expression, timetable List of Expression, amplitudetable List of Expression)
Adds piecewise linear function passing through the specified points. (Returns a TimeSignal object.)
AddTriangularPulse (unit Unit, duration Expression, amplitude Expression, pulsedelay Expression, pulsewidth Expression)
Adds a triangular pulse time signal. See above mentioned user manual section for the definition. (Returns a TimeSignal object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the TimeSignal at the given index. (Returns a TimeSignal object.)
Item (label string)
Returns the TimeSignal with the given label. (Returns a TimeSignal object.)
Items ()
Returns a table of TimeSignal. (Returns a List of TimeSignal object.)
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a boolean object.)

Index List

[number]
Returns the TimeSignal at the given index in the collection. (Read TimeSignal)
[string]
Returns the TimeSignal with the given name in the collection. (Read TimeSignal)

Property Details

Count
The number of TimeSignal items in the collection.
Type
number
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Method Details

AddDoubleExpDifferencePulse (unit Unit, duration Expression, amplitude Expression, pulsedelay Expression, timeconstant1 Expression, timeconstant2 Expression)
Adds a difference double exponential pulse time signal. See above mentioned user manual section for the definition.
Input Parameters
unit(Unit)
The unit to be used for the time axis.
duration(Expression)
The total length of the signal in the specified units.
amplitude(Expression)
The amplitude of the time signal.
pulsedelay(Expression)
The duration of the rest period before the pulse begins to charge up.
timeconstant1(Expression)
The time for the subtracted signal to reach 63.2% of its full potential.
timeconstant2(Expression)
The time for the base signal to reach 63.2% of its full potential.
Return
TimeSignal
The time signal.
AddDoubleExpPiecewisePulse (unit Unit, duration Expression, amplitude Expression, pulsedelay Expression, chargeduration Expression, chargetimeconstant1 Expression, chargetimeconstant2 Expression)
Adds a piecewise double exponential pulse time signal. See above mentioned user manual section for the definition.
Input Parameters
unit(Unit)
The unit to be used for the time axis.
duration(Expression)
The total length of the signal in the specified units.
amplitude(Expression)
The amplitude of the time signal.
pulsedelay(Expression)
The duration of the rest period before the pulse begins to charge up.
chargeduration(Expression)
The time from the end of the pulse delay until the signal begins to discharge.
chargetimeconstant1(Expression)
The time to charge the signal up to 63.2% of its full potential.
chargetimeconstant2(Expression)
The time to discharge the signal down to 36.8% of its full potential.
Return
TimeSignal
The time signal.
AddGaussianPulse (unit Unit, duration Expression, amplitude Expression, pulsedelay Expression, pulsewidth Expression)
Adds a Gaussian pulse (normal distribution) time signal. See above mentioned user manual section for the definition.
Input Parameters
unit(Unit)
The unit to be used for the time axis.
duration(Expression)
The total length of the signal in the specified units.
amplitude(Expression)
The amplitude of the time signal.
pulsedelay(Expression)
The time taken for the pulse to reach its peak.
pulsewidth(Expression)
The half-amplitude pulse width of the signal.
Return
TimeSignal
The time signal.
AddMathDefinedPulse (unit Unit, duration number, functiondefinition Expression)
Adds a time signal pulse with a custom mathematical definition. See above mentioned user manual section for the definition.
Input Parameters
unit(Unit)
The unit to be used for the time axis.
duration(number)
The total length of the signal in the specified units.
functiondefinition(Expression)
Analytical equation describing the input pulse, where “t” can be used as the input time variable. Note the unit is seconds.
Return
TimeSignal
The time signal.
AddRampPulse (unit Unit, duration Expression, amplitude Expression, pulsedelay Expression, pulsewidth Expression, risetime Expression, falltime Expression)
Adds a ramp pulse time signal. See above mentioned user manual section for the definition.
Input Parameters
unit(Unit)
The unit to be used for the time axis.
duration(Expression)
The total length of the signal in the specified units.
amplitude(Expression)
The amplitude of the time signal.
pulsedelay(Expression)
The time taken for the pulse to reach its peak.
pulsewidth(Expression)
The half-amplitude pulse width of the signal.
risetime(Expression)
The time required for the pulse to reach its peak value from rest.
falltime(Expression)
The time required for the pulse to reach the rest value from its peak.
Return
TimeSignal
The time signal.
AddSpecifiedPointsPulse (unit Unit, scaletime Expression, scaleamplitude Expression, timetable List of Expression, amplitudetable List of Expression)
Adds piecewise linear function passing through the specified points.
Input Parameters
unit(Unit)
The unit to be used for the time axis.
scaletime(Expression)
A scale factor applied to the time axis values.
scaleamplitude(Expression)
A scale factor applied to the amplitude axis values.
timetable(List of Expression)
A table of time points.
amplitudetable(List of Expression)
A table of amplitude points.
Return
TimeSignal
The time signal.
AddTriangularPulse (unit Unit, duration Expression, amplitude Expression, pulsedelay Expression, pulsewidth Expression)
Adds a triangular pulse time signal. See above mentioned user manual section for the definition.
Input Parameters
unit(Unit)
The unit to be used for the time axis.
duration(Expression)
The total length of the signal in the specified units.
amplitude(Expression)
The amplitude of the time signal.
pulsedelay(Expression)
The time taken for the pulse to reach its peak.
pulsewidth(Expression)
The half-amplitude pulse width of the signal.
Return
TimeSignal
The time signal.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the TimeSignal.
Return
boolean
The success of the check.
Item (index number)
Returns the TimeSignal at the given index.
Input Parameters
index(number)
The index of the TimeSignal.
Return
TimeSignal
The TimeSignal at the given index.
Item (label string)
Returns the TimeSignal with the given label.
Input Parameters
label(string)
The label of the TimeSignal.
Return
TimeSignal
The TimeSignal with the given label.
Items ()
Returns a table of TimeSignal.
Return
List of TimeSignal
A table of TimeSignal.
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated.
Input Parameters
label(string)
The base name.
Return
boolean
The generated unique name label for TimeSignal.