scope::Inputs Class Reference

#include <Inputs.h>

Inherited by scope::InputsDAQmx, and scope::InputsFPGA.

Public Member Functions
	Inputs (const uint32_t &_area)
virtual void	Start ()=0
virtual void	Stop ()=0
virtual uint32_t	RequestedSamples () const
virtual uint32_t	StandardChunkSize () const
virtual int32_t	Read (DaqChunk &_chunk, bool &_timedout, const double &_timeout)=0

Protected Attributes
const uint32_t	area
uint32_t	requested_samples

Detailed Description

Wraps hardware connection for signal input from PMTs.

Definition at line 13 of file Inputs.h.

Constructor & Destructor Documentation

scope::Inputs::Inputs

(

const uint32_t &

_area

)

get the area and set up everything

Definition at line 7 of file Inputs.cpp.

Member Function Documentation

virtual void scope::Inputs::Start ( )

pure virtual

Start task.

Implemented in scope::InputsFPGA, and scope::InputsDAQmx.

virtual void scope::Inputs::Stop ( )

pure virtual

Stops task.

Implemented in scope::InputsFPGA, and scope::InputsDAQmx.

uint32_t scope::Inputs::RequestedSamples ( ) const

virtual

Returns

the total number of samples that should be read for that area.

Definition at line 16 of file Inputs.cpp.

virtual uint32_t scope::Inputs::StandardChunkSize ( ) const

inlinevirtual

Returns

the standard size of a read chunk (per channel)

Reimplemented in scope::InputsDAQmx.

Definition at line 38 of file Inputs.h.

virtual int32_t scope::Inputs::Read ( DaqChunk &  _chunk, bool &  _timedout, const double &  _timeout  )

pure virtual

Reads one chunk of samples for one area.

Parameters

[in,out]	_chunk	chunk to fill with the read data
[out]	_timedout	true if read timed out
[in]	_timeout	timeout in seconds after which to return even if not enough samples were read

Returns

the number of samples per channel actually read

Implemented in scope::InputsFPGA, and scope::InputsDAQmx.

Member Data Documentation

const uint32_t scope::Inputs::area

protected

the area

Definition at line 17 of file Inputs.h.

uint32_t scope::Inputs::requested_samples

protected

the total number of samples that should be read (in case of nframes mode) otherwise the buffer size (usually one frame)

Definition at line 20 of file Inputs.h.

---

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

• scope/devices/Inputs.h
• scope/devices/Inputs.cpp