qumbia-tango-controls 1.x
Library on top of cumbia-qtcontrols and cumbia-tango
Public Member Functions | List of all members
CuTWriterFactory Class Reference

implements CuControlsWriterFactoryI and creates Tango writers Given a pointer to a Cumbia object and a CuDataListener, the create method instantiates and returns a CuTControlsWriter, that implements CuControlsWriterA interface. If setOptions is called before create, the options are set on the CuControlsWriterA. More...

#include <cutcontrolswriter.h>

Inheritance diagram for CuTWriterFactory:
Inheritance graph
[legend]

Public Member Functions

 CuTWriterFactory ()
 
virtual ~CuTWriterFactory ()
 the class destructor More...
 
CuControlsWriterA * create (Cumbia *, CuDataListener *l) const
 creates and returns a new CuTControlsWriter, configured with the given Cumbia and CuDataListener. More...
 
CuControlsWriterFactoryI * clone () const
 clones the writer factory, allocating a new one with the same options More...
 
void setOptions (const CuData &o)
 set options through a CuData bundle. They are then passed to the CuTControlsWriter instantiated and returned by the create method More...
 

Detailed Description

implements CuControlsWriterFactoryI and creates Tango writers Given a pointer to a Cumbia object and a CuDataListener, the create method instantiates and returns a CuTControlsWriter, that implements CuControlsWriterA interface. If setOptions is called before create, the options are set on the CuControlsWriterA.

CuTWriterFactory can be cloned by means of the clone method.

Constructor & Destructor Documentation

◆ CuTWriterFactory()

CuTWriterFactory::CuTWriterFactory ( )

the class constructor

Referenced by clone().

◆ ~CuTWriterFactory()

CuTWriterFactory::~CuTWriterFactory ( )
virtual

the class destructor

Member Function Documentation

◆ clone()

CuControlsWriterFactoryI * CuTWriterFactory::clone ( ) const

clones the writer factory, allocating a new one with the same options

Returns
a new CuTWriterFactory with options copied from this object

References CuTWriterFactory().

◆ create()

CuControlsWriterA * CuTWriterFactory::create ( Cumbia *  c,
CuDataListener *  l 
) const

creates and returns a new CuTControlsWriter, configured with the given Cumbia and CuDataListener.

Call setOptions before create to configure the writer. See setOptions for a list of predefined keys.

Parameters
ca pointer to the CumbiaTango object
la pointer to an object implementing the CuDataListener interface
Returns
a CuTControlsWriter, an implementation of CuControlsWriterA abstract class

References CuTControlsWriter::setOptions().

◆ setOptions()

void CuTWriterFactory::setOptions ( const CuData &  o)

set options through a CuData bundle. They are then passed to the CuTControlsWriter instantiated and returned by the create method

Parameters
oa CuData bundle of key/value pairs
Key/value pairs
  • no-properties [bool, default: false]. If true, skip attribute configuration in setTarget.
  • fetch_props [std::vector<std::string>, default: empty] list of attribute properties to fetch from the database during configuration. The no-properties key must be left to false (default).
See also
create

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