Tango::Attr Class Reference

User class to create a no dimension attribute object. More...

#include <attrdesc.h>

Inheritance diagram for Tango::Attr:

List of all members.

Public Member Functions
Constructors
Two constructor are defined for this class
	Attr (const char *name, long data_type, Tango::AttrWriteType w_type=Tango::READ, const char *assoc=AssocWritNotSpec)
	Constructs a newly allocated Attr object.
	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.
Destructor
Only one desctructor is defined for this class
virtual	~Attr ()
	The object desctructor.
Miscellaneous methods
void	set_default_properties (UserDefaultAttrProp &prop)
	Set default attribute properties.
void	set_disp_level (Tango::DispLevel level)
	Set the attribute display level.
void	set_polling_period (long update)
	Set the attribute polling update period.
void	set_memorized ()
	Set the attribute as memorized in database (only for scalar and writable attribute) With no argument the setpoint will be written to the attribute during initialisation!
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.
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.
bool	is_change_event ()
	Check if the change event is fired manually for this attribute.
bool	is_check_change_criteria ()
	Check if the change event criteria should be checked when firing the event manually.
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 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.

---

Detailed Description

User class to create a no dimension attribute object.

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

Author

taurel

Revision

15556

---

Constructor & Destructor Documentation

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.

The attribute display level is set to OPERATOR.

Parameters:

	name	The attribute name
	data_type	The attribute data type
	w_type	The attribute type (read, write, read with write ...)
	assoc	Name of the associated writable attribute. This is used only the read with write attribute

Tango::Attr::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.

Parameters:

	name	The attribute name
	data_type	The attribute data type
	disp	The attribute display level
	w_type	The attribute type (read, write, read with write ...)
	assoc	Name of the associated writable attribute. This is used only the read with write attribute

---

Member Function Documentation

bool Tango::Attr::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::Attr::is_change_event

(

)

[inline]

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

Returns:

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

bool Tango::Attr::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::Attr::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::Attr::is_data_ready_event

(

)

[inline]

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

Returns:

A boolean set to true if firing data ready event is implemented.

void Tango::Attr::set_archive_event	(	bool	implemented,
		bool	detect
	)			[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 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::Attr::set_change_event	(	bool	implemented,
		bool	detect
	)			[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 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::Attr::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 data ready events

void Tango::Attr::set_default_properties

(

UserDefaultAttrProp &

prop

)

Set default attribute properties.

Parameters:

prop

The user default property class

void Tango::Attr::set_disp_level

(

Tango::DispLevel

level

)

[inline]

Set the attribute display level.

Parameters:

level

The attribute display level

void Tango::Attr::set_memorized_init

(

bool

write_on_init

)

[inline]

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.

No action is taken on the attribute

Parameters:

write_on_init

If true the setpoint value will be written to the attribute on initialisation

void Tango::Attr::set_polling_period

(

long

update

)

[inline]

Set the attribute polling update period.

Parameters:

update

The attribute polling period (in mS)

---

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

• attrdesc.h