CFEL - ASG Software Suite  2.5.0
CASS
Public Types | Public Member Functions | Private Attributes | List of all members
cass::ACQIRIS::Instrument Class Reference

An Acqiris Instrument. More...

#include <acqiris_device.hpp>

+ Inheritance diagram for cass::ACQIRIS::Instrument:
+ Collaboration diagram for cass::ACQIRIS::Instrument:

Public Types

typedef std::vector< Channelchannels_t
 a vector of Channels More...
 

Public Member Functions

 Instrument ()
 constructor More...
 
 Instrument (SerializerBackend &in)
 constuct class from stream More...
 
virtual void serialize (SerializerBackend &out) const
 will serialize all channels to Serializer More...
 
virtual bool deserialize (SerializerBackend &in)
 will deserialize all channels from the Serializer More...
 
const channels_tchannels () const
 
channels_tchannels ()
 
uint64_t id () const
 
uint64_t & id ()
 
- Public Member Functions inherited from cass::Serializable
 Serializable (uint16_t version)
 constructor initializing the version More...
 
virtual ~Serializable ()
 virtual destructor to avoid warning with gcc 4.1.2 More...
 
uint16_t ver () const
 retrieve the version of the serializer More...
 
virtual void writeVersion (SerializerBackend &out) const
 write the version to the stream More...
 
virtual void checkVersion (SerializerBackend &in) const
 check the version More...
 

Private Attributes

channels_t _channels
 Container for all Channels. More...
 
uint64_t _eventID
 the eventid that this detector belongs to (can be used for crosschecks More...
 

Additional Inherited Members

- Protected Attributes inherited from cass::Serializable
uint16_t _version
 the version for de/serializing More...
 

Detailed Description

An Acqiris Instrument.

An Acqiris Instrument represents the actual Acqiris (Multi)-Instrument, which contains a lot of channels

Author
Lutz Foucar

Definition at line 31 of file acqiris_device.hpp.

Member Typedef Documentation

a vector of Channels

Definition at line 51 of file acqiris_device.hpp.

Constructor & Destructor Documentation

cass::ACQIRIS::Instrument::Instrument ( )
inline

constructor

Definition at line 35 of file acqiris_device.hpp.

cass::ACQIRIS::Instrument::Instrument ( SerializerBackend in)
inline

constuct class from stream

Parameters
inthe stream to construct this class from

Definition at line 43 of file acqiris_device.hpp.

References deserialize().

Member Function Documentation

const channels_t& cass::ACQIRIS::Instrument::channels ( ) const
inline
Returns
the channels of this instrument

Definition at line 86 of file acqiris_device.hpp.

References _channels.

Referenced by cass::ACQIRIS::LmaReader::readHeaderInfo().

channels_t& cass::ACQIRIS::Instrument::channels ( )
inline
Returns
a reference, so that one can edit the channels

Definition at line 89 of file acqiris_device.hpp.

References _channels.

virtual bool cass::ACQIRIS::Instrument::deserialize ( SerializerBackend in)
inlinevirtual

will deserialize all channels from the Serializer

Returns
true when this class was deserialized from the stream sucessfully
Parameters
inthe stream to serialize this class from

read how many channels

clear the channels container and deserialize the channels from the stream

Implements cass::Serializable.

Definition at line 72 of file acqiris_device.hpp.

References _channels, cass::Serializable::checkVersion(), and cass::SerializerBackend::retrieve().

Referenced by Instrument().

uint64_t cass::ACQIRIS::Instrument::id ( ) const
inline
Returns
the event id

Definition at line 92 of file acqiris_device.hpp.

References _eventID.

Referenced by cass::ACQIRIS::Converter::operator()().

uint64_t& cass::ACQIRIS::Instrument::id ( )
inline
Returns
reference to the eventid

Definition at line 95 of file acqiris_device.hpp.

References _eventID.

virtual void cass::ACQIRIS::Instrument::serialize ( SerializerBackend out) const
inlinevirtual

will serialize all channels to Serializer

Parameters
outthe stream to serialze this class to

copy the size of the channels and then all channels

Implements cass::Serializable.

Definition at line 58 of file acqiris_device.hpp.

References _channels, cass::SerializerBackend::add(), and cass::Serializable::writeVersion().

Member Data Documentation

channels_t cass::ACQIRIS::Instrument::_channels
private

Container for all Channels.

Definition at line 99 of file acqiris_device.hpp.

Referenced by channels(), deserialize(), and serialize().

uint64_t cass::ACQIRIS::Instrument::_eventID
private

the eventid that this detector belongs to (can be used for crosschecks

Definition at line 102 of file acqiris_device.hpp.

Referenced by id().


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