Tango Core Classes Reference  9.3.3
Tango::WPipe Class Reference

This class is a class representing a writable pipe in the TANGO device server pattern. More...

#include "tango.h"

Inheritance diagram for Tango::WPipe:
Collaboration diagram for Tango::WPipe:

Public Member Functions

Constructors

Miscellaneous constructors

 WPipe ()
 Constructs a newly allocated WPipe object. More...
 
 WPipe (const string &na, const Tango::DispLevel level)
 Constructs a newly allocated WPipe object from its name, its description, its label and its display level. More...
 
Destructor

Only one desctructor is defined for this class

virtual ~WPipe ()
 The object desctructor.
 
Get/Set methods.

Methods to get the value of the data blob transported by the pipe

string get_root_blob_name ()
 Get root blob name. More...
 
Extracting data from a WPipe
WPipeoperator>> (short &datum)
 Extract data from a device pipe. More...
 
size_t get_data_elt_nb ()
 Get root blob data element number. More...
 
vector< string > get_data_elt_names ()
 Get root blob data elements name. More...
 
string get_data_elt_name (size_t ind)
 Get root blob data element name. More...
 
int get_data_elt_type (size_t ind)
 Get root blob data element value type. More...
 
- Public Member Functions inherited from Tango::Pipe
 Pipe ()
 Constructs a newly allocated Pipe object. More...
 
 Pipe (const string &name, const Tango::DispLevel level, const PipeWriteType pwt=PIPE_READ)
 Constructs a newly allocated Pipe object from its name and its display level. More...
 
virtual ~Pipe ()
 The object desctructor.
 
string & get_name ()
 Return the pipe name. More...
 
void set_name (string &new_name)
 Set the pipe name. More...
 
void set_default_properties (UserDefaultPipeProp &prop)
 Set default attribute properties. More...
 
string & get_lower_name ()
 Return the pipe name in lower case letters. More...
 
const string & get_root_blob_name ()
 Return the root data blob name. More...
 
void set_root_blob_name (const string &name)
 Set the root data blob name. More...
 
string & get_desc ()
 Return the pipe description. More...
 
string & get_label ()
 Return the pipe label. More...
 
Tango::DispLevel get_disp_level ()
 Return the pipe display level. More...
 
Tango::PipeWriteType get_writable ()
 Get the pipe writable type (RO/RW). More...
 
void set_pipe_serial_model (PipeSerialModel ser_model)
 Set pipe serialization model. More...
 
PipeSerialModel get_pipe_serial_model ()
 Get pipe serialization model. More...
 
void set_user_pipe_mutex (omni_mutex *mut_ptr)
 Set pipe user mutex. More...
 
Pipeoperator<< (short &datum)
 Insert data into a device pipe. More...
 
void set_data_elt_nb (size_t nb)
 Set blob data element number. More...
 
void set_data_elt_names (vector< string > &names)
 Set blob data element number and names. More...
 
size_t get_data_elt_nb ()
 Get blob data element number. More...
 
void exceptions (bitset< DevicePipeBlob::numFlags > fl)
 Set exception flag. More...
 
bitset< DevicePipeBlob::numFlags > exceptions ()
 Get exception flag. More...
 
void reset_exceptions (DevicePipeBlob::except_flags fl)
 Reset one exception flag. More...
 
void set_exceptions (DevicePipeBlob::except_flags fl)
 Set one exception flag. More...
 
bool has_failed ()
 Check insertion/extraction success. More...
 
bitset< DevicePipeBlob::numFlags > state ()
 Get instance insertion/extraction state. More...
 

Additional Inherited Members

- Protected Attributes inherited from Tango::Pipe
string name
 The pipe name.
 
string lower_name
 The pipe name in lower case.
 
string desc
 The pipe description.
 
string label
 The pipe label.
 
Tango::DispLevel disp_level
 The pipe display level.
 
Tango::PipeWriteType writable
 The pipe R/W type.
 

Detailed Description

This class is a class representing a writable pipe in the TANGO device server pattern.

It is an base class. It is the a root class for pipe related classes.

$Author$ $Revision$

Constructor & Destructor Documentation

◆ WPipe() [1/2]

Tango::WPipe::WPipe ( )
inline

Constructs a newly allocated WPipe object.

The default constructor

◆ WPipe() [2/2]

Tango::WPipe::WPipe ( const string &  na,
const Tango::DispLevel  level 
)

Constructs a newly allocated WPipe object from its name, its description, its label and its display level.

Parameters
naThe pipe name
levelThe pipe display level

Member Function Documentation

◆ get_data_elt_name()

string Tango::WPipe::get_data_elt_name ( size_t  ind)
inline

Get root blob data element name.

Get the root blob data element name for a single data element

Parameters
[in]indThe data element index within the root blob
Returns
The root blob data element name

References Tango::DevicePipeBlob::get_data_elt_name().

◆ get_data_elt_names()

vector<string> Tango::WPipe::get_data_elt_names ( )
inline

Get root blob data elements name.

Get the root blob data elements name

Returns
The root blob data elements name

References Tango::DevicePipeBlob::get_data_elt_names().

◆ get_data_elt_nb()

size_t Tango::WPipe::get_data_elt_nb ( )
inline

Get root blob data element number.

Get the root blob data element number

Returns
The root blob data element number

References Tango::DevicePipeBlob::get_data_elt_nb().

◆ get_data_elt_type()

int Tango::WPipe::get_data_elt_type ( size_t  ind)
inline

Get root blob data element value type.

Get the root blob data element value type for a single data element

Parameters
[in]indThe data element index within the root blob
Returns
The blob data element value type

References Tango::DevicePipeBlob::get_data_elt_type().

◆ get_root_blob_name()

string Tango::WPipe::get_root_blob_name ( )
inline

Get root blob name.

Get the root blob name

Returns
The root blob name

References Tango::DevicePipeBlob::get_name().

◆ operator>>()

WPipe& Tango::WPipe::operator>> ( short &  datum)

Extract data from a device pipe.

Extracting data from a WPipe instance is simlar to extracting data from a DevicePipeBlob class instance. See doc of DevicePipeBlob class extraction methods (DevicePipeBlob::operator>>) to get a complete documentation on how to extract data from a WPipe

Parameters
[in]datumThe pipe data
Exceptions
WrongDataif requested

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