Tango Core Classes Reference  9.3.3
Tango::FwdAttr Class Reference

User class to create a forwarded attribute object. More...

#include "tango.h"

Inheritance diagram for Tango::FwdAttr:
Collaboration diagram for Tango::FwdAttr:

Public Member Functions

Constructors

Only one constructor is defined for this class

 FwdAttr (const string &name, const string &root_attribute=RootAttNotDef)
 Constructs a newly allocated FwdAttr object. More...
 
Miscellaneous methods
void set_default_properties (UserDefaultFwdAttrProp &prop)
 Set default attribute properties. More...
 
- Public Member Functions inherited from Tango::ImageAttr
 ImageAttr (const char *name, long data_type, long max_x, long max_y)
 Constructs a newly allocated ImageAttr object. More...
 
 ImageAttr (const char *name, long data_type, Tango::AttrWriteType w_type, long max_x, long max_y)
 Constructs a newly allocated ImageAttr object. More...
 
 ImageAttr (const char *name, long data_type, long max_x, long max_y, Tango::DispLevel level)
 Constructs a newly allocated ImageAttr object. More...
 
 ImageAttr (const char *name, long data_type, Tango::AttrWriteType w_type, long max_x, long max_y, Tango::DispLevel level)
 Constructs a newly allocated ImageAttr object. More...
 
 ImageAttr (const char *name)
 Constructs a newly allocated ImageAttr object. More...
 
 ~ImageAttr ()
 The object destructor.
 
- Public Member Functions inherited from Tango::SpectrumAttr
 SpectrumAttr (const char *name, long data_type, long max_x)
 Constructs a newly allocated SpectrumAttr object. More...
 
 SpectrumAttr (const char *name, long data_type, Tango::AttrWriteType w_type, long max_x)
 Constructs a newly allocated SpectrumAttr object. More...
 
 SpectrumAttr (const char *name, long data_type, long max_x, DispLevel level)
 Constructs a newly allocated SpectrumAttr object. More...
 
 SpectrumAttr (const char *name, long data_type, Tango::AttrWriteType w_type, long max_x, DispLevel level)
 Constructs a newly allocated SpectrumAttr object. More...
 
 SpectrumAttr (const char *name)
 Constructs a newly allocated SpectrumAttr object. More...
 
 ~SpectrumAttr ()
 The object destructor.
 
- Public Member Functions inherited from Tango::Attr
 Attr (const char *name, long data_type, Tango::AttrWriteType w_type=Tango::READ, const char *assoc=AssocWritNotSpec)
 Constructs a newly allocated Attr object. More...
 
 Attr (const char *name, long data_type, Tango::DispLevel disp, Tango::AttrWriteType w_type=Tango::READ, const char *assoc=AssocWritNotSpec)
 Constructs a newly allocated Attr object. More...
 
 Attr (const char *name, Tango::DispLevel disp=Tango::OPERATOR)
 Constructs a newly allocated Attr object. More...
 
virtual ~Attr ()
 The object destructor.
 
void set_default_properties (UserDefaultAttrProp &prop)
 Set default attribute properties. More...
 
void set_disp_level (Tango::DispLevel level)
 Set the attribute display level. More...
 
void set_polling_period (long update)
 Set the attribute polling update period. More...
 
void set_memorized ()
 Set the attribute as memorized in database (only for scalar and writable attribute) By default the setpoint will be written to the attribute during initialisation! Use method set_memorized_init() with false as argument if you don't want this feature.
 
void set_memorized_init (bool write_on_init)
 Set the initialisation flag for memorized attributes true = the setpoint value will be written to the attribute on initialisation false = only the attribute setpoint is initialised. More...
 
void set_change_event (bool implemented, bool detect)
 Set a flag to indicate that the server fires change events manually without the polling to be started for the attribute. More...
 
bool is_change_event ()
 Check if the change event is fired manually for this attribute. More...
 
bool is_check_change_criteria ()
 Check if the change event criteria should be checked when firing the event manually. More...
 
void set_archive_event (bool implemented, bool detect)
 Set a flag to indicate that the server fires archive events manually without the polling to be started for the attribute If the detect parameter is set to true, the criteria specified for the archive event are verified and the event is only pushed if they are fulfilled. More...
 
bool is_archive_event ()
 Check if the archive event is fired manually for this attribute. More...
 
bool is_check_archive_criteria ()
 Check if the archive event criteria should be checked when firing the event manually. More...
 
void set_data_ready_event (bool implemented)
 Set a flag to indicate that the server fires data ready events. More...
 
bool is_data_ready_event ()
 Check if the data ready event is fired for this attribute. More...
 

Detailed Description

User class to create a forwarded attribute object.

Information from this class and information fetched out from the Tango database allows the Tango core software to create the FwdAttribute object for the forwarded attribute created by the user.

$Author$ $Revision$

Constructor & Destructor Documentation

◆ FwdAttr()

Tango::FwdAttr::FwdAttr ( const string &  name,
const string &  root_attribute = RootAttNotDef 
)

Constructs a newly allocated FwdAttr object.

Parameters
nameThe attribute name
root_attributeThe root attribute name (FQAN)

Member Function Documentation

◆ set_default_properties()

void Tango::FwdAttr::set_default_properties ( UserDefaultFwdAttrProp prop)

Set default attribute properties.

Parameters
propThe user default property class

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