Tango Core Classes Reference  9.3.4
Tango::DeviceDataHistory Class Reference

Fundamental type for receiving data from device command polling buffers. More...

#include "tango.h"

Inheritance diagram for Tango::DeviceDataHistory:
Collaboration diagram for Tango::DeviceDataHistory:

Public Member Functions

TimeVal & get_date ()
 Get record polling date. More...
 
const DevErrorList & get_err_stack ()
 Get record error stack. More...
 
bool has_failed ()
 Check if the record was a failure. More...
 
- Public Member Functions inherited from DeviceData
 DeviceData ()
 Create a DeviceData object. More...
 
void exceptions (bitset< numFlags > fl)
 Set exception flag. More...
 
bitset< numFlags > exceptions ()
 Get exception flag. More...
 
void reset_exceptions (except_flags fl)
 Reset one exception flag. More...
 
void set_exceptions (except_flags fl)
 Set one exception flag. More...
 
bitset< numFlags > state ()
 Get instance extraction state. More...
 
void operator<< (bool datum)
 The insert operators. More...
 
void insert (vector< DevLong > &vl, vector< string > &vs)
 Insert data into a DeviceData for the DevVarLongStringArray data type. More...
 
void insert (vector< double > &vd, vector< string > &vs)
 Insert data into a DeviceData for the DevVarDoubleStringArray data type. More...
 
void insert (const string &str, vector< unsigned char > &buffer)
 Insert data into a DeviceData for the DevEncoded data type. More...
 
bool operator>> (bool &datum)
 The extract operators. More...
 
bool extract (vector< DevLong > &vl, vector< string > &vs)
 Extract data from a DeviceData for the DevVarLongStringArray data type. More...
 
bool extract (vector< double > &vd, vector< string > &vs)
 Extract data from a DeviceData for the DevVarDoubleStringArray data type. More...
 
bool extract (const char *&str, const unsigned char *&data, unsigned int &length)
 Extract data from a DeviceData for the DevEncoded data type. More...
 
bool is_empty ()
 Check if the DeviceData instance is empty. More...
 
int get_type ()
 Get Tango data type of the included data. More...
 

Detailed Description

Fundamental type for receiving data from device command polling buffers.

This is the fundamental type for receiving data from device command polling buffers. This class inherits from the Tango::DeviceData class. One instance of this class is created for each command result history. Within this class, you find the command result data or the exception parameters, a flag indicating if the command has failed when it was invoked by the device server polling thread and the date when the command was executed. For history calls, it is not possible to returns command error as exception. See chapter on Advanced Features in the Tango book for all details regarding device polling.

$Author$ $Revision$

Member Function Documentation

◆ get_date()

TimeVal& Tango::DeviceDataHistory::get_date ( )
inline

Get record polling date.

Returns the date when the device server polling thread has executed the command.

Returns
The record polling date

◆ get_err_stack()

const DevErrorList& Tango::DeviceDataHistory::get_err_stack ( )
inline

Get record error stack.

Return the error stack recorded by the device server polling thread in case of the command failed when it was invoked.

Returns
The record error stack

◆ has_failed()

bool Tango::DeviceDataHistory::has_failed ( )
inline

Check if the record was a failure.

Returns a boolean set to true if the record in the polling buffer was a failure

Returns
A boolean set to true if the record was a failure

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