Scope
scope::parameters::ScannerVectorFramePlaneHopper Class Reference

#include <Framescan.h>

Inherits scope::parameters::ScannerVectorFrameBasic.

Classes

class  Preset
 

Public Member Functions

std::vector< boost::signals2::connection > ConnectCopyTrigger (signalchange_t::slot_type _slot) override
 
void ConnectRateUpdate (signalchange_t::slot_type _slot) override
 
void ConnectMicronPerPixelUpdate (signalchange_t::slot_type _slot) override
 
void ConnectOnlineUpdate (signalchange_t::slot_type _slot) override
 
void Load (const wptree &pt) override
 
void Save (wptree &pt) const override
 
void SetReadOnlyWhileScanning (const RunState &_runstate) override
 
std::unique_ptr< ScannerVectorFrameBasic::PresetMakePreset () const override
 
void SaveToPreset (const std::wstring &_name, const Daq &_daq) override
 
void LoadFromPreset (const std::wstring &_name, Daq &_daq) override
 
- Public Member Functions inherited from scope::parameters::ScannerVectorFrameBasic
virtual void ConnectResolutionUpdate (signalchange_t::slot_type _slot)
 
virtual void ConnectResolutionChange (signalchange_t::slot_type _slot)
 
virtual uint32_t XImagePixels () const
 
virtual uint32_t YImageLines () const
 
virtual uint32_t XTotalPixels () const
 
virtual uint32_t YTotalLines () const
 
uint32_t TotalPixels () const override
 
uint32_t TotalPixelsOneFrame () const override
 
virtual void DeletePreset (const std::wstring &_name)
 
virtual void CoerceOffset ()
 

Static Public Member Functions

static std::unique_ptr< ScannerVectorFrameBasicCreate ()
 
static std::unique_ptr< ScannerVectorFrameBasicCreate (const ScannerVectorFramePlaneHopper &_o)
 
- Static Public Member Functions inherited from scope::parameters::ScannerVectorFrameBasic
static std::unique_ptr< ScannerVectorFrameBasicCreate ()
 
static std::unique_ptr< ScannerVectorFrameBasicCreate (const ScannerVectorFrameBasic &_o)
 
static std::unique_ptr< ScannerVectorFrameBasicFactory (const ScannerVectorType &_type, const ScannerVectorFrameBasic *const _o=nullptr)
 

Public Attributes

std::vector< PlanePropertiesplanes
 
- Public Attributes inherited from scope::parameters::ScannerVectorFrameBasic
std::vector< std::shared_ptr< Preset > > presets
 
ScopeNumber< uint32_t > xres
 
ScopeNumber< uint32_t > yres
 
ScopeNumber< double > xaspectratio
 
ScopeNumber< double > yaspectratio
 
ScopeNumber< bool > squarepixels
 
ScopeNumber< double > zoom
 
ScopeNumber< double > xoffset
 
ScopeNumber< double > yoffset
 
ScopeNumber< double > fastz
 
ScopeNumber< double > pockels
 
ScopeNumber< double > xrotation
 
ScopeNumber< double > yrotation
 

Additional Inherited Members

- Protected Types inherited from scope::parameters::ScannerVector
typedef boost::signals2::signal< void()> signalchange_t
 
- Protected Attributes inherited from scope::parameters::Base
std::vector< boost::signals2::connection > connection_collector
 

Detailed Description

Parameters for a ScannerVectorFramePlaneHopper.

Definition at line 391 of file Framescan.h.

Member Function Documentation

static std::unique_ptr<ScannerVectorFrameBasic> scope::parameters::ScannerVectorFramePlaneHopper::Create ( )
inlinestatic

Create function for factory.

Definition at line 411 of file Framescan.h.

static std::unique_ptr<ScannerVectorFrameBasic> scope::parameters::ScannerVectorFramePlaneHopper::Create ( const ScannerVectorFramePlaneHopper _o)
inlinestatic

Create copy function for factory.

Definition at line 414 of file Framescan.h.

std::vector< boost::signals2::connection > scope::parameters::ScannerVectorFramePlaneHopper::ConnectCopyTrigger ( signalchange_t::slot_type  _slot)
overridevirtual

Connect a slot that is called if some member parameter changes, this can be used to copy certain changes in a master area to its slave areas.

Except changes in parameters that are area specific (e.g. pockels).

Returns
a vector with all connections made, for storage and destructor call
Parameters
[in]_slotThe slot that is connected to all ScopeValues in the ScannerVector

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 483 of file Framescan.cpp.

void scope::parameters::ScannerVectorFramePlaneHopper::ConnectRateUpdate ( signalchange_t::slot_type  _slot)
overridevirtual

Connect a slot that is called if something in the ScannerVector changes that renders a recalculation of dependent rates (e.g.

framerate in parameters::Area) necessary

Parameters
[in]_slotThe slot that is connected to certain ScopeValues in the ScannerVector

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 493 of file Framescan.cpp.

void scope::parameters::ScannerVectorFramePlaneHopper::ConnectMicronPerPixelUpdate ( signalchange_t::slot_type  _slot)
overridevirtual

Connect a slot that is called if something in the ScannerVector changes that renders a recalculation of the micron per pixel (e.g.

through in parameters::Area::CalculateMicronPerPixel) necessary

Parameters
[in]_slotThe slot that is connected to certain ScopeValues in the ScannerVector

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 501 of file Framescan.cpp.

void scope::parameters::ScannerVectorFramePlaneHopper::ConnectOnlineUpdate ( signalchange_t::slot_type  _slot)
overridevirtual

Connect a slot that is called if something in the ScannerVector (which is displayed on the GUI) changes that makes an online update during scanning necessary.

Parameters
[in]_slotThe slot that is connected to certain/all ScopeValues in the ScannerVector, mainly this would be ScopeControllerImpl::UpdateAreaParametersFromGui

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 509 of file Framescan.cpp.

void scope::parameters::ScannerVectorFramePlaneHopper::Load ( const wptree &  pt)
overridevirtual

load parameters from a boost::property_tree

implement

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 531 of file Framescan.cpp.

void scope::parameters::ScannerVectorFramePlaneHopper::Save ( wptree &  pt) const
overridevirtual

save parameters into a boost:property_tree

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 538 of file Framescan.cpp.

void scope::parameters::ScannerVectorFramePlaneHopper::SetReadOnlyWhileScanning ( const RunState _runstate)
overridevirtual

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

True = readonly, false = read&write

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 549 of file Framescan.cpp.

std::unique_ptr< ScannerVectorFrameBasic::Preset > scope::parameters::ScannerVectorFramePlaneHopper::MakePreset ( ) const
overridevirtual

Since preset loading is done in base class (here), we need to generate a derived preset, this can be done by calling this function and overriding it in derived classes.

(Be careful which classes Preset class is meant!)

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 553 of file Framescan.cpp.

void scope::parameters::ScannerVectorFramePlaneHopper::SaveToPreset ( const std::wstring &  _name,
const Daq _daq 
)
overridevirtual

Save parameters into a preset.

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 557 of file Framescan.cpp.

void scope::parameters::ScannerVectorFramePlaneHopper::LoadFromPreset ( const std::wstring &  _name,
Daq _daq 
)
overridevirtual

Load parameters from a preset.

Reimplemented from scope::parameters::ScannerVectorFrameBasic.

Definition at line 574 of file Framescan.cpp.

Member Data Documentation

std::vector<PlaneProperties> scope::parameters::ScannerVectorFramePlaneHopper::planes

vector with properties for all planes

Definition at line 425 of file Framescan.h.


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