ddt::DataAcquisition Class Reference

#include <dataAcquisition.hpp>

Public Types
typedef boost::signals2::signal< void(ddt::DdtDataTransferLib::ConnectionState)>	ConnectionStateSignalT

Public Member Functions
	DataAcquisition ()
virtual	~DataAcquisition ()
void	set_logger (ddt::DdtLogger *const in_logger)
void	AttachDataStream (const std::string data_stream_id)
void	DetachDataStream (const std::string data_stream_id)
void	ProcessNewData ()
SignalT *	DataAvailableSignal ()
ConnectionStateSignalT *	ConnectionStateSignal ()
ddt::DataSample *	get_DataSample ()
ddt::DdtStatistics *	get_DataStatistics ()
bool	get_AttachedToStream () const
void	set_RetrieveStatsFlag (bool value)

Protected Attributes
ddt::DdtLogger *	logger

Detailed Description

Class to wrap the usage of data stream acquisition functions.

This class offers functions to attach to and detach from a data stream. Attaching to the data stream is realized by a Data Subscriber that connects to a Data Broker. In case of new data available from the subscriber, a corresponding signal is sent out.

Member Typedef Documentation

ConnectionStateSignalT

typedef boost::signals2::signal<void(ddt::DdtDataTransferLib::ConnectionState)> ddt::DataAcquisition::ConnectionStateSignalT

Boost signal used to forward broker connection-state changes.

Constructor & Destructor Documentation

DataAcquisition()

DataAcquisition::DataAcquisition

(

)

Constructor

~DataAcquisition()

DataAcquisition::~DataAcquisition ( )

virtualdefault

Destructor

Member Function Documentation

AttachDataStream()

void DataAcquisition::AttachDataStream

(

const std::string

data_stream_id

)

Attach to a data stream

Parameters

data_stream_id

The ID of the data stream (could be the URI)

ConnectionStateSignal()

DataAcquisition::ConnectionStateSignalT * DataAcquisition::ConnectionStateSignal

(

)

Access to the broker connection-state signal. The signal is fired by the underlying subscriber whenever the heartbeat or MAL listener detects a change in the broker connection.

DataAvailableSignal()

SignalT * DataAcquisition::DataAvailableSignal

(

)

Access to the data available signal

DetachDataStream()

void DataAcquisition::DetachDataStream

(

const std::string

data_stream_id

)

Detach from a data stream

Parameters

data_stream_id

The ID of the stream to be disconnected

get_AttachedToStream()

bool DataAcquisition::get_AttachedToStream

(

)

const

Get the attached to stream flag

Returns

the flag indicating if the data acquisition is attached to a data stream

get_DataSample()

ddt::DataSample * DataAcquisition::get_DataSample

(

)

Get the currently available data sample

Returns

the available DataSample

get_DataStatistics()

ddt::DdtStatistics * DataAcquisition::get_DataStatistics

(

)

Get statistics from the subscriber

Returns

the last sample of statistics data

ProcessNewData()

void DataAcquisition::ProcessNewData

(

)

Event handler for new data on data stream

set_logger()

void DataAcquisition::set_logger

(

ddt::DdtLogger *const

in_logger

)

Set logger

Parameters

in_logger

A DDT logger object (no transfer of ownership).

set_RetrieveStatsFlag()

void DataAcquisition::set_RetrieveStatsFlag

(

bool

value

)

Enable or disable subscriber statistics extraction

Returns

the flag indicating if the data acquisition is attached to a data stream

Member Data Documentation

logger

ddt::DdtLogger* ddt::DataAcquisition::logger

protected

The logger object

---

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

• imagehandling/imagelibs/src/include/ddt/dataAcquisition.hpp
• imagehandling/imagelibs/src/dataAcquisition.cpp