1.1.1.17 OcaSignalGenerator

Class Hierarchy:

OcaRoot → OcaWorker → OcaActuator → OcaSignalGenerator

class OcaSignalGenerator : OcaActuator

Multiwaveform signal generator with optional sweep capability.

Properties:

static const OcaClassID ClassID = "1.1.1.17"

Number that uniquely identifies the class. Note that this differs from the object number, which identifies the instantiated object. This property is an override of the OcaRoot property.

This property has id 4.1.

static const OcaClassVersionNumber ClassVersion = 2

Identifies the interface version of the class. Any change to the class definition leads to a higher class version. This property is an override of the OcaRoot property.

This property has id 4.2.

OcaFrequency Frequency1

Center frequency or sweep start frequency.

This property has id 4.1.

OcaFrequency Frequency2

Sweep end frequency.

This property has id 4.2.

OcaDBz Level

Output level in dB relative to device-defined zero level.

This property has id 4.3.

OcaWaveformType Waveform

The waveform type this generator generates (e.g. sine, square, noise, etc.).

This property has id 4.4.

OcaSweepType SweepType

The sweep type of the signal generator: None for no sweep, linear or logarithmic if sweep is generated.

This property has id 4.5.

OcaTimeInterval SweepTime

Duration of sweep in seconds.

This property has id 4.6.

OcaBoolean SweepRepeat

Indicates whether the sweep is repeated (true) or is one-shot (false).

This property has id 4.7.

OcaBoolean Generating

Read-only property that indicates whether the generator is producing output (true) or not (false).

This property has id 4.8.

Properties inherited from OcaWorker:

• OcaBoolean OcaWorker::Enabled

• OcaList<OcaPort> OcaWorker::Ports

• OcaString OcaWorker::Label

• OcaONo OcaWorker::Owner

• OcaTimeInterval OcaWorker::Latency

Properties inherited from OcaRoot:

• OcaONo OcaRoot::ObjectNumber

• OcaBoolean OcaRoot::Lockable

• OcaString OcaRoot::Role

Methods:

OcaStatus GetFrequency1(OcaFrequency &frequency, OcaFrequency &minFrequency, OcaFrequency &maxFrequency)

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

This method has id 4.1.

Parameters

• OcaFrequency frequency – Output parameter.

• OcaFrequency minFrequency – Output parameter.

• OcaFrequency maxFrequency – Output parameter.

OcaStatus SetFrequency1(OcaFrequency frequency)

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

This method has id 4.2.

Parameters

OcaFrequency frequency – Input parameter.

OcaStatus GetFrequency2(OcaFrequency &frequency, OcaFrequency &minFrequency, OcaFrequency &maxFrequency)

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

This method has id 4.3.

Parameters

• OcaFrequency frequency – Output parameter.

• OcaFrequency minFrequency – Output parameter.

• OcaFrequency maxFrequency – Output parameter.

OcaStatus SetFrequency2(OcaFrequency frequency)

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

This method has id 4.4.

Parameters

OcaFrequency frequency – Input parameter.

OcaStatus GetLevel(OcaDBz &Level, OcaDBz &minLevel, OcaDBz &maxLevel)

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

This method has id 4.5.

Parameters

• OcaDBz Level – Output parameter.

• OcaDBz minLevel – Output parameter.

• OcaDBz maxLevel – Output parameter.

OcaStatus SetLevel(OcaDBz Level)

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

This method has id 4.6.

Parameters

OcaDBz Level – Input parameter.

OcaStatus GetWaveform(OcaWaveformType &waveform)

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

This method has id 4.7.

Parameters

OcaWaveformType waveform – Output parameter.

OcaStatus SetWaveform(OcaWaveformType waveform)

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

This method has id 4.8.

Parameters

OcaWaveformType waveform – Input parameter.

OcaStatus GetSweepType(OcaSweepType &sweepType)

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

This method has id 4.9.

Parameters

OcaSweepType sweepType – Output parameter.

OcaStatus SetSweepType(OcaSweepType sweepType)

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

This method has id 4.10.

Parameters

OcaSweepType sweepType – Input parameter.

OcaStatus GetSweepTime(OcaTimeInterval &sweepTime, OcaTimeInterval &minSweepTime, OcaTimeInterval &maxSweepTime)

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

This method has id 4.11.

Parameters

• OcaTimeInterval sweepTime – Output parameter.

• OcaTimeInterval minSweepTime – Output parameter.

• OcaTimeInterval maxSweepTime – Output parameter.

OcaStatus SetSweepTime(OcaTimeInterval sweepTime)

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

This method has id 4.12.

Parameters

OcaTimeInterval sweepTime – Input parameter.

OcaStatus GetSweepRepeat(OcaBoolean &sweepRepeat)

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

This method has id 4.13.

Parameters

OcaBoolean sweepRepeat – Output parameter.

OcaStatus SetSweepRepeat(OcaBoolean sweepRepeat)

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

This method has id 4.14.

Parameters

OcaBoolean sweepRepeat – Input parameter.

OcaStatus GetGenerating(OcaBoolean &generating)

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

This method has id 4.15.

Parameters

OcaBoolean generating – Output parameter.

OcaStatus Start()

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

This method has id 4.16.

OcaStatus Stop()

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

This method has id 4.17.

OcaStatus SetMultiple(OcaParameterMask Mask, OcaFrequency Frequency1, OcaFrequency Frequency2, OcaDBz Level, OcaWaveformType Waveform, OcaSweepType SweepType, OcaTimeInterval SweepTime, OcaBoolean 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.

This method has id 4.18.

Parameters

• OcaParameterMask Mask – Input parameter.

• OcaFrequency Frequency1 – Input parameter.

• OcaFrequency Frequency2 – Input parameter.

• OcaDBz Level – Input parameter.

• OcaWaveformType Waveform – Input parameter.

• OcaSweepType SweepType – Input parameter.

• OcaTimeInterval SweepTime – Input parameter.

• OcaBoolean SweepRepeat – Input parameter.

Methods inherited from OcaWorker:

• OcaWorker::GetEnabled(enabled)

• OcaWorker::SetEnabled(enabled)

• OcaWorker::AddPort(Label, Mode, ID)

• OcaWorker::DeletePort(ID)

• OcaWorker::GetPorts(OcaPorts)

• OcaWorker::GetPortName(PortID, Name)

• OcaWorker::SetPortName(PortID, Name)

• OcaWorker::GetLabel(label)

• OcaWorker::SetLabel(label)

• OcaWorker::GetOwner(owner)

• OcaWorker::GetLatency(latency)

• OcaWorker::SetLatency(latency)

• OcaWorker::GetPath(NamePath, ONoPath)

Methods inherited from OcaRoot:

• OcaRoot::GetClassIdentification(ClassIdentification)

• OcaRoot::GetLockable(lockable)

• OcaRoot::LockTotal()

• OcaRoot::Unlock()

• OcaRoot::GetRole(Role)

• OcaRoot::LockReadonly()