Scope
Public Member Functions | Protected Attributes | List of all members
scope::parameters::Base Class Reference
Parameter classes

#include <Base.h>

Inherited by scope::parameters::Area, scope::parameters::Behavior, scope::parameters::Daq, scope::parameters::FastZControl, scope::parameters::Inputs, scope::parameters::Outputs, scope::parameters::PlaneProperties, scope::parameters::ScannerVector, scope::parameters::Scope, scope::parameters::Stack, scope::parameters::Stimulation, scope::parameters::Storage, scope::parameters::Timeseries, scope::parameters::Window, scope::parameters::WindowCollection, scope::parameters::XYControl, and scope::parameters::XYZControl.

Public Member Functions

virtual void Load (const wptree &pt)
 
virtual void Save (wptree &pt) const
 
virtual void SetReadOnlyWhileScanning (const RunState &_runstate)
 

Protected Attributes

std::vector< boost::signals2::connection > connection_collector
 

Detailed Description

All parameter classes derive from this.

Keeps a group of related parameters (ScopeValues) together, handles load and save from a boost::ptree, and cares about enabling/disabling during scanning.

Warning
no spaces in names allowed (xml saving...)

Definition at line 21 of file Base.h.

Member Function Documentation

virtual void scope::parameters::Base::Load ( const wptree &  pt)
inlinevirtual

load parameters from a boost::property_tree

Reimplemented in scope::parameters::Daq, scope::parameters::OutputsDAQmxResonance, scope::parameters::OutputsDAQmxSlave, scope::parameters::OutputsDAQmxLineClock, scope::parameters::OutputsDAQmx, scope::parameters::Outputs, scope::parameters::ScannerVectorFrameResonance, scope::parameters::InputsFPGAResonanceScanner, scope::parameters::InputsFPGAAnalogIntegrator, scope::parameters::ScannerVectorFramePlaneHopper, scope::parameters::InputsFPGAAnalogDemultiplexer, scope::parameters::ScannerVectorFrameBiDi, scope::parameters::InputsFPGAIO5751, scope::parameters::InputsFPGAIO5771, scope::parameters::ScannerVectorFrameSaw, scope::parameters::InputsFPGAPhotonCounter, scope::parameters::InputsFPGADigitalDemultiplexer, scope::parameters::XYControlStanda, scope::parameters::InputsFPGAIO6587, scope::parameters::ScannerVectorFrameBasic, scope::parameters::XYControlGalil, scope::parameters::XYControl, scope::parameters::Area, scope::parameters::InputsFPGA, scope::parameters::Behavior, scope::parameters::FastZControlETL, scope::parameters::FastZControl, scope::parameters::InputsDAQmx, scope::parameters::Timeseries, scope::parameters::XYZControlSutter, scope::parameters::XYZControlGalil, scope::parameters::Stimulation, scope::parameters::WindowCollection, scope::parameters::Stack, scope::parameters::Inputs, scope::parameters::Storage, scope::parameters::XYZControl, scope::parameters::Window, and scope::parameters::PlaneProperties.

Definition at line 33 of file Base.h.

virtual void scope::parameters::Base::Save ( wptree &  pt) const
inlinevirtual

save parameters into a boost:property_tree

Reimplemented in scope::parameters::Daq, scope::parameters::OutputsDAQmxResonance, scope::parameters::OutputsDAQmxSlave, scope::parameters::OutputsDAQmxLineClock, scope::parameters::OutputsDAQmx, scope::parameters::Outputs, scope::parameters::ScannerVectorFrameResonance, scope::parameters::InputsFPGAResonanceScanner, scope::parameters::InputsFPGAAnalogIntegrator, scope::parameters::ScannerVectorFramePlaneHopper, scope::parameters::InputsFPGAAnalogDemultiplexer, scope::parameters::ScannerVectorFrameBiDi, scope::parameters::InputsFPGAIO5751, scope::parameters::InputsFPGAIO5771, scope::parameters::ScannerVectorFrameSaw, scope::parameters::InputsFPGAPhotonCounter, scope::parameters::InputsFPGADigitalDemultiplexer, scope::parameters::XYControlStanda, scope::parameters::InputsFPGAIO6587, scope::parameters::ScannerVectorFrameBasic, scope::parameters::XYControlGalil, scope::parameters::XYControl, scope::parameters::Area, scope::parameters::InputsFPGA, scope::parameters::Behavior, scope::parameters::FastZControlETL, scope::parameters::FastZControl, scope::parameters::InputsDAQmx, scope::parameters::Timeseries, scope::parameters::XYZControlSutter, scope::parameters::XYZControlGalil, scope::parameters::Stimulation, scope::parameters::WindowCollection, scope::parameters::Stack, scope::parameters::Inputs, scope::parameters::Storage, scope::parameters::XYZControl, scope::parameters::Window, and scope::parameters::PlaneProperties.

Definition at line 36 of file Base.h.

virtual void scope::parameters::Base::SetReadOnlyWhileScanning ( const RunState &  _runstate)
inlinevirtual

set values that must not be changed to read-only during scanning.

True = readonly, false = read&write

Reimplemented in scope::parameters::Daq, scope::parameters::OutputsDAQmxResonance, scope::parameters::OutputsDAQmxSlave, scope::parameters::OutputsDAQmxLineClock, scope::parameters::OutputsDAQmx, scope::parameters::Outputs, scope::parameters::ScannerVectorFrameResonance, scope::parameters::InputsFPGAResonanceScanner, scope::parameters::InputsFPGAAnalogIntegrator, scope::parameters::ScannerVectorFramePlaneHopper, scope::parameters::InputsFPGAAnalogDemultiplexer, scope::parameters::ScannerVectorFrameBiDi, scope::parameters::InputsFPGAIO5751, scope::parameters::InputsFPGAIO5771, scope::parameters::ScannerVectorFrameSaw, scope::parameters::Scope, scope::parameters::InputsFPGAPhotonCounter, scope::parameters::InputsFPGADigitalDemultiplexer, scope::parameters::InputsFPGAIO6587, scope::parameters::ScannerVectorFrameBasic, scope::parameters::Area, scope::parameters::InputsFPGA, scope::parameters::Behavior, scope::parameters::InputsDAQmx, scope::parameters::Timeseries, scope::parameters::Stimulation, scope::parameters::WindowCollection, scope::parameters::Stack, scope::parameters::Inputs, scope::parameters::Storage, and scope::parameters::Window.

Definition at line 39 of file Base.h.

Member Data Documentation

std::vector<boost::signals2::connection> scope::parameters::Base::connection_collector
protected

You can put connections between ScopeValues in different classes in here.

The base class destructor calls disconnect on all of them. Connections between ScopeValues of the same class do not have to go in there, once the members are destroyed the connection is gone anyway.

Definition at line 27 of file Base.h.

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