TwiceAsNice  2019-02-18
Public Member Functions | Static Public Member Functions | List of all members
basda::quantumcomposers::PulseGenerator Class Referenceabstract

This class is pure abstract base class for the pulse generator hardware driver. More...

#include <PulseGenerator.h>

Inheritance diagram for basda::quantumcomposers::PulseGenerator:
Inheritance graph
Collaboration diagram for basda::quantumcomposers::PulseGenerator:
Collaboration graph

Public Member Functions

virtual void reset ()=0
 
virtual void startOutput ()=0
 
virtual void stopOutput ()=0
 
virtual bool isPulseOutputEnabled ()=0
 
virtual void enableExternalTrigger ()=0
 
virtual void disableExternalTrigger ()=0
 
virtual bool isExternalTriggerEnabled ()=0
 
virtual void generateSoftwareExternalTrigger ()=0
 
virtual void setClockPeriodInSeconds (double clockPeriodInSeconds)=0
 
virtual double getClockPeriodInSeconds ()=0
 
virtual void useContinuousOutputMode ()=0
 
virtual void useSingleShotOutputMode ()=0
 
virtual OutputMode getInternalOutputMode ()=0
 
virtual void enableOutputChannel (const OutputChannel &channel)=0
 
virtual void disableOutputChannel (const OutputChannel &channel)=0
 
virtual bool isOutputChannelEnabled (const OutputChannel &channel)=0
 
virtual void setOutputPulseWidth (const OutputChannel &channel, double outputPulseWidthInSeconds)=0
 
virtual double getOutputPulseWidthInSeconds (const OutputChannel &channel)=0
 
virtual void setOutputPulseDelay (const OutputChannel &channel, double outputPulseDelayInSeconds)=0
 
virtual double getOutputPulseDelayInSeconds (const OutputChannel &channel)=0
 
virtual void useContinuousOutputModeFor (const OutputChannel &channel)=0
 
virtual void useDutyCycleModeFor (const OutputChannel &channel)=0
 
virtual OutputMode getChannelOutputModeFor (const OutputChannel &channel)=0
 
virtual void setNumberOfPulsesDuringOnCycle (const OutputChannel &channel, unsigned numberOfPulses)=0
 
virtual unsigned getNumberOfPulsesDuringOnCycle (const OutputChannel &c)=0
 
virtual void setNumberOfPulsesDuringOffCycle (const OutputChannel &channel, unsigned numberOfPulses)=0
 
virtual unsigned getNumberOfPulsesDuringOffCycle (const OutputChannel &c)=0
 
virtual void useInvertedPolarity (const OutputChannel &c)=0
 
virtual void useNormalPolarity (const OutputChannel &c)=0
 
virtual PulsePolarity getPulsePolarity (const OutputChannel &c)=0
 
virtual ~PulseGenerator ()=0
 
virtual void reset ()=0
 
virtual void startOutput ()=0
 
virtual void stopOutput ()=0
 
virtual bool isPulseOutputEnabled ()=0
 
virtual void enableExternalTrigger ()=0
 
virtual void disableExternalTrigger ()=0
 
virtual bool isExternalTriggerEnabled ()=0
 
virtual void generateSoftwareExternalTrigger ()=0
 
virtual void setClockPeriodInSeconds (double clockPeriodInSeconds)=0
 
virtual double getClockPeriodInSeconds ()=0
 
virtual void useContinuousOutputMode ()=0
 
virtual void useSingleShotOutputMode ()=0
 
virtual OutputMode getInternalOutputMode ()=0
 
virtual void enableOutputChannel (const OutputChannel &channel)=0
 
virtual void disableOutputChannel (const OutputChannel &channel)=0
 
virtual bool isOutputChannelEnabled (const OutputChannel &channel)=0
 
virtual void setOutputPulseWidth (const OutputChannel &channel, double outputPulseWidthInSeconds)=0
 
virtual double getOutputPulseWidthInSeconds (const OutputChannel &channel)=0
 
virtual void setOutputPulseDelay (const OutputChannel &channel, double outputPulseDelayInSeconds)=0
 
virtual double getOutputPulseDelayInSeconds (const OutputChannel &channel)=0
 
virtual void useContinuousOutputModeFor (const OutputChannel &channel)=0
 
virtual void useDutyCycleModeFor (const OutputChannel &channel)=0
 
virtual OutputMode getChannelOutputModeFor (const OutputChannel &channel)=0
 
virtual void setNumberOfPulsesDuringOnCycle (const OutputChannel &channel, unsigned numberOfPulses)=0
 
virtual unsigned getNumberOfPulsesDuringOnCycle (const OutputChannel &c)=0
 
virtual void setNumberOfPulsesDuringOffCycle (const OutputChannel &channel, unsigned numberOfPulses)=0
 
virtual unsigned getNumberOfPulsesDuringOffCycle (const OutputChannel &c)=0
 
virtual void useInvertedPolarity (const OutputChannel &c)=0
 
virtual void useNormalPolarity (const OutputChannel &c)=0
 
virtual PulsePolarity getPulsePolarity (const OutputChannel &c)=0
 
virtual ~PulseGenerator ()=0
 

Static Public Member Functions

static PulseGeneratorPtr null ()
 
static PulseGeneratorPtr null ()
 

Detailed Description

This class is pure abstract base class for the pulse generator hardware driver.

Constructor & Destructor Documentation

◆ ~PulseGenerator() [1/2]

basda::quantumcomposers::PulseGenerator::~PulseGenerator ( )
pure virtual

◆ ~PulseGenerator() [2/2]

virtual basda::quantumcomposers::PulseGenerator::~PulseGenerator ( )
pure virtual

Member Function Documentation

◆ disableExternalTrigger() [1/2]

virtual void basda::quantumcomposers::PulseGenerator::disableExternalTrigger ( )
pure virtual

◆ disableExternalTrigger() [2/2]

virtual void basda::quantumcomposers::PulseGenerator::disableExternalTrigger ( )
pure virtual

◆ disableOutputChannel() [1/2]

virtual void basda::quantumcomposers::PulseGenerator::disableOutputChannel ( const OutputChannel channel)
pure virtual

◆ disableOutputChannel() [2/2]

virtual void basda::quantumcomposers::PulseGenerator::disableOutputChannel ( const OutputChannel channel)
pure virtual

◆ enableExternalTrigger() [1/2]

virtual void basda::quantumcomposers::PulseGenerator::enableExternalTrigger ( )
pure virtual

◆ enableExternalTrigger() [2/2]

virtual void basda::quantumcomposers::PulseGenerator::enableExternalTrigger ( )
pure virtual

◆ enableOutputChannel() [1/2]

virtual void basda::quantumcomposers::PulseGenerator::enableOutputChannel ( const OutputChannel channel)
pure virtual

◆ enableOutputChannel() [2/2]

virtual void basda::quantumcomposers::PulseGenerator::enableOutputChannel ( const OutputChannel channel)
pure virtual

◆ generateSoftwareExternalTrigger() [1/2]

virtual void basda::quantumcomposers::PulseGenerator::generateSoftwareExternalTrigger ( )
pure virtual

◆ generateSoftwareExternalTrigger() [2/2]

virtual void basda::quantumcomposers::PulseGenerator::generateSoftwareExternalTrigger ( )
pure virtual

◆ getChannelOutputModeFor() [1/2]

virtual OutputMode basda::quantumcomposers::PulseGenerator::getChannelOutputModeFor ( const OutputChannel channel)
pure virtual

◆ getChannelOutputModeFor() [2/2]

virtual OutputMode basda::quantumcomposers::PulseGenerator::getChannelOutputModeFor ( const OutputChannel channel)
pure virtual

◆ getClockPeriodInSeconds() [1/2]

virtual double basda::quantumcomposers::PulseGenerator::getClockPeriodInSeconds ( )
pure virtual

◆ getClockPeriodInSeconds() [2/2]

virtual double basda::quantumcomposers::PulseGenerator::getClockPeriodInSeconds ( )
pure virtual

◆ getInternalOutputMode() [1/2]

virtual OutputMode basda::quantumcomposers::PulseGenerator::getInternalOutputMode ( )
pure virtual

◆ getInternalOutputMode() [2/2]

virtual OutputMode basda::quantumcomposers::PulseGenerator::getInternalOutputMode ( )
pure virtual

◆ getNumberOfPulsesDuringOffCycle() [1/2]

virtual unsigned basda::quantumcomposers::PulseGenerator::getNumberOfPulsesDuringOffCycle ( const OutputChannel c)
pure virtual

◆ getNumberOfPulsesDuringOffCycle() [2/2]

virtual unsigned basda::quantumcomposers::PulseGenerator::getNumberOfPulsesDuringOffCycle ( const OutputChannel c)
pure virtual

◆ getNumberOfPulsesDuringOnCycle() [1/2]

virtual unsigned basda::quantumcomposers::PulseGenerator::getNumberOfPulsesDuringOnCycle ( const OutputChannel c)
pure virtual

◆ getNumberOfPulsesDuringOnCycle() [2/2]

virtual unsigned basda::quantumcomposers::PulseGenerator::getNumberOfPulsesDuringOnCycle ( const OutputChannel c)
pure virtual

◆ getOutputPulseDelayInSeconds() [1/2]

virtual double basda::quantumcomposers::PulseGenerator::getOutputPulseDelayInSeconds ( const OutputChannel channel)
pure virtual

◆ getOutputPulseDelayInSeconds() [2/2]

virtual double basda::quantumcomposers::PulseGenerator::getOutputPulseDelayInSeconds ( const OutputChannel channel)
pure virtual

◆ getOutputPulseWidthInSeconds() [1/2]

virtual double basda::quantumcomposers::PulseGenerator::getOutputPulseWidthInSeconds ( const OutputChannel channel)
pure virtual

◆ getOutputPulseWidthInSeconds() [2/2]

virtual double basda::quantumcomposers::PulseGenerator::getOutputPulseWidthInSeconds ( const OutputChannel channel)
pure virtual

◆ getPulsePolarity() [1/2]

virtual PulsePolarity basda::quantumcomposers::PulseGenerator::getPulsePolarity ( const OutputChannel c)
pure virtual

◆ getPulsePolarity() [2/2]

virtual PulsePolarity basda::quantumcomposers::PulseGenerator::getPulsePolarity ( const OutputChannel c)
pure virtual

◆ isExternalTriggerEnabled() [1/2]

virtual bool basda::quantumcomposers::PulseGenerator::isExternalTriggerEnabled ( )
pure virtual

◆ isExternalTriggerEnabled() [2/2]

virtual bool basda::quantumcomposers::PulseGenerator::isExternalTriggerEnabled ( )
pure virtual

◆ isOutputChannelEnabled() [1/2]

virtual bool basda::quantumcomposers::PulseGenerator::isOutputChannelEnabled ( const OutputChannel channel)
pure virtual

◆ isOutputChannelEnabled() [2/2]

virtual bool basda::quantumcomposers::PulseGenerator::isOutputChannelEnabled ( const OutputChannel channel)
pure virtual

◆ isPulseOutputEnabled() [1/2]

virtual bool basda::quantumcomposers::PulseGenerator::isPulseOutputEnabled ( )
pure virtual

◆ isPulseOutputEnabled() [2/2]

virtual bool basda::quantumcomposers::PulseGenerator::isPulseOutputEnabled ( )
pure virtual

◆ null() [1/2]

static PulseGeneratorPtr basda::quantumcomposers::PulseGenerator::null ( )
static

◆ null() [2/2]

PulseGeneratorPtr basda::quantumcomposers::PulseGenerator::null ( )
static

◆ reset() [1/2]

virtual void basda::quantumcomposers::PulseGenerator::reset ( )
pure virtual

◆ reset() [2/2]

virtual void basda::quantumcomposers::PulseGenerator::reset ( )
pure virtual

◆ setClockPeriodInSeconds() [1/2]

virtual void basda::quantumcomposers::PulseGenerator::setClockPeriodInSeconds ( double  clockPeriodInSeconds)
pure virtual

◆ setClockPeriodInSeconds() [2/2]

virtual void basda::quantumcomposers::PulseGenerator::setClockPeriodInSeconds ( double  clockPeriodInSeconds)
pure virtual

◆ setNumberOfPulsesDuringOffCycle() [1/2]

virtual void basda::quantumcomposers::PulseGenerator::setNumberOfPulsesDuringOffCycle ( const OutputChannel channel,
unsigned  numberOfPulses 
)
pure virtual

◆ setNumberOfPulsesDuringOffCycle() [2/2]

virtual void basda::quantumcomposers::PulseGenerator::setNumberOfPulsesDuringOffCycle ( const OutputChannel channel,
unsigned  numberOfPulses 
)
pure virtual

◆ setNumberOfPulsesDuringOnCycle() [1/2]

virtual void basda::quantumcomposers::PulseGenerator::setNumberOfPulsesDuringOnCycle ( const OutputChannel channel,
unsigned  numberOfPulses 
)
pure virtual

◆ setNumberOfPulsesDuringOnCycle() [2/2]

virtual void basda::quantumcomposers::PulseGenerator::setNumberOfPulsesDuringOnCycle ( const OutputChannel channel,
unsigned  numberOfPulses 
)
pure virtual

◆ setOutputPulseDelay() [1/2]

virtual void basda::quantumcomposers::PulseGenerator::setOutputPulseDelay ( const OutputChannel channel,
double  outputPulseDelayInSeconds 
)
pure virtual

◆ setOutputPulseDelay() [2/2]

virtual void basda::quantumcomposers::PulseGenerator::setOutputPulseDelay ( const OutputChannel channel,
double  outputPulseDelayInSeconds 
)
pure virtual

◆ setOutputPulseWidth() [1/2]

virtual void basda::quantumcomposers::PulseGenerator::setOutputPulseWidth ( const OutputChannel channel,
double  outputPulseWidthInSeconds 
)
pure virtual

◆ setOutputPulseWidth() [2/2]

virtual void basda::quantumcomposers::PulseGenerator::setOutputPulseWidth ( const OutputChannel channel,
double  outputPulseWidthInSeconds 
)
pure virtual

◆ startOutput() [1/2]

virtual void basda::quantumcomposers::PulseGenerator::startOutput ( )
pure virtual

◆ startOutput() [2/2]

virtual void basda::quantumcomposers::PulseGenerator::startOutput ( )
pure virtual

◆ stopOutput() [1/2]

virtual void basda::quantumcomposers::PulseGenerator::stopOutput ( )
pure virtual

◆ stopOutput() [2/2]

virtual void basda::quantumcomposers::PulseGenerator::stopOutput ( )
pure virtual

◆ useContinuousOutputMode() [1/2]

virtual void basda::quantumcomposers::PulseGenerator::useContinuousOutputMode ( )
pure virtual

◆ useContinuousOutputMode() [2/2]

virtual void basda::quantumcomposers::PulseGenerator::useContinuousOutputMode ( )
pure virtual

◆ useContinuousOutputModeFor() [1/2]

virtual void basda::quantumcomposers::PulseGenerator::useContinuousOutputModeFor ( const OutputChannel channel)
pure virtual

◆ useContinuousOutputModeFor() [2/2]

virtual void basda::quantumcomposers::PulseGenerator::useContinuousOutputModeFor ( const OutputChannel channel)
pure virtual

◆ useDutyCycleModeFor() [1/2]

virtual void basda::quantumcomposers::PulseGenerator::useDutyCycleModeFor ( const OutputChannel channel)
pure virtual

◆ useDutyCycleModeFor() [2/2]

virtual void basda::quantumcomposers::PulseGenerator::useDutyCycleModeFor ( const OutputChannel channel)
pure virtual

◆ useInvertedPolarity() [1/2]

virtual void basda::quantumcomposers::PulseGenerator::useInvertedPolarity ( const OutputChannel c)
pure virtual

◆ useInvertedPolarity() [2/2]

virtual void basda::quantumcomposers::PulseGenerator::useInvertedPolarity ( const OutputChannel c)
pure virtual

◆ useNormalPolarity() [1/2]

virtual void basda::quantumcomposers::PulseGenerator::useNormalPolarity ( const OutputChannel c)
pure virtual

◆ useNormalPolarity() [2/2]

virtual void basda::quantumcomposers::PulseGenerator::useNormalPolarity ( const OutputChannel c)
pure virtual

◆ useSingleShotOutputMode() [1/2]

virtual void basda::quantumcomposers::PulseGenerator::useSingleShotOutputMode ( )
pure virtual

◆ useSingleShotOutputMode() [2/2]

virtual void basda::quantumcomposers::PulseGenerator::useSingleShotOutputMode ( )
pure virtual

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