ESRF Logo

Elettra Logo

Soleil Logo

Alba Logo

Desy Logo

MAX-lab Logo

FRM2 Logo


SYNCHROTRON ALBA --- SYNCHROTRON ELETTRA

EUROPEAN SYNCHROTRON RADIATION FACILITY --- SYNCHROTRON PETRA III

SYNCHROTRON SOLEIL --- SYNCHROTRON MAX 4

NEUTRON SOURCE FRM 2

Tango::Attribute Class Reference

This class represents a Tango attribute. More...

#include <attribute.h>

Inheritance diagram for Tango::Attribute:

Tango::WAttribute

List of all members.

Public Member Functions

Constructors
Miscellaneous constructors

 Attribute (vector< AttrProperty > &prop_list, Attr &tmp_attr, string &dev_name, long idx)
 Create a new Attribute object.
Destructor
Only one desctructor is defined for this class

virtual ~Attribute ()
 The attribute desctructor.
Check attribute methods
Miscellaneous method returning boolean flag accorrding to attribute state

bool is_writ_associated ()
 Check if the attribute has an associated writable attribute.
bool is_min_alarm ()
 Check if the attribute is in minimum alarm condition .
bool is_max_alarm ()
 Check if the attribute is in maximum alarm condition .
bool is_min_warning ()
 Check if the attribute is in minimum warning condition .
bool is_max_warning ()
 Check if the attribute is in maximum warning condition .
bool is_rds_alarm ()
 Check if the attribute is in RDS alarm condition .
bitset< numFlags > & is_alarmed ()
 Check if the attribute has an alarm defined.
bool is_polled ()
 Check if the attribute is polled .
bool check_alarm ()
 Check if the attribute read value is below/above the alarm level.
Get/Set object members.
These methods allows the external world to get/set DeviceImpl instance data members

Tango::AttrWriteType get_writable ()
 Get the attribute writable type (RO/WO/RW).
string & get_name ()
 Get attribute name.
long get_data_type ()
 Get attribute data type.
Tango::AttrDataFormat get_data_format ()
 Get attribute data format.
string & get_assoc_name ()
 Get name of the associated writable attribute.
long get_assoc_ind ()
 Get index of the associated writable attribute.
void set_assoc_ind (long val)
 Set index of the associated writable attribute.
Tango::TimeVal & get_date ()
 Get attribute date.
void set_date (Tango::TimeVal &new_date)
 Set attribute date.
void set_date (struct timeval &t)
 Set attribute date.
void set_date (time_t new_date)
 Set attribute date.
string & get_label ()
 Get attribute label property.
Tango::AttrQuality & get_quality ()
 Get attribute data quality.
void set_quality (Tango::AttrQuality qua, bool send_event=false)
 Set attribute data quality.
long get_data_size ()
 Get attribute data size.
long get_x ()
 Get attribute data size in x dimension.
long get_max_dim_x ()
 Get attribute maximum data size in x dimension.
long get_y ()
 Get attribute data size in y dimension.
long get_max_dim_y ()
 Get attribute maximum data size in y dimension.
long get_polling_period ()
 Get attribute polling period.
void get_properties (Tango::AttributeConfig &conf)
 Get attribute properties.
void get_properties_2 (Tango::AttributeConfig_2 &conf)
 Get attribute properties version 2.
void get_properties_3 (Tango::AttributeConfig_3 &conf)
 Get attribute properties version 3.
void set_properties (const Tango::AttributeConfig &conf, Tango::DeviceImpl *dev)
 Set attribute properties.
void set_properties (const Tango::AttributeConfig_3 &conf, Tango::DeviceImpl *dev)
 Set attribute properties version 3.
void set_attr_serial_model (AttrSerialModel ser_model)
 Set attribute serialization model.
AttrSerialModel get_attr_serial_model ()
 Get attribute serialization model.
void set_user_attr_mutex (omni_mutex *mut_ptr)
 Set attribute user mutex.
Set attribute value methods.
These methods allows the external world to set attribute object internal value

void set_value (Tango::DevShort *p_data, long x=1, long y=0, bool release=false)
 Set internal attribute value (for Tango::DevShort attribute data type).
void set_value (Tango::DevLong *p_data, long x=1, long y=0, bool release=false)
 Set internal attribute value (for Tango::DevLong attribute data type).
void set_value (Tango::DevLong64 *p_data, long x=1, long y=0, bool release=false)
 Set internal attribute value (for Tango::DevLong64 attribute data type).
void set_value (Tango::DevFloat *p_data, long x=1, long y=0, bool release=false)
 Set internal attribute value (for Tango::DevFloat attribute data type).
void set_value (Tango::DevDouble *p_data, long x=1, long y=0, bool release=false)
 Set internal attribute value (for Tango::DevDouble attribute data type).
void set_value (Tango::DevString *p_data, long x=1, long y=0, bool release=false)
 Set internal attribute value (for Tango::DevString attribute data type).
void set_value (Tango::DevBoolean *p_data, long x=1, long y=0, bool release=false)
 Set internal attribute value (for Tango::DevBoolean attribute data type).
void set_value (Tango::DevUShort *p_data, long x=1, long y=0, bool release=false)
 Set internal attribute value (for Tango::DevUShort attribute data type).
void set_value (Tango::DevUChar *p_data, long x=1, long y=0, bool release=false)
 Set internal attribute value (for Tango::DevUChar attribute data type).
void set_value (Tango::DevULong *p_data, long x=1, long y=0, bool release=false)
 Set internal attribute value (for Tango::DevULong attribute data type).
void set_value (Tango::DevULong64 *p_data, long x=1, long y=0, bool release=false)
 Set internal attribute value (for Tango::DevULong64 attribute data type).
void set_value (Tango::DevState *p_data, long x=1, long y=0, bool release=false)
 Set internal attribute value (for Tango::DevState attribute data type).
void set_value (Tango::DevEncoded *p_data, long x=1, long y=0, bool release=false)
 Set internal attribute value (for Tango::DevEncoded attribute data type).
void set_value (Tango::DevString *p_data_str, Tango::DevUChar *p_data, long size, bool release=false)
 Set internal attribute value (for Tango::DevEncoded attribute data type).
void set_value (Tango::EncodedAttribute *attr)
 Set internal attribute value (for Tango::DevEncoded attribute data type).
void set_value_date_quality (Tango::DevShort *p_data, time_t t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevShort attribute data type).
void set_value_date_quality (Tango::DevShort *p_data, struct timeval &t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevShort attribute data type).
void set_value_date_quality (Tango::DevLong *p_data, time_t t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevLong attribute data type).
void set_value_date_quality (Tango::DevLong *p_data, struct timeval &t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevLong attribute data type).
void set_value_date_quality (Tango::DevLong64 *p_data, time_t t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevLong64 attribute data type).
void set_value_date_quality (Tango::DevLong64 *p_data, struct timeval &t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevLong64 attribute data type).
void set_value_date_quality (Tango::DevFloat *p_data, time_t t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevFloat attribute data type).
void set_value_date_quality (Tango::DevFloat *p_data, struct timeval &t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevFloat attribute data type).
void set_value_date_quality (Tango::DevDouble *p_data, time_t t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevDouble attribute data type).
void set_value_date_quality (Tango::DevDouble *p_data, struct timeval &t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevDouble attribute data type).
void set_value_date_quality (Tango::DevString *p_data, time_t t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevString attribute data type).
void set_value_date_quality (Tango::DevString *p_data, struct timeval &t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevString attribute data type).
void set_value_date_quality (Tango::DevBoolean *p_data, time_t t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevBoolean attribute data type).
void set_value_date_quality (Tango::DevBoolean *p_data, struct timeval &t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevBoolean attribute data type).
void set_value_date_quality (Tango::DevUShort *p_data, time_t t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevUShort attribute data type).
void set_value_date_quality (Tango::DevUShort *p_data, struct timeval &t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevUShort attribute data type).
void set_value_date_quality (Tango::DevUChar *p_data, time_t t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevUChar attribute data type).
void set_value_date_quality (Tango::DevUChar *p_data, struct timeval &t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevUChar attribute data type).
void set_value_date_quality (Tango::DevULong *p_data, time_t t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevULong attribute data type).
void set_value_date_quality (Tango::DevULong *p_data, struct timeval &t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevULong attribute data type).
void set_value_date_quality (Tango::DevULong64 *p_data, time_t t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevULong64 attribute data type).
void set_value_date_quality (Tango::DevULong64 *p_data, struct timeval &t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevULong64 attribute data type).
void set_value_date_quality (Tango::DevState *p_data, time_t t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevState attribute data type).
void set_value_date_quality (Tango::DevState *p_data, struct timeval &t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevState attribute data type).
void set_value_date_quality (Tango::DevEncoded *p_data, time_t t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevEncoded attribute data type).
void set_value_date_quality (Tango::DevString *p_data_str, Tango::DevUChar *p_data, long size, time_t t, Tango::AttrQuality qual, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevEncoded attribute data type when splitted in format and data).
void set_value_date_quality (Tango::DevEncoded *p_data, struct timeval &t, Tango::AttrQuality qual, long x=1, long y=0, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevEncoded attribute data type).
void set_value_date_quality (Tango::DevString *p_data_str, Tango::DevUChar *p_data, long size, struct timeval &t, Tango::AttrQuality qual, bool release=false)
 Set internal attribute value, date and quality factor (for Tango::DevEncoded attribute data type when splitted in data format and data themselves).
void fire_change_event (DevFailed *except=NULL)
 Fire a change event for the attribute value.
void set_change_event (bool implemented, bool detect=true)
 Set a flag to indicate that the server fires change events manually, without the polling to be started for the attribute.
bool is_change_event ()
 Check if the change event is fired manually (without polling) for this attribute.
bool is_check_change_criteria ()
 Check if the change event criteria should be checked when firing the event manually.
void fire_archive_event (DevFailed *except=NULL)
 Fire an archive event for the attribute value.
void set_archive_event (bool implemented, bool detect=true)
 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 fullfilled.
bool is_archive_event ()
 Check if the archive event is fired manually for this attribute.
bool is_check_archive_criteria ()
 Check if the archive event criteria should be checked when firing the event manually.
void set_data_ready_event (bool implemented)
 Set a flag to indicate that the server fires data ready events.
bool is_data_ready_event ()
 Check if the data ready event is fired for this attribute.
void fire_event (vector< string > &filt_names, vector< double > &filt_vals, DevFailed *except=NULL)
 Fire a user event for the attribute value.
void remove_configuration ()
 Remove the attribute configuration from the database.

Protected Attributes

Class data members
bool value_flag
 A flag set to true if the attribute value has been updated.
Tango::TimeVal when
 The date when attribute was read.
bool date
 Flag set to true if the date must be set.
Tango::AttrQuality quality
 The attribute quality factor.
string name
 The attribute name.
Tango::AttrWriteType writable
 The attribute writable flag.
long data_type
 The attribute data type.
Tango::AttrDataFormat data_format
 The attribute data format.
long max_x
 The attribute maximum x dimension.
long max_y
 The attribute maximum y dimension.
string label
 The attribute label.
string description
 The attribute description.
string unit
 The attribute unit.
string standard_unit
 The attribute standard unit.
string display_unit
 The attribute display unit.
string format
 The attribute format.
string writable_attr_name
 The name of the associated writable attribute.
string min_alarm_str
 The attribute minimum alarm level.
string max_alarm_str
 The attribute maximun alarm level.
string min_value_str
 The attribute minimum value.
string max_value_str
 The attribute maximum value.
string min_warning_str
 The attribute minimun warning.
string max_warning_str
 The attribute maximum warning.
string delta_val_str
 The attribute delta value RDS alarm.
string delta_t_str
 The attribute delta time RDS alarm.
long assoc_ind
 Index in the main attribute vector of the associated writable attribute (if any).
Tango::Attr_CheckVal min_alarm
 The attribute minimum alarm in binary format.
Tango::Attr_CheckVal max_alarm
 The attribute maximum alarm in binary format.
Tango::Attr_CheckVal min_warning
 The attribute minimum warning in binary format.
Tango::Attr_CheckVal max_warning
 The attribute maximum warning in binary format.
Tango::Attr_CheckVal min_value
 The attribute minimum value in binary format.
Tango::Attr_CheckVal max_value
 The attribute maximum value in binary format.
Tango::Attr_Value value
 The attribute value.
long data_size
 The attribute data size.
bool check_min_value
 Flag set to true if a minimum value is defined.
bool check_max_value
 Flag set to true if a maximum alarm is defined.
Tango::Attr_CheckVal delta_val
 Authorized delta between the last written value and the actual read.
long delta_t
 Delta time after which the read value must be checked again the last written value if the attribute has an alarm on Read Different Than Set (RDS).


Detailed Description

This class represents a Tango attribute.

Author
taurel
Revision
15556

Constructor & Destructor Documentation

Tango::Attribute::Attribute ( vector< AttrProperty > &  prop_list,
Attr tmp_attr,
string &  dev_name,
long  idx 
)

Create a new Attribute object.

Parameters:
prop_list The attribute properties list. Each property is an object of the AttrProperty class
tmp_attr Temporary attribute object built from user parameters
dev_name The device name
idx The index of the related Attr object in the MultiClassAttribute vector of Attr object


Member Function Documentation

bool Tango::Attribute::check_alarm (  ) 

Check if the attribute read value is below/above the alarm level.

Returns:
A boolean set to true if the attribute is in alarm condition.
Exceptions:
DevFailed If no alarm level is defined. Click here to read DevFailed exception specification

void Tango::Attribute::fire_archive_event ( DevFailed *  except = NULL  ) 

Fire an archive event for the attribute value.

The event is pushed to the notification daemon. The attibute data must be set with one of the Attribute::set_value or Attribute::setvalue_date_quality methods before fireing the event. The event is triggered with or without the archive event criteria depending on the configuration choosen with set_archive_event(). ATTENTION: The couple set_value() and fire_archive_event() needs to be protected against concurrent accesses to the same attribute. Such an access might happen during a synchronous read or by a reading from the polling thread. Inside all methods reading or writing commands and attributes this protection is automatically done by the Tango serialisation monitor. When fireing archive events in your own code, you should use the push_archive_event methods of the DeviceImpl class or protect your code with the Tango::AutoTangoMonitor on your device. Example:

{ Tango::AutoTangoMonitor synch(this); att_temp_seq.set_value (temp_seq, 100); att_temp_seq.fire_archive_event (); }

Parameters:
except A pointer to a DevFailed exception to be thrown as archive event.

void Tango::Attribute::fire_change_event ( DevFailed *  except = NULL  ) 

Fire a change event for the attribute value.

The event is pushed to the notification daemon. The attibute data must be set with one of the Attribute::set_value or Attribute::setvalue_date_quality methods before fireing the event. The event is triggered with or without the change event criteria depending on the configuration choosen with set_change_event(). ATTENTION: The couple set_value() and fire_change_event() needs to be protected against concurrent accesses to the same attribute. Such an access might happen during a synchronous read or by a reading from the polling thread. Inside all methods reading or writing commands and attributes this protection is automatically done by the Tango serialisation monitor. When fireing change events in your own code, you should use the push_change_event methods of the DeviceImpl class or protect your code with the Tango::AutoTangoMonitor on your device. Example:

{ Tango::AutoTangoMonitor synch(this); att_temp_seq.set_value (temp_seq, 100); att_temp_seq.fire_archive_event (); }

Parameters:
except A pointer to a DevFailed exception to be thrown as archive event.

void Tango::Attribute::fire_event ( vector< string > &  filt_names,
vector< double > &  filt_vals,
DevFailed *  except = NULL 
)

Fire a user event for the attribute value.

The event is pushed to the notification daemon. The attibute data must be set with one of the Attribute::set_value or Attribute::setvalue_date_quality methods before fireing the event. ATTENTION: The couple set_value() and fire_event() needs to be protected against concurrent accesses to the same attribute. Such an access might happen during a synchronous read or by a reading from the polling thread. Inside all methods reading or writing commands and attributes this protection is automatically done by the Tango serialisation monitor. When fireing archive events in your own code, you should use the push_event methods of the DeviceImpl class or protect your code with the Tango::AutoTangoMonitor on your device. Example:

{ Tango::AutoTangoMonitor synch(this); att_temp_seq.set_value (temp_seq, 100); att_temp_seq.fire_event (); }

Parameters:
filt_names The filterable fields name
filt_vals The filterable fields value (as double)
except A pointer to a DevFailed exception to be thrown as archive event.

long Tango::Attribute::get_assoc_ind (  )  [inline]

Get index of the associated writable attribute.

Returns:
The index in the main attribute vector of the associated writable attribute

string& Tango::Attribute::get_assoc_name (  )  [inline]

Get name of the associated writable attribute.

Returns:
The associated writable attribute name

AttrSerialModel Tango::Attribute::get_attr_serial_model (  )  [inline]

Get attribute serialization model.

Get the attribute serialization model

Returns:
The attribute serialization model

Tango::AttrDataFormat Tango::Attribute::get_data_format (  )  [inline]

Get attribute data format.

Returns:
The attribute data format

long Tango::Attribute::get_data_size (  )  [inline]

Get attribute data size.

Returns:
The attribute data size

long Tango::Attribute::get_data_type (  )  [inline]

Get attribute data type.

Returns:
The attribute data type

Tango::TimeVal& Tango::Attribute::get_date (  )  [inline]

Get attribute date.

Returns:
The attribute date

string& Tango::Attribute::get_label (  )  [inline]

Get attribute label property.

Returns:
The attribute label

long Tango::Attribute::get_max_dim_x (  )  [inline]

Get attribute maximum data size in x dimension.

Returns:
The attribute maximum data size in x dimension. Set to 1 for scalar attribute

long Tango::Attribute::get_max_dim_y (  )  [inline]

Get attribute maximum data size in y dimension.

Returns:
The attribute maximum data size in y dimension. Set to 0 for scalar and spectrum attribute

string& Tango::Attribute::get_name (  )  [inline]

Get attribute name.

Returns:
The attribute name

long Tango::Attribute::get_polling_period (  )  [inline]

Get attribute polling period.

Returns:
The attribute polling period in mS. Set to 0 when the attribute is not polled

void Tango::Attribute::get_properties ( Tango::AttributeConfig &  conf  ) 

Get attribute properties.

This method initialise the fields of a AttributeConfig object with the attribute properties value

Parameters:
conf A AttributeConfig object.

void Tango::Attribute::get_properties_2 ( Tango::AttributeConfig_2 &  conf  ) 

Get attribute properties version 2.

This method initialise the fields of a AttributeConfig_2 object with the attribute properties value

Parameters:
conf A AttributeConfig_2 object.

void Tango::Attribute::get_properties_3 ( Tango::AttributeConfig_3 &  conf  ) 

Get attribute properties version 3.

This method initialise the fields of a AttributeConfig_3 object with the attribute properties value

Parameters:
conf A AttributeConfig_3 object.

Tango::AttrQuality& Tango::Attribute::get_quality (  )  [inline]

Get attribute data quality.

Returns:
The attribute data quality

Tango::AttrWriteType Tango::Attribute::get_writable (  )  [inline]

Get the attribute writable type (RO/WO/RW).

Returns:
The attribute write type.

long Tango::Attribute::get_x (  )  [inline]

Get attribute data size in x dimension.

Returns:
The attribute data size in x dimension. Set to 1 for scalar attribute

long Tango::Attribute::get_y (  )  [inline]

Get attribute data size in y dimension.

Returns:
The attribute data size in y dimension. Set to 0 for scalar and spectrum attribute

bitset<numFlags>& Tango::Attribute::is_alarmed (  )  [inline]

Check if the attribute has an alarm defined.

This method returns a set of bits. Each alarm type is defined by one bit.

Returns:
A bitset. Each bit is set if the coresponding alarm is on

bool Tango::Attribute::is_archive_event (  )  [inline]

Check if the archive event is fired manually for this attribute.

Returns:
A boolean set to true if a manual fire archive event is implemented.

bool Tango::Attribute::is_change_event (  )  [inline]

Check if the change event is fired manually (without polling) for this attribute.

Returns:
A boolean set to true if a manual fire change event is implemented.

bool Tango::Attribute::is_check_archive_criteria (  )  [inline]

Check if the archive event criteria should be checked when firing the event manually.

Returns:
A boolean set to true if a archive event criteria will be checked.

bool Tango::Attribute::is_check_change_criteria (  )  [inline]

Check if the change event criteria should be checked when firing the event manually.

Returns:
A boolean set to true if a change event criteria will be checked.

bool Tango::Attribute::is_data_ready_event (  )  [inline]

Check if the data ready event is fired for this attribute.

Returns:
A boolean set to true if a fire data ready event is implemented.

bool Tango::Attribute::is_max_alarm (  )  [inline]

Check if the attribute is in maximum alarm condition .

Returns:
A boolean set to true if the attribute is in alarm condition (read value above the max. alarm).

bool Tango::Attribute::is_max_warning (  )  [inline]

Check if the attribute is in maximum warning condition .

Returns:
A boolean set to true if the attribute is in warning condition (read value above the max. warning).

bool Tango::Attribute::is_min_alarm (  )  [inline]

Check if the attribute is in minimum alarm condition .

Returns:
A boolean set to true if the attribute is in alarm condition (read value below the min. alarm).

bool Tango::Attribute::is_min_warning (  )  [inline]

Check if the attribute is in minimum warning condition .

Returns:
A boolean set to true if the attribute is in warning condition (read value below the min. warning).

bool Tango::Attribute::is_polled (  ) 

Check if the attribute is polled .

Returns:
A boolean set to true if the attribute is polled.

bool Tango::Attribute::is_rds_alarm (  )  [inline]

Check if the attribute is in RDS alarm condition .

Returns:
A boolean set to true if the attribute is in RDS condition (Read Different than Set).

bool Tango::Attribute::is_writ_associated (  ) 

Check if the attribute has an associated writable attribute.

This method returns a boolean set to true if the attribute has a writable attribute associated to it.

Returns:
A boolean set to true if there is an associated writable attribute

void Tango::Attribute::remove_configuration (  ) 

Remove the attribute configuration from the database.

This method can be used to clean-up all the configuration of an attribute to come back to its default values or the remove all configuration of a dynamic attribute before deleting it.

The method removes all configured attribute properties and removes the attribute from the list of polled attributes.

Exceptions:
DevFailed In case of database access problems. Click here to read DevFailed exception specification

void Tango::Attribute::set_archive_event ( bool  implemented,
bool  detect = true 
) [inline]

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 fullfilled.

If detect is set to false the event is fired without any value checking!

Parameters:
implemented True when the server fires archive events manually.
detect Triggers the verification of the archive event properties when set to true.

void Tango::Attribute::set_assoc_ind ( long  val  )  [inline]

Set index of the associated writable attribute.

Parameters:
val The new index in the main attribute vector of the associated writable attribute

void Tango::Attribute::set_attr_serial_model ( AttrSerialModel  ser_model  ) 

Set attribute serialization model.

This method allows the user to choose the attribute serialization model.

Parameters:
ser_model The new serialisation model. The serialization model must be one of ATTR_BY_KERNEL, ATTR_BY_USER or ATTR_NO_SYNC

void Tango::Attribute::set_change_event ( bool  implemented,
bool  detect = true 
) [inline]

Set a flag to indicate that the server fires change events manually, without the polling to be started for the attribute.

If the detect parameter is set to true, the criteria specified for the change event are verified and the event is only pushed if they are fullfilled. If detect is set to false the event is fired without any value checking!

Parameters:
implemented True when the server fires change events manually.
detect Triggers the verification of the change event properties when set to true.

void Tango::Attribute::set_data_ready_event ( bool  implemented  )  [inline]

Set a flag to indicate that the server fires data ready events.

Parameters:
implemented True when the server fires change events manually.

void Tango::Attribute::set_date ( time_t  new_date  )  [inline]

Set attribute date.

Parameters:
new_date The attribute date

void Tango::Attribute::set_date ( struct timeval &  t  )  [inline]

Set attribute date.

Parameters:
t The attribute date

void Tango::Attribute::set_date ( Tango::TimeVal &  new_date  )  [inline]

Set attribute date.

Parameters:
new_date The attribute date

void Tango::Attribute::set_properties ( const Tango::AttributeConfig_3 &  conf,
Tango::DeviceImpl dev 
)

Set attribute properties version 3.

This method set the attribute properties value with the content of the fileds in the AttributeConfig_3 object

Parameters:
conf A AttributeConfig_3 object.
dev The device pointer.

void Tango::Attribute::set_properties ( const Tango::AttributeConfig &  conf,
Tango::DeviceImpl dev 
)

Set attribute properties.

This method set the attribute properties value with the content of the fileds in the AttributeConfig object

Parameters:
conf A AttributeConfig object.
dev The device pointer.

void Tango::Attribute::set_quality ( Tango::AttrQuality  qua,
bool  send_event = false 
)

Set attribute data quality.

Parameters:
qua The new attribute data quality
send_event Boolean set to true if a change event should be sent

void Tango::Attribute::set_user_attr_mutex ( omni_mutex *  mut_ptr  )  [inline]

Set attribute user mutex.

This method allows the user to give to the attribute object the pointer to the omni_mutex used to protect its buffer. The mutex has to be locked when passed to this method. The Tango kernel will unlock it when the data will be transferred to the client.

Parameters:
mut_ptr The user mutex pointer

void Tango::Attribute::set_value ( Tango::EncodedAttribute attr  ) 

Set internal attribute value (for Tango::DevEncoded attribute data type).

This method stores the attribute read value inside the object. This data will be returned to the caller. This method also stores the date when it is called and initialise the attribute quality factor.

Parameters:
attr Handle to EncodedAttribute object
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value ( Tango::DevString *  p_data_str,
Tango::DevUChar *  p_data,
long  size,
bool  release = false 
)

Set internal attribute value (for Tango::DevEncoded attribute data type).

This method stores the attribute read value inside the object. This data will be returned to the caller. This method also stores the date when it is called and initialise the attribute quality factor.

Parameters:
p_data_str The attribute string part read value
p_data The attribute raw data part read value
size Size of the attribute raw data part
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value ( Tango::DevEncoded *  p_data,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value (for Tango::DevEncoded attribute data type).

This method stores the attribute read value inside the object. This data will be returned to the caller. This method also stores the date when it is called and initialise the attribute quality factor.

Parameters:
p_data The attribute read value
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value ( Tango::DevState *  p_data,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value (for Tango::DevState attribute data type).

This method stores the attribute read value inside the object. This data will be returned to the caller. This method also stores the date when it is called and initialise the attribute quality factor.

Parameters:
p_data The attribute read value
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value ( Tango::DevULong64 *  p_data,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value (for Tango::DevULong64 attribute data type).

This method stores the attribute read value inside the object. This data will be returned to the caller. This method also stores the date when it is called and initialise the attribute quality factor.

Parameters:
p_data The attribute read value
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value ( Tango::DevULong *  p_data,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value (for Tango::DevULong attribute data type).

This method stores the attribute read value inside the object. This data will be returned to the caller. This method also stores the date when it is called and initialise the attribute quality factor.

Parameters:
p_data The attribute read value
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value ( Tango::DevUChar *  p_data,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value (for Tango::DevUChar attribute data type).

This method stores the attribute read value inside the object. This data will be returned to the caller. This method also stores the date when it is called and initialise the attribute quality factor.

Parameters:
p_data The attribute read value
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value ( Tango::DevUShort *  p_data,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value (for Tango::DevUShort attribute data type).

This method stores the attribute read value inside the object. This data will be returned to the caller. This method also stores the date when it is called and initialise the attribute quality factor.

Parameters:
p_data The attribute read value
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value ( Tango::DevBoolean *  p_data,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value (for Tango::DevBoolean attribute data type).

This method stores the attribute read value inside the object. This data will be returned to the caller. This method also stores the date when it is called and initialise the attribute quality factor.

Parameters:
p_data The attribute read value
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value ( Tango::DevString *  p_data,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value (for Tango::DevString attribute data type).

This method stores the attribute read value inside the object. This data will be returned to the caller. This method also stores the date when it is called and initialise the attribute quality factor.

Parameters:
p_data The attribute read value
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value ( Tango::DevDouble *  p_data,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value (for Tango::DevDouble attribute data type).

This method stores the attribute read value inside the object. This data will be returned to the caller. This method also stores the date when it is called and initialise the attribute quality factor.

Parameters:
p_data The attribute read value
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value ( Tango::DevFloat *  p_data,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value (for Tango::DevFloat attribute data type).

This method stores the attribute read value inside the object. This data will be returned to the caller. This method also stores the date when it is called and initialise the attribute quality factor.

Parameters:
p_data The attribute read value
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value ( Tango::DevLong64 *  p_data,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value (for Tango::DevLong64 attribute data type).

This method stores the attribute read value inside the object. This data will be returned to the caller. This method also stores the date when it is called and initialise the attribute quality factor.

Parameters:
p_data The attribute read value
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value ( Tango::DevLong *  p_data,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value (for Tango::DevLong attribute data type).

This method stores the attribute read value inside the object. This data will be returned to the caller. This method also stores the date when it is called and initialise the attribute quality factor.

Parameters:
p_data The attribute read value
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value ( Tango::DevShort *  p_data,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value (for Tango::DevShort attribute data type).

This method stores the attribute read value inside the object. This data will be returned to the caller. This method also stores the date when it is called and initialise the attribute quality factor.

Parameters:
p_data The attribute read value
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevString *  p_data_str,
Tango::DevUChar *  p_data,
long  size,
struct timeval &  t,
Tango::AttrQuality  qual,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevEncoded attribute data type when splitted in data format and data themselves).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Please note that for Win32 user, the same method is defined using a "_timeb" structure instead of a "timeval" structure to set date.

Parameters:
p_data_str The attribute format string
p_data The attribute raw data
size Size of the attribute raw data part
t The date
qual The attribute quality factor
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevEncoded *  p_data,
struct timeval &  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevEncoded attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Please note that for Win32 user, the same method is defined using a "_timeb" structure instead of a "timeval" structure to set date.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevString *  p_data_str,
Tango::DevUChar *  p_data,
long  size,
time_t  t,
Tango::AttrQuality  qual,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevEncoded attribute data type when splitted in format and data).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Parameters:
p_data_str The attribute coded format string
p_data The attribute raw data
size Size of the attribute raw data part
t The date
qual The attribute quality factor
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevEncoded *  p_data,
time_t  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevEncoded attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevState *  p_data,
struct timeval &  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevState attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Please note that for Win32 user, the same method is defined using a "_timeb" structure instead of a "timeval" structure to set date.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevState *  p_data,
time_t  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevState attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevULong64 *  p_data,
struct timeval &  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevULong64 attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Please note that for Win32 user, the same method is defined using a "_timeb" structure instead of a "timeval" structure to set date.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevULong64 *  p_data,
time_t  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevULong64 attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevULong *  p_data,
struct timeval &  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevULong attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Please note that for Win32 user, the same method is defined using a "_timeb" structure instead of a "timeval" structure to set date.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevULong *  p_data,
time_t  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevULong attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevUChar *  p_data,
struct timeval &  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevUChar attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Please note that for Win32 user, the same method is defined using a "_timeb" structure instead of a "timeval" structure to set date.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevUChar *  p_data,
time_t  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevUChar attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevUShort *  p_data,
struct timeval &  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevUShort attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Please note that for Win32 user, the same method is defined using a "_timeb" structure instead of a "timeval" structure to set date.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevUShort *  p_data,
time_t  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevUShort attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevBoolean *  p_data,
struct timeval &  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevBoolean attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Please note that for Win32 user, the same method is defined using a "_timeb" structure instead of a "timeval" structure to set date.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevBoolean *  p_data,
time_t  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevBoolean attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevString *  p_data,
struct timeval &  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevString attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Please note that for Win32 user, the same method is defined using a "_timeb" structure instead of a "timeval" structure to set date.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevString *  p_data,
time_t  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevString attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevDouble *  p_data,
struct timeval &  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevDouble attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Please note that for Win32 user, the same method is defined using a "_timeb" structure instead of a "timeval" structure to set date.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevDouble *  p_data,
time_t  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevDouble attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevFloat *  p_data,
struct timeval &  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevFloat attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Please note that for Win32 user, the same method is defined using a "_timeb" structure instead of a "timeval" structure to set date.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevFloat *  p_data,
time_t  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevFloat attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevLong64 *  p_data,
struct timeval &  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevLong64 attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Please note that for Win32 user, the same method is defined using a "_timeb" structure instead of a "timeval" structure to set date.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevLong64 *  p_data,
time_t  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevLong64 attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevLong *  p_data,
struct timeval &  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevLong attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Please note that for Win32 user, the same method is defined using a "_timeb" structure instead of a "timeval" structure to set date.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevLong *  p_data,
time_t  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevLong attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevShort *  p_data,
struct timeval &  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevShort attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Please note that for Win32 user, the same method is defined using a "_timeb" structure instead of a "timeval" structure to set date.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification

void Tango::Attribute::set_value_date_quality ( Tango::DevShort *  p_data,
time_t  t,
Tango::AttrQuality  qual,
long  x = 1,
long  y = 0,
bool  release = false 
)

Set internal attribute value, date and quality factor (for Tango::DevShort attribute data type).

This method stores the attribute read value, the date and the attribute quality factor inside the object. This data will be returned to the caller.

Parameters:
p_data The attribute read value
t The date
qual The attribute quality factor
x The attribute x length. Default value is 1
y The attribute y length. Default value is 0
release The release flag. If true, memory pointed to by p_data will be freed after being send to the client. Default value is false.
Exceptions:
DevFailed If the attribute data type is not coherent. Click here to read DevFailed exception specification


Member Data Documentation

Tango::AttrDataFormat Tango::Attribute::data_format [protected]

The attribute data format.

Three data formats are supported. They are SCALAR, SPECTRUM and IMAGE

long Tango::Attribute::data_type [protected]

The attribute data type.

Eight types are suported. They are Tango::DevShort, Tango::DevLong, Tango::DevDouble, Tango::DevString, Tango::DevUShort, Tango::DevUChar, Tango::DevFloat and Tango::DevBoolean

Tango::Attr_CheckVal Tango::Attribute::delta_val [protected]

Authorized delta between the last written value and the actual read.

Used if the attribute has an alarm on Read Different Than Set (RDS)

string Tango::Attribute::format [protected]

The attribute format.

This string specifies how an attribute value must be printed

long Tango::Attribute::max_x [protected]

The attribute maximum x dimension.

It is needed for SPECTRUM or IMAGE data format

long Tango::Attribute::max_y [protected]

The attribute maximum y dimension.

It is necessary only for IMAGE data format


The documentation for this class was generated from the following file:
Tango Device Server User's Guide



ALBA - Control Team / DESY - Hasylab Petra III

ELETTRA - Controls and Diagnostics / ESRF - Software Engineering Group

SOLEIL - Controle Commande et Acquisition / MAX-lab - MAX 4

FRM2 - Control group