pulse_generator.PulseGenerator Class Reference

Inheritance diagram for pulse_generator.PulseGenerator:

Collaboration diagram for pulse_generator.PulseGenerator:

Public Member Functions
def	__init__ (self, deviceName)
def	getChannelName (self, channel)
def	getNumberOfChannels (self)
def	reset (self)
def	startOutput (self)
def	stopOutput (self)
def	isPulseOutputEnabled (self)
def	enableExternalTrigger (self)
def	isExternalTriggerEnabled (self)
def	disableExternalTrigger (self)
def	generateSoftwareExternalTrigger (self)
def	setClockPeriodInSeconds (self, clockPeriodInSeconds)
def	getClockPeriodInSeconds (self)
def	useContinuousOutputMode (self)
def	getInternalOutputMode (self)
def	useSingleShotOutputMode (self)
def	enableOutputChannel (self, channel)
def	isOutputChannelEnabled (self, channel)
def	disableOutputChannel (self, channel)
def	setOutputPulseWidth (self, channel, outputPulseWidthInSeconds)
def	getOutputPulseWidthInSeconds (self, channel)
def	setOutputPulseDelay (self, channel, outputPulseDelayInSeconds)
def	getOutputPulseDelayInSeconds (self, channel)
def	useContinuousOutputModeFor (self, channel)
def	getChannelOutputModeFor (self, channel)
def	useDutyCycleModeFor (self, channel)
def	setNumberOfPulsesDuringOnCycle (self, channel, numberOfPulses)
def	getNumberOfPulsesDuringOnCycle (self, channel)
def	setNumberOfPulsesDuringOffCycle (self, channel, numberOfPulses)
def	getNumberOfPulsesDuringOffCycle (self, channel)
def	useInvertedPolarity (self, channel)
def	getPulsePolarity (self, channel)
def	useNormalPolarity (self, channel)
def	name (self)
def	isReachable (self)
def	__init__ (self, deviceName)
def	getChannelName (self, channel)
def	getNumberOfChannels (self)
def	reset (self)
def	startOutput (self)
def	stopOutput (self)
def	isPulseOutputEnabled (self)
def	enableExternalTrigger (self)
def	isExternalTriggerEnabled (self)
def	disableExternalTrigger (self)
def	generateSoftwareExternalTrigger (self)
def	setClockPeriodInSeconds (self, clockPeriodInSeconds)
def	getClockPeriodInSeconds (self)
def	useContinuousOutputMode (self)
def	getInternalOutputMode (self)
def	useSingleShotOutputMode (self)
def	enableOutputChannel (self, channel)
def	isOutputChannelEnabled (self, channel)
def	disableOutputChannel (self, channel)
def	setOutputPulseWidth (self, channel, outputPulseWidthInSeconds)
def	getOutputPulseWidthInSeconds (self, channel)
def	setOutputPulseDelay (self, channel, outputPulseDelayInSeconds)
def	getOutputPulseDelayInSeconds (self, channel)
def	useContinuousOutputModeFor (self, channel)
def	getChannelOutputModeFor (self, channel)
def	useDutyCycleModeFor (self, channel)
def	setNumberOfPulsesDuringOnCycle (self, channel, numberOfPulses)
def	getNumberOfPulsesDuringOnCycle (self, channel)
def	setNumberOfPulsesDuringOffCycle (self, channel, numberOfPulses)
def	getNumberOfPulsesDuringOffCycle (self, channel)
def	useInvertedPolarity (self, channel)
def	getPulsePolarity (self, channel)
def	useNormalPolarity (self, channel)
def	name (self)
def	isReachable (self)

Static Public Member Functions
def	channelPropertyName (channel)
def	channelPropertyName (channel)

Static Public Attributes
string	TRUE = "1"
string	FALSE = "0"
string	PULSE_DELAY_USEC = "PULSE_DELAY_IN_MICROSECONDS.SET_VALUE"

Private Member Functions
def	_getPropertyValue (self, propertyName)
def	_setProperty (self, propertyName, value)
def	_setChannelProperty (self, channel, propertyName, value)
def	_getChannelPropertyValue (self, channel, propertyName)
def	_isValidChannel (self, channel)
def	_getPropertyValue (self, propertyName)
def	_setProperty (self, propertyName, value)
def	_setChannelProperty (self, channel, propertyName, value)
def	_getChannelPropertyValue (self, channel, propertyName)
def	_isValidChannel (self, channel)

Private Attributes
	_deviceName

Detailed Description

This pulse generator controls the pulse generator hardware via a property tree.

Constructor & Destructor Documentation

__init__() [1/2]

def pulse_generator.PulseGenerator.__init__	(		self,
			deviceName
	)

Constructs a PulseGenerator object.

@param deviceName the node of the pulse generator device (e.g. FOO.DEV0).

__init__() [2/2]

def pulse_generator.PulseGenerator.__init__	(		self,
			deviceName
	)

Constructs a PulseGenerator object.

@param deviceName the node of the pulse generator device (e.g. FOO.DEV0).

Member Function Documentation

_getChannelPropertyValue() [1/2]

def pulse_generator.PulseGenerator._getChannelPropertyValue (   self,   channel,   propertyName  )

private

_getChannelPropertyValue() [2/2]

def pulse_generator.PulseGenerator._getChannelPropertyValue (   self,   channel,   propertyName  )

private

_getPropertyValue() [1/2]

def pulse_generator.PulseGenerator._getPropertyValue (   self,   propertyName  )

private

_getPropertyValue() [2/2]

def pulse_generator.PulseGenerator._getPropertyValue (   self,   propertyName  )

private

_isValidChannel() [1/2]

def pulse_generator.PulseGenerator._isValidChannel (   self,   channel  )

private

_isValidChannel() [2/2]

def pulse_generator.PulseGenerator._isValidChannel (   self,   channel  )

private

_setChannelProperty() [1/2]

def pulse_generator.PulseGenerator._setChannelProperty (   self,   channel,   propertyName,   value  )

private

_setChannelProperty() [2/2]

def pulse_generator.PulseGenerator._setChannelProperty (   self,   channel,   propertyName,   value  )

private

_setProperty() [1/2]

def pulse_generator.PulseGenerator._setProperty (   self,   propertyName,   value  )

private

_setProperty() [2/2]

def pulse_generator.PulseGenerator._setProperty (   self,   propertyName,   value  )

private

channelPropertyName() [1/2]

def pulse_generator.PulseGenerator.channelPropertyName (   channel )

static

channelPropertyName() [2/2]

def pulse_generator.PulseGenerator.channelPropertyName (   channel )

static

disableExternalTrigger() [1/2]

def pulse_generator.PulseGenerator.disableExternalTrigger

(

self

)

Disables the external trigger.

disableExternalTrigger() [2/2]

def pulse_generator.PulseGenerator.disableExternalTrigger

(

self

)

Disables the external trigger.

disableOutputChannel() [1/2]

def pulse_generator.PulseGenerator.disableOutputChannel	(		self,
			channel
	)

Disables the pulse output for the specified channel.

@param channel the relevant channel.

disableOutputChannel() [2/2]

def pulse_generator.PulseGenerator.disableOutputChannel	(		self,
			channel
	)

Disables the pulse output for the specified channel.

@param channel the relevant channel.

enableExternalTrigger() [1/2]

def pulse_generator.PulseGenerator.enableExternalTrigger

(

self

)

Enable the external trigger mode.

enableExternalTrigger() [2/2]

def pulse_generator.PulseGenerator.enableExternalTrigger

(

self

)

Enable the external trigger mode.

enableOutputChannel() [1/2]

def pulse_generator.PulseGenerator.enableOutputChannel	(		self,
			channel
	)

Enables output for a given channel.

@param channel the channel whose output pulses should be enabled.

enableOutputChannel() [2/2]

def pulse_generator.PulseGenerator.enableOutputChannel	(		self,
			channel
	)

Enables output for a given channel.

@param channel the channel whose output pulses should be enabled.

generateSoftwareExternalTrigger() [1/2]

def pulse_generator.PulseGenerator.generateSoftwareExternalTrigger

(

self

)

Generates an external trigger signal by software.

generateSoftwareExternalTrigger() [2/2]

def pulse_generator.PulseGenerator.generateSoftwareExternalTrigger

(

self

)

Generates an external trigger signal by software.

getChannelName() [1/2]

def pulse_generator.PulseGenerator.getChannelName	(		self,
			channel
	)

getChannelName() [2/2]

def pulse_generator.PulseGenerator.getChannelName	(		self,
			channel
	)

getChannelOutputModeFor() [1/2]

def pulse_generator.PulseGenerator.getChannelOutputModeFor	(		self,
			channel
	)

Gets the pulse output mode for a given channel.

@param the relevant channel.
@return the pulse output mode.

getChannelOutputModeFor() [2/2]

def pulse_generator.PulseGenerator.getChannelOutputModeFor	(		self,
			channel
	)

Gets the pulse output mode for a given channel.

@param the relevant channel.
@return the pulse output mode.

getClockPeriodInSeconds() [1/2]

def pulse_generator.PulseGenerator.getClockPeriodInSeconds

(

self

)

Gets the clock period.

@return the clock period in seconds.

getClockPeriodInSeconds() [2/2]

def pulse_generator.PulseGenerator.getClockPeriodInSeconds

(

self

)

Gets the clock period.

@return the clock period in seconds.

getInternalOutputMode() [1/2]

def pulse_generator.PulseGenerator.getInternalOutputMode

(

self

)

Gets the internal T0 pulse mode.

@return the internal out pulse mode.

getInternalOutputMode() [2/2]

def pulse_generator.PulseGenerator.getInternalOutputMode

(

self

)

Gets the internal T0 pulse mode.

@return the internal out pulse mode.

getNumberOfChannels() [1/2]

def pulse_generator.PulseGenerator.getNumberOfChannels

(

self

)

getNumberOfChannels() [2/2]

def pulse_generator.PulseGenerator.getNumberOfChannels

(

self

)

getNumberOfPulsesDuringOffCycle() [1/2]

def pulse_generator.PulseGenerator.getNumberOfPulsesDuringOffCycle	(		self,
			channel
	)

Gets the number of output pulses in the OFF cycle during duty-cycle mode.

@param channel the relevant channel.
@return the number of output pulses.

getNumberOfPulsesDuringOffCycle() [2/2]

def pulse_generator.PulseGenerator.getNumberOfPulsesDuringOffCycle	(		self,
			channel
	)

Gets the number of output pulses in the OFF cycle during duty-cycle mode.

@param channel the relevant channel.
@return the number of output pulses.

getNumberOfPulsesDuringOnCycle() [1/2]

def pulse_generator.PulseGenerator.getNumberOfPulsesDuringOnCycle	(		self,
			channel
	)

Gets the number of output pulses in the ON cycle during duty-cycle mode.

@param channel the relevant channel.
@return the number of output pulses.

getNumberOfPulsesDuringOnCycle() [2/2]

def pulse_generator.PulseGenerator.getNumberOfPulsesDuringOnCycle	(		self,
			channel
	)

Gets the number of output pulses in the ON cycle during duty-cycle mode.

@param channel the relevant channel.
@return the number of output pulses.

getOutputPulseDelayInSeconds() [1/2]

def pulse_generator.PulseGenerator.getOutputPulseDelayInSeconds	(		self,
			channel
	)

Gets the output pulse delay.

@param channel the relevant channel.
@return the output pulse delay in seconds.

getOutputPulseDelayInSeconds() [2/2]

def pulse_generator.PulseGenerator.getOutputPulseDelayInSeconds	(		self,
			channel
	)

Gets the output pulse delay.

@param channel the relevant channel.
@return the output pulse delay in seconds.

getOutputPulseWidthInSeconds() [1/2]

def pulse_generator.PulseGenerator.getOutputPulseWidthInSeconds	(		self,
			channel
	)

Gets the output pulse width.

@param channel the relevant channel
@return the output pulse width in seconds.

getOutputPulseWidthInSeconds() [2/2]

def pulse_generator.PulseGenerator.getOutputPulseWidthInSeconds	(		self,
			channel
	)

Gets the output pulse width.

@param channel the relevant channel
@return the output pulse width in seconds.

getPulsePolarity() [1/2]

def pulse_generator.PulseGenerator.getPulsePolarity	(		self,
			channel
	)

Gets the output pulse polarity of the given channel.

@param channel the relevant channel.
@return the pulse polarity.

getPulsePolarity() [2/2]

def pulse_generator.PulseGenerator.getPulsePolarity	(		self,
			channel
	)

Gets the output pulse polarity of the given channel.

@param channel the relevant channel.
@return the pulse polarity.

isExternalTriggerEnabled() [1/2]

def pulse_generator.PulseGenerator.isExternalTriggerEnabled

(

self

)

Returns true if the external trigger is enabled.

@return true if is it possible to trigger pulses externally.

isExternalTriggerEnabled() [2/2]

def pulse_generator.PulseGenerator.isExternalTriggerEnabled

(

self

)

Returns true if the external trigger is enabled.

@return true if is it possible to trigger pulses externally.

isOutputChannelEnabled() [1/2]

def pulse_generator.PulseGenerator.isOutputChannelEnabled	(		self,
			channel
	)

Returns true if the pulse output of a given channel is enabled.

@param channel the relevant channel.

isOutputChannelEnabled() [2/2]

def pulse_generator.PulseGenerator.isOutputChannelEnabled	(		self,
			channel
	)

Returns true if the pulse output of a given channel is enabled.

@param channel the relevant channel.

isPulseOutputEnabled() [1/2]

def pulse_generator.PulseGenerator.isPulseOutputEnabled

(

self

)

Returns true if the pulse output is enabled globally.

@return true if the pulse output is enabled globally.

isPulseOutputEnabled() [2/2]

def pulse_generator.PulseGenerator.isPulseOutputEnabled

(

self

)

Returns true if the pulse output is enabled globally.

@return true if the pulse output is enabled globally.

isReachable() [1/2]

def pulse_generator.PulseGenerator.isReachable

(

self

)

Gets the device reachability state

isReachable() [2/2]

def pulse_generator.PulseGenerator.isReachable

(

self

)

Gets the device reachability state

name() [1/2]

def pulse_generator.PulseGenerator.name

(

self

)

Gets the device name given in the configuration file

@return the device name

name() [2/2]

def pulse_generator.PulseGenerator.name

(

self

)

Gets the device name given in the configuration file

@return the device name

reset() [1/2]

def pulse_generator.PulseGenerator.reset

(

self

)

Resets the pulse generator.

reset() [2/2]

def pulse_generator.PulseGenerator.reset

(

self

)

Resets the pulse generator.

setClockPeriodInSeconds() [1/2]

def pulse_generator.PulseGenerator.setClockPeriodInSeconds	(		self,
			clockPeriodInSeconds
	)

Sets the clock period.

@param clockPeriodInSeconds the clock period in seconds.

setClockPeriodInSeconds() [2/2]

def pulse_generator.PulseGenerator.setClockPeriodInSeconds	(		self,
			clockPeriodInSeconds
	)

Sets the clock period.

@param clockPeriodInSeconds the clock period in seconds.

setNumberOfPulsesDuringOffCycle() [1/2]

def pulse_generator.PulseGenerator.setNumberOfPulsesDuringOffCycle	(		self,
			channel,
			numberOfPulses
	)

Sets the number of output pulses in the OFF cycle during the duty-cycle mode.

@param channel the relevant channel
@param numberOfPulses the number of pulses.

setNumberOfPulsesDuringOffCycle() [2/2]

def pulse_generator.PulseGenerator.setNumberOfPulsesDuringOffCycle	(		self,
			channel,
			numberOfPulses
	)

Sets the number of output pulses in the OFF cycle during the duty-cycle mode.

@param channel the relevant channel
@param numberOfPulses the number of pulses.

setNumberOfPulsesDuringOnCycle() [1/2]

def pulse_generator.PulseGenerator.setNumberOfPulsesDuringOnCycle	(		self,
			channel,
			numberOfPulses
	)

Sets the number of output pulses in the ON cycle during duty-cycle mode.

@param channel the relevant channel.
@param numberOfPulses the number of output pulses.

setNumberOfPulsesDuringOnCycle() [2/2]

def pulse_generator.PulseGenerator.setNumberOfPulsesDuringOnCycle	(		self,
			channel,
			numberOfPulses
	)

Sets the number of output pulses in the ON cycle during duty-cycle mode.

@param channel the relevant channel.
@param numberOfPulses the number of output pulses.

setOutputPulseDelay() [1/2]

def pulse_generator.PulseGenerator.setOutputPulseDelay	(		self,
			channel,
			outputPulseDelayInSeconds
	)

Sets the output pulse delay for a given channel.

@param channel the relevant channel
@param outputPulseDelayInSeconds the new output pulse delay in seconds.

setOutputPulseDelay() [2/2]

def pulse_generator.PulseGenerator.setOutputPulseDelay	(		self,
			channel,
			outputPulseDelayInSeconds
	)

Sets the output pulse delay for a given channel.

@param channel the relevant channel
@param outputPulseDelayInSeconds the new output pulse delay in seconds.

setOutputPulseWidth() [1/2]

def pulse_generator.PulseGenerator.setOutputPulseWidth	(		self,
			channel,
			outputPulseWidthInSeconds
	)

Sets the width of the output pulses for a given channel.

@param channel the relevant channel.
@param outputPulseWidthInSeconds the pulse width in seconds.

setOutputPulseWidth() [2/2]

def pulse_generator.PulseGenerator.setOutputPulseWidth	(		self,
			channel,
			outputPulseWidthInSeconds
	)

Sets the width of the output pulses for a given channel.

@param channel the relevant channel.
@param outputPulseWidthInSeconds the pulse width in seconds.

startOutput() [1/2]

def pulse_generator.PulseGenerator.startOutput

(

self

)

Enables the pulse output globally.

startOutput() [2/2]

def pulse_generator.PulseGenerator.startOutput

(

self

)

Enables the pulse output globally.

stopOutput() [1/2]

def pulse_generator.PulseGenerator.stopOutput

(

self

)

Disable the pulse output globally.

stopOutput() [2/2]

def pulse_generator.PulseGenerator.stopOutput

(

self

)

Disable the pulse output globally.

useContinuousOutputMode() [1/2]

def pulse_generator.PulseGenerator.useContinuousOutputMode

(

self

)

Uses continuous internal T0 pulses.

useContinuousOutputMode() [2/2]

def pulse_generator.PulseGenerator.useContinuousOutputMode

(

self

)

Uses continuous internal T0 pulses.

useContinuousOutputModeFor() [1/2]

def pulse_generator.PulseGenerator.useContinuousOutputModeFor	(		self,
			channel
	)

Uses continuous pulse output mode for a given channel.

@param channel the relevant channel.

useContinuousOutputModeFor() [2/2]

def pulse_generator.PulseGenerator.useContinuousOutputModeFor	(		self,
			channel
	)

Uses continuous pulse output mode for a given channel.

@param channel the relevant channel.

useDutyCycleModeFor() [1/2]

def pulse_generator.PulseGenerator.useDutyCycleModeFor	(		self,
			channel
	)

Uses duty-cycle pulse series output mode for the given channel.

@param the relevant channel.

useDutyCycleModeFor() [2/2]

def pulse_generator.PulseGenerator.useDutyCycleModeFor	(		self,
			channel
	)

Uses duty-cycle pulse series output mode for the given channel.

@param the relevant channel.

useInvertedPolarity() [1/2]

def pulse_generator.PulseGenerator.useInvertedPolarity	(		self,
			channel
	)

Uses inverted polarity of the output pulses for the given channel.

@param channel the relevant channel.

useInvertedPolarity() [2/2]

def pulse_generator.PulseGenerator.useInvertedPolarity	(		self,
			channel
	)

Uses inverted polarity of the output pulses for the given channel.

@param channel the relevant channel.

useNormalPolarity() [1/2]

def pulse_generator.PulseGenerator.useNormalPolarity	(		self,
			channel
	)

Uses normal output pulse polarity for the given channel.

@param channel the relevant channel.

useNormalPolarity() [2/2]

def pulse_generator.PulseGenerator.useNormalPolarity	(		self,
			channel
	)

Uses normal output pulse polarity for the given channel.

@param channel the relevant channel.

useSingleShotOutputMode() [1/2]

def pulse_generator.PulseGenerator.useSingleShotOutputMode

(

self

)

Uses single-shot mode as the internal T0 mode.

useSingleShotOutputMode() [2/2]

def pulse_generator.PulseGenerator.useSingleShotOutputMode

(

self

)

Uses single-shot mode as the internal T0 mode.

Member Data Documentation

_deviceName

pulse_generator.PulseGenerator._deviceName

private

FALSE

string pulse_generator.PulseGenerator.FALSE = "0"

static

PULSE_DELAY_USEC

string pulse_generator.PulseGenerator.PULSE_DELAY_USEC = "PULSE_DELAY_IN_MICROSECONDS.SET_VALUE"

static

TRUE

string pulse_generator.PulseGenerator.TRUE = "1"

static

---

The documentation for this class was generated from the following file:

• /home/nirva/insroot/lib/python/site-packages/pulse_generator.py