OcaSignalGenerator

A online version of the AES70 specification of this class can be found at http://docs.deuso.de.

The class is a subclass of OcaActuator().

This class defines the properties

Name

JavaScript Type

AES70 Type

Frequency1

number

OcaFrequency

Frequency2

number

OcaFrequency

Level

number

OcaDBz

Waveform

OcaWaveformType

OcaWaveformType

SweepType

OcaSweepType

OcaSweepType

SweepTime

number

OcaTimeInterval

SweepRepeat

boolean

OcaBoolean

Generating

boolean

OcaBoolean

Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Enabled, Ports, Label, Owner, Latency, Frequency1, Frequency2, Level, Waveform, SweepType, SweepTime, SweepRepeat and Generating.

class OcaSignalGenerator(objectNumber, device)

Multiwaveform signal generator with optional sweep capability.

OcaSignalGenerator.OnFrequency1Changed

type: PropertyEvent.<number>

This event is emitted when the property Frequency1 changes in the remote object. The property Frequency1 is described in the AES70 standard as follows. Center frequency or sweep start frequency.

OcaSignalGenerator.OnFrequency2Changed

type: PropertyEvent.<number>

This event is emitted when the property Frequency2 changes in the remote object. The property Frequency2 is described in the AES70 standard as follows. Sweep end frequency.

OcaSignalGenerator.OnGeneratingChanged

type: PropertyEvent.<boolean>

This event is emitted when the property Generating changes in the remote object. The property Generating is described in the AES70 standard as follows. Read-only property that indicates whether the generator is producing output (true) or not (false).

OcaSignalGenerator.OnLevelChanged

type: PropertyEvent.<number>

This event is emitted when the property Level changes in the remote object. The property Level is described in the AES70 standard as follows. Output level in dB relative to device-defined zero level.

OcaSignalGenerator.OnSweepRepeatChanged

type: PropertyEvent.<boolean>

This event is emitted when the property SweepRepeat changes in the remote object. The property SweepRepeat is described in the AES70 standard as follows. Indicates whether the sweep is repeated (true) or is one-shot (false).

OcaSignalGenerator.OnSweepTimeChanged

type: PropertyEvent.<number>

This event is emitted when the property SweepTime changes in the remote object. The property SweepTime is described in the AES70 standard as follows. Duration of sweep in seconds.

OcaSignalGenerator.OnSweepTypeChanged

type: PropertyEvent.<OcaSweepType>

This event is emitted when the property SweepType changes in the remote object. The property SweepType is described in the AES70 standard as follows. The sweep type of the signal generator: None for no sweep, linear or logarithmic if sweep is generated.

OcaSignalGenerator.OnWaveformChanged

type: PropertyEvent.<OcaWaveformType>

This event is emitted when the property Waveform changes in the remote object. The property Waveform is described in the AES70 standard as follows. The waveform type this generator generates (e.g. sine, square, noise, etc.).

OcaSignalGenerator.GetFrequency1()

Gets the value of the Frequency1 property. The return value indicates whether the property was successfully retrieved. The return values of this method are

  • frequency of type number

  • minFrequency of type number

  • maxFrequency of type number

Returns

Promise.<Arguments.<number, number, number>> –

OcaSignalGenerator.GetFrequency2()

Gets the value of the Frequency2 property. The return value indicates whether the property was successfully retrieved. The return values of this method are

  • frequency of type number

  • minFrequency of type number

  • maxFrequency of type number

Returns

Promise.<Arguments.<number, number, number>> –

OcaSignalGenerator.GetGenerating()

Gets the value of the Generating property. The return value indicates whether the property was successfully retrieved.

Returns

Promise.<boolean> – A promise which resolves to a single value of type boolean.

OcaSignalGenerator.GetLevel()

Gets the value of the Level property. The return value indicates whether the property was successfully retrieved. The return values of this method are

  • Level of type number

  • minLevel of type number

  • maxLevel of type number

Returns

Promise.<Arguments.<number, number, number>> –

OcaSignalGenerator.GetSweepRepeat()

Gets the value of the SweepRepeat property. The return value indicates whether the property was successfully retrieved.

Returns

Promise.<boolean> – A promise which resolves to a single value of type boolean.

OcaSignalGenerator.GetSweepTime()

Gets the value of the SweepTime property. The return value indicates whether the property was successfully retrieved. The return values of this method are

  • sweepTime of type number

  • minSweepTime of type number

  • maxSweepTime of type number

Returns

Promise.<Arguments.<number, number, number>> –

OcaSignalGenerator.GetSweepType()

Gets the value of the SweepType property. The return value indicates whether the property was successfully retrieved.

Returns

Promise.<OcaSweepType> – A promise which resolves to a single value of type OcaSweepType().

OcaSignalGenerator.GetWaveform()

Gets the value of the Waveform property. The return value indicates whether the property was successfully retrieved.

Returns

Promise.<OcaWaveformType> – A promise which resolves to a single value of type OcaWaveformType().

OcaSignalGenerator.SetFrequency1(frequency)

Sets the value of the Frequency1 property. The return value indicates whether the property was successfully set.

Arguments

  • frequency (number) –

Returns

Promise.<void> –

OcaSignalGenerator.SetFrequency2(frequency)

Sets the value of the Frequency2 property. The return value indicates whether the property was successfully set.

Arguments

  • frequency (number) –

Returns

Promise.<void> –

OcaSignalGenerator.SetLevel(Level)

Sets the value of the Level property. The return value indicates whether the property was successfully set.

Arguments

  • Level (number) –

Returns

Promise.<void> –

OcaSignalGenerator.SetMultiple(Mask, Frequency1, Frequency2, Level, Waveform, SweepType, SweepTime, SweepRepeat)

Sets some or all signal generation parameters. The return value indicates if the parameters were successfully set. The action of this method is atomic - if any of the value changes fails, none of the changes are made.

Arguments

  • Mask (int) –

  • Frequency1 (number) –

  • Frequency2 (number) –

  • Level (number) –

  • Waveform (OcaWaveformType) –

  • SweepType (OcaSweepType) –

  • SweepTime (number) –

  • SweepRepeat (boolean) –

Returns

Promise.<void> –

OcaSignalGenerator.SetSweepRepeat(sweepRepeat)

Sets the value of the SweepRepeat property. The return value indicates whether the property was successfully set.

Arguments

  • sweepRepeat (boolean) –

Returns

Promise.<void> –

OcaSignalGenerator.SetSweepTime(sweepTime)

Sets the value of the SweepTime property. The return value indicates whether the property was successfully set.

Arguments

  • sweepTime (number) –

Returns

Promise.<void> –

OcaSignalGenerator.SetSweepType(sweepType)

Sets the value of the SweepType property. The return value indicates whether the property was successfully set.

Arguments
Returns

Promise.<void> –

OcaSignalGenerator.SetWaveform(waveform)

Sets the value of the Waveform property. The return value indicates whether the property was successfully set.

Arguments
Returns

Promise.<void> –

OcaSignalGenerator.Start()

Starts the signal generator. The return value indicates whether the signal generator was successfully started.

Returns

Promise.<void> –

OcaSignalGenerator.Stop()

Stops the signal generator. The return value indicates whether the signal generator was successfully stopped.

Returns

Promise.<void> –