Tango Core Classes Reference  9.3.4
Tango::DbClass Class Reference

A database object for a class which can be used to query or modify class properties. More...

#include "tango.h"

Public Member Functions

Constructors
 DbClass (string class_name)
 Create a DbClass instance. More...
 
 DbClass (string class_name, Database *db)
 Create a DbClass instance using a specified database. More...
 

Property oriented methods

void get_property (DbData &db)
 Get class property from database. More...
 
void put_property (DbData &db)
 Update class property in database. More...
 
void delete_property (DbData &db)
 Remove class property from database. More...
 
void get_attribute_property (DbData &db)
 Get class attribute property from database. More...
 
void put_attribute_property (DbData &db)
 Update class attribute property in database. More...
 
void delete_attribute_property (DbData &db)
 Remove class attribute property from database. More...
 
void get_pipe_property (DbData &db)
 Get class pipe property from database. More...
 
void put_pipe_property (DbData &db)
 Update class pipe property in database. More...
 
void delete_pipe_property (DbData &db)
 Remove class pipe property from database. More...
 

Detailed Description

A database object for a class which can be used to query or modify class properties.

Constructor & Destructor Documentation

◆ DbClass() [1/2]

Tango::DbClass::DbClass ( string  class_name)

Create a DbClass instance.

A constructor for a DbClass object for a class in the TANGO database specified by the TANGO_HOST environment variable

Parameters
[in]class_nameThe Tango class name

◆ DbClass() [2/2]

Tango::DbClass::DbClass ( string  class_name,
Database db 
)

Create a DbClass instance using a specified database.

A constructor for a DbClass object for the Tango class in the specified database. This method reuses the Database supplied by the programmer.

Parameters
[in]class_nameThe Tango class name
[in]dbThe database object

Member Function Documentation

◆ delete_attribute_property()

void Tango::DbClass::delete_attribute_property ( DbData &  db)

Remove class attribute property from database.

Delete all properties for the list of specified attributes for this class in the database. See Database::delete_class_attribute_property() for an example of how to specify the properties.

Parameters
[in]dbProperty name(s)
Exceptions
ConnectionFailed,CommunnicationFailed,DevFailedfrom device

◆ delete_pipe_property()

void Tango::DbClass::delete_pipe_property ( DbData &  db)

Remove class pipe property from database.

Delete all properties for the list of specified pipes for this class in the database. See Database::delete_class_pipe_property() for an example of how to specify the properties.

Parameters
[in]dbProperty name(s)
Exceptions
ConnectionFailed,CommunnicationFailed,DevFailedfrom device

◆ delete_property()

void Tango::DbClass::delete_property ( DbData &  db)

Remove class property from database.

Delete the list of specified properties for this class in the database. See Database::delete_property() for an example of how to specify the properties.

Parameters
[in]dbProperty name(s)
Exceptions
ConnectionFailed,CommunnicationFailed,DevFailedfrom device

◆ get_attribute_property()

void Tango::DbClass::get_attribute_property ( DbData &  db)

Get class attribute property from database.

Query the database for the list of attribute properties of this class. See Database::get_class_attribute_property() for an example of how to specify and retrieve the properties.

Parameters
[in,out]dbProperty name(s) and value
Exceptions
ConnectionFailed,CommunnicationFailed,DevFailedfrom device

◆ get_pipe_property()

void Tango::DbClass::get_pipe_property ( DbData &  db)

Get class pipe property from database.

Query the database for the list of pipe properties of this class. See Database::get_class_pipe_property() for an example of how to specify and retrieve the properties.

Parameters
[in,out]dbProperty name(s) and value
Exceptions
ConnectionFailed,CommunnicationFailed,DevFailedfrom device

◆ get_property()

void Tango::DbClass::get_property ( DbData &  db)

Get class property from database.

Query the database for the list of properties of this class. See Database::get_class_property() for an example of how to specify and retrieve the properties.

Parameters
[in,out]dbProperty name(s) and value
Exceptions
ConnectionFailed,CommunnicationFailed,DevFailedfrom device

◆ put_attribute_property()

void Tango::DbClass::put_attribute_property ( DbData &  db)

Update class attribute property in database.

Update the list of attribute properties for this class in the database. See Database::put_class_attribute_property() for an example of how to specify the properties.

Parameters
[in]dbProperty name(s) and value
Exceptions
ConnectionFailed,CommunnicationFailed,DevFailedfrom device

◆ put_pipe_property()

void Tango::DbClass::put_pipe_property ( DbData &  db)

Update class pipe property in database.

Update the list of pipe properties for this class in the database. See Database::put_class_pipe_property() for an example of how to specify the properties.

Parameters
[in]dbProperty name(s) and value
Exceptions
ConnectionFailed,CommunnicationFailed,DevFailedfrom device

◆ put_property()

void Tango::DbClass::put_property ( DbData &  db)

Update class property in database.

Update the list of properties for this class in the database. See Database::put_class_property() for an example of how to specify the properties.

Parameters
[in]dbProperty name(s) and value
Exceptions
ConnectionFailed,CommunnicationFailed,DevFailedfrom device

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