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 1.1.

static const OcaClassVersionNumber ClassVersion = 3

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 1.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.

OcaBoolean Generating

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

This property has id 4.8.

OcaDBz Level

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

This property has id 4.3.

OcaBoolean SweepRepeat

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

This property has id 4.7.

OcaTimeInterval SweepTime

Duration of sweep in seconds.

This property has id 4.6.

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.

OcaWaveformType Waveform

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

This property has id 4.4.

Properties inherited from 1.1.1 OcaActuator:

• OcaClassID OcaRoot::ClassID

• OcaClassVersionNumber OcaRoot::ClassVersion

• OcaBoolean OcaRoot::Lockable

• OcaLockState OcaRoot::LockState

• OcaONo OcaRoot::ObjectNumber

• OcaString OcaRoot::Role

• OcaClassID OcaWorker::ClassID

• OcaClassVersionNumber OcaWorker::ClassVersion

• OcaBoolean OcaWorker::Enabled

• OcaString OcaWorker::Label

• OcaTimeInterval OcaWorker::Latency

• OcaONo OcaWorker::Owner

• OcaMap<OcaPortID, OcaPortClockMapEntry> OcaWorker::PortClockMap

• OcaList<OcaPort> OcaWorker::Ports

• OcaClassID OcaActuator::ClassID

• OcaClassVersionNumber OcaActuator::ClassVersion

Methods:

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

Gets the value and limits of the Frequency1 property.

This method has id 4.1.

• Frequency: Output parameter.

• minFrequency: Output parameter.

• maxFrequency: Output parameter.

OcaStatus SetFrequency1(OcaFrequency Frequency)

Sets the value of the Frequency1 property.

This method has id 4.2.

• Frequency: Input parameter.

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

Gets the value and limits of the Frequency2 property..

This method has id 4.3.

• frequency: Output parameter.

• minFrequency: Output parameter.

• maxFrequency: Output parameter.

OcaStatus SetFrequency2(OcaFrequency frequency)

Sets the value of the Frequency2 property.

This method has id 4.4.

• frequency: Input parameter.

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

Gets the value and limits of the Level property.

This method has id 4.5.

• Level: Output parameter.

• minLevel: Output parameter.

• maxLevel: Output parameter.

OcaStatus SetLevel(OcaDBz Level)

Sets the value of the Level property.

This method has id 4.6.

• Level: Input parameter.

OcaStatus GetWaveform(OcaWaveformType &waveform)

Gets the value of the Waveform property.

This method has id 4.7.

• waveform: Output parameter.

OcaStatus SetWaveform(OcaWaveformType waveform)

Sets the value of the Waveform property.

This method has id 4.8.

• waveform: Input parameter.

OcaStatus GetSweepType(OcaSweepType &sweepType)

Gets the value of the SweepType property.

This method has id 4.9.

• sweepType: Output parameter.

OcaStatus SetSweepType(OcaSweepType sweepType)

Sets the value of the SweepType property.

This method has id 4.10.

• sweepType: Input parameter.

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

Gets the value and limits of the SweepTime property.

This method has id 4.11.

• sweepTime: Output parameter.

• minSweepTime: Output parameter.

• maxSweepTime: Output parameter.

OcaStatus SetSweepTime(OcaTimeInterval sweepTime)

Gets the value of the SweepTime property.

This method has id 4.12.

• sweepTime: Input parameter.

OcaStatus GetSweepRepeat(OcaBoolean &sweepRepeat)

Gets the value of the SweepRepeat property.

This method has id 4.13.

• sweepRepeat: Output parameter.

OcaStatus SetSweepRepeat(OcaBoolean sweepRepeat)

Sets the value of the SweepRepeat property.

This method has id 4.14.

• sweepRepeat: Input parameter.

OcaStatus GetGenerating(OcaBoolean &generating)

Gets the value of the Generating property.

This method has id 4.15.

• generating: Output parameter.

OcaStatus Start()

Starts the signal generator.

This method has id 4.16.

OcaStatus Stop()

Stops the signal generator.

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 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.

• Mask: Input parameter.

• Frequency1: Input parameter.

• Frequency2: Input parameter.

• Level: Input parameter.

• Waveform: Input parameter.

• SweepType: Input parameter.

• SweepTime: Input parameter.

• SweepRepeat: Input parameter.

Methods inherited from 1.1.1 OcaActuator:

• OcaActuator::GetClassIdentification

• OcaActuator::GetLockable

• OcaActuator::GetLockState

• OcaActuator::GetRole

• OcaActuator::SetLockNoWrite

• OcaActuator::SetLockNoReadWrite

• OcaActuator::Unlock

• OcaActuator::AddPort

• OcaActuator::DeletePort

• OcaActuator::DeletePortClockMapEntry

• OcaActuator::GetEnabled

• OcaActuator::GetLabel

• OcaActuator::GetLatency

• OcaActuator::GetOwner

• OcaActuator::GetPath

• OcaActuator::GetPortClockMap

• OcaActuator::GetPortClockMapEntry

• OcaActuator::GetPortName

• OcaActuator::GetPorts

• OcaActuator::SetEnabled

• OcaActuator::SetLabel

• OcaActuator::SetLatency

• OcaActuator::SetPortClockMap

• OcaActuator::SetPortClockMapEntry

• OcaActuator::SetPortName