-
Claudio Scafuri authored81d91d9f
VgClass.cpp 20.44 KiB
/*----- PROTECTED REGION ID(VgClass.cpp) ENABLED START -----*/
static const char *RcsId = "$Id: VgClass.cpp,v 1.6 2013-06-17 10:30:33 lorenzo Exp $";
static const char *TagName = "$Name: $";
static const char *CvsPath = "$Source: /home/cvsadm/cvsroot/fermi/servers/vg/src/VgClass.cpp,v $";
static const char *SvnPath = "$HeadURL: $";
static const char *HttpServer = "http://www.esrf.eu/computing/cs/tango/tango_doc/ds_doc/";
//=============================================================================
//
// file : VgClass.cpp
//
// description : C++ source for the VgClass. A singleton
// class derived from DeviceClass. It implements the
// command list and all properties and methods required
// by the name once per process.
//
// project : Vg.
//
// $Author: lorenzo $
//
// $Revision: 1.6 $
// $Date: 2013-06-17 10:30:33 $
//
// SVN only:
// $HeadURL: $
//
// CVS only:
// $Source: /home/cvsadm/cvsroot/fermi/servers/vg/src/VgClass.cpp,v $
// $Log: VgClass.cpp,v $
// Revision 1.6 2013-06-17 10:30:33 lorenzo
// Added DeviceState attribute
//
// Revision 1.5 2013-06-05 15:41:02 lorenzo
// Tango 8.0.5
//
// Revision 1.4 2012-07-18 09:59:24 mdm
// New version, before test
//
//
//=============================================================================
// This file is generated by POGO
// (Program Obviously used to Generate tango Object)
//=============================================================================
#include <VgClass.h>
/*----- PROTECTED REGION END -----*/
//-------------------------------------------------------------------
/**
* Create VgClass singleton and
* return it in a C function for Python usage
*/
//-------------------------------------------------------------------
extern "C" {
#ifdef _TG_WINDOWS_
__declspec(dllexport)
#endif
Tango::DeviceClass *_create_Vg_class(const char *name) {
return Vg_ns::VgClass::init(name);
}
}
namespace Vg_ns
{
//===================================================================
// Initialize pointer for singleton pattern
//===================================================================
VgClass *VgClass::_instance = NULL;
//--------------------------------------------------------
/**
* method : VgClass::VgClass(string &s)
* description : constructor for the VgClass
*
* @param s The class name
*/
//--------------------------------------------------------
VgClass::VgClass(string &s):DeviceClass(s)
{
cout2 << "Entering VgClass constructor" << endl;
set_default_property();
get_class_property();
write_class_property();
/*----- PROTECTED REGION ID(Vg::Class::constructor) ENABLED START -----*/
/*----- PROTECTED REGION END -----*/ // Vg::Class::constructor
cout2 << "Leaving VgClass constructor" << endl;
}
//--------------------------------------------------------
/**
* method : VgClass::~VgClass()
* description : destructor for the VgClass
*/
//--------------------------------------------------------
VgClass::~VgClass()
{
/*----- PROTECTED REGION ID(Vg::Class::destructor) ENABLED START -----*/
/*----- PROTECTED REGION END -----*/ // Vg::Class::destructor
_instance = NULL;
}
//--------------------------------------------------------
/**
* method : VgClass::init
* description : Create the object if not already done.
* Otherwise, just return a pointer to the object
*
* @param name The class name
*/
//--------------------------------------------------------
VgClass *VgClass::init(const char *name)
{
if (_instance == NULL)
{
try
{
string s(name);
_instance = new VgClass(s);
}
catch (bad_alloc)
{
throw;
}
}
return _instance;
}
//--------------------------------------------------------
/**
* method : VgClass::instance
* description : Check if object already created,
* and return a pointer to the object
*/
//--------------------------------------------------------
VgClass *VgClass::instance()
{
if (_instance == NULL)
{
cerr << "Class is not initialised !!" << endl;
exit(-1);
}
return _instance;
}
//===================================================================
// Command execution method calls
//===================================================================
//--------------------------------------------------------
/**
* method : OnClass::execute()
* description : method to trigger the execution of the command.
*
* @param device The device on which the command must be executed
* @param in_any The command input data
*
* returns The command output data (packed in the Any object)
*/
//--------------------------------------------------------
CORBA::Any *OnClass::execute(Tango::DeviceImpl *device, const CORBA::Any &in_any)
{
cout2 << "OnClass::execute(): arrived" << endl;
((static_cast<Vg *>(device))->on());
return new CORBA::Any();
}
//--------------------------------------------------------
/**
* method : OffClass::execute()
* description : method to trigger the execution of the command.
*
* @param device The device on which the command must be executed
* @param in_any The command input data
*
* returns The command output data (packed in the Any object)
*/
//--------------------------------------------------------
CORBA::Any *OffClass::execute(Tango::DeviceImpl *device, const CORBA::Any &in_any)
{
cout2 << "OffClass::execute(): arrived" << endl;
((static_cast<Vg *>(device))->off());
return new CORBA::Any();
}
//===================================================================
// Properties management
//===================================================================
//--------------------------------------------------------
/**
* method : VgClass::get_class_property
* description : Get the class property for specified name.
*
* @param name The property name
*/
//--------------------------------------------------------
Tango::DbDatum VgClass::get_class_property(string &prop_name)
{
for (unsigned int i=0 ; i<cl_prop.size() ; i++)
if (cl_prop[i].name == prop_name)
return cl_prop[i];
// if not found, returns an empty DbDatum
return Tango::DbDatum(prop_name);
}
//--------------------------------------------------------
/**
* Method : Vg::VgClass::get_default_device_property()()
* Description : Return the default value for device property.
*/
//--------------------------------------------------------
Tango::DbDatum VgClass::get_default_device_property(string &prop_name)
{
for (unsigned int i=0 ; i<dev_def_prop.size() ; i++)
if (dev_def_prop[i].name == prop_name)
return dev_def_prop[i];
// if not found, return an empty DbDatum
return Tango::DbDatum(prop_name);
}
//--------------------------------------------------------
/**
* Method : Vg::VgClass::get_default_class_property()()
* Description : Return the default value for class property.
*/
//--------------------------------------------------------
Tango::DbDatum VgClass::get_default_class_property(string &prop_name)
{
for (unsigned int i=0 ; i<cl_def_prop.size() ; i++)
if (cl_def_prop[i].name == prop_name)
return cl_def_prop[i];
// if not found, return an empty DbDatum
return Tango::DbDatum(prop_name);
}
//--------------------------------------------------------
/**
* Method : Vg::VgClass::get_class_property()
* Description : // Add your own code to initialize
*/
//--------------------------------------------------------
void VgClass::get_class_property()
{
}
//--------------------------------------------------------
/**
* Method : Vg::VgClass::set_default_property()
* Description : Set default property (class and device) for wizard.
* For each property, add to wizard property name and description.
* If default value has been set, add it to wizard property and.
* store it in a DbDatum.
*/
//--------------------------------------------------------void VgClass::set_default_property()
{
string prop_name;
string prop_desc;
string prop_def;
vector<string> vect_data;
// Set Default Class Properties
// Set Default Device Properties
prop_name = "TpgDevice";
prop_desc = "";
prop_def = "undefined\n";
vect_data.clear();
vect_data.push_back("undefined");
if (prop_def.length()>0)
{
Tango::DbDatum data(prop_name);
data << vect_data ;
dev_def_prop.push_back(data);
add_wiz_dev_prop(prop_name, prop_desc, prop_def);
}
else
add_wiz_dev_prop(prop_name, prop_desc);
prop_name = "Channel";
prop_desc = "";
prop_def = "-1\n";
vect_data.clear();
vect_data.push_back("-1");
if (prop_def.length()>0)
{
Tango::DbDatum data(prop_name);
data << vect_data ;
dev_def_prop.push_back(data);
add_wiz_dev_prop(prop_name, prop_desc, prop_def);
}
else
add_wiz_dev_prop(prop_name, prop_desc);
prop_name = "Timeout";
prop_desc = "";
prop_def = "3000\n";
vect_data.clear();
vect_data.push_back("3000");
if (prop_def.length()>0)
{
Tango::DbDatum data(prop_name);
data << vect_data ;
dev_def_prop.push_back(data);
add_wiz_dev_prop(prop_name, prop_desc, prop_def);
}
else
add_wiz_dev_prop(prop_name, prop_desc);
prop_name = "MaxBackOff";
prop_desc = "";
prop_def = "60\n";
vect_data.clear();
vect_data.push_back("60");
if (prop_def.length()>0)
{
Tango::DbDatum data(prop_name);
data << vect_data ;
dev_def_prop.push_back(data);
add_wiz_dev_prop(prop_name, prop_desc, prop_def);
}
else
add_wiz_dev_prop(prop_name, prop_desc);}
//--------------------------------------------------------
/**
* Method : Vg::VgClass::write_class_property()
* Description : Set class description fields as property in database
*/
//--------------------------------------------------------
void VgClass::write_class_property()
{
// First time, check if database used
if (Tango::Util::_UseDb == false)
return;
Tango::DbData data;
string classname = get_name();
string header;
string::size_type start, end;
// Put title
Tango::DbDatum title("ProjectTitle");
string str_title("Vg");
title << str_title;
data.push_back(title);
// Put Description
Tango::DbDatum description("Description");
vector<string> str_desc;
str_desc.push_back("");
description << str_desc;
data.push_back(description);
// put cvs or svn location
string filename("Vg");
filename += "Class.cpp";
// check for cvs information
string src_path(CvsPath);
start = src_path.find("/");
if (start!=string::npos)
{
end = src_path.find(filename);
if (end>start)
{
string strloc = src_path.substr(start, end-start);
// Check if specific repository
start = strloc.find("/cvsroot/");
if (start!=string::npos && start>0)
{
string repository = strloc.substr(0, start);
if (repository.find("/segfs/")!=string::npos)
strloc = "ESRF:" + strloc.substr(start, strloc.length()-start);
}
Tango::DbDatum cvs_loc("cvs_location");
cvs_loc << strloc;
data.push_back(cvs_loc);
}
}
// check for svn information
else
{
string src_path(SvnPath);
start = src_path.find("://");
if (start!=string::npos)
{
end = src_path.find(filename);
if (end>start)
{
header = "$HeadURL: "; start = header.length();
string strloc = src_path.substr(start, (end-start));
Tango::DbDatum svn_loc("svn_location");
svn_loc << strloc;
data.push_back(svn_loc);
}
}
}
// Get CVS or SVN revision tag
// CVS tag
string tagname(TagName);
header = "$Name: ";
start = header.length();
string endstr(" $");
end = tagname.find(endstr);
if (end!=string::npos && end>start)
{
string strtag = tagname.substr(start, end-start);
Tango::DbDatum cvs_tag("cvs_tag");
cvs_tag << strtag;
data.push_back(cvs_tag);
}
// SVN tag
string svnpath(SvnPath);
header = "$HeadURL: ";
start = header.length();
end = svnpath.find(endstr);
if (end!=string::npos && end>start)
{
string strloc = svnpath.substr(start, end-start);
string tagstr ("/tags/");
start = strloc.find(tagstr);
if ( start!=string::npos )
{
start = start + tagstr.length();
end = strloc.find(filename);
string strtag = strloc.substr(start, end-start-1);
Tango::DbDatum svn_tag("svn_tag");
svn_tag << strtag;
data.push_back(svn_tag);
}
}
// Get URL location
string httpServ(HttpServer);
if (httpServ.length()>0)
{
Tango::DbDatum db_doc_url("doc_url");
db_doc_url << httpServ;
data.push_back(db_doc_url);
}
// Put inheritance
Tango::DbDatum inher_datum("InheritedFrom");
vector<string> inheritance;
inheritance.push_back("Device_Impl");
inher_datum << inheritance;
data.push_back(inher_datum);
// Call database and and values
get_db_class()->put_property(data);
}
//===================================================================
// Factory methods
//===================================================================
//--------------------------------------------------------
/**
* method : VgClass::device_factory
* description : Create the device object(s)
* and store them in the device list
*
* @param *devlist_ptr The device name list
*/
//--------------------------------------------------------
void VgClass::device_factory(const Tango::DevVarStringArray *devlist_ptr)
{
/*----- PROTECTED REGION ID(Vg::Class::device_factory_before) ENABLED START -----*/
// Add your own code
/*----- PROTECTED REGION END -----*/ // Vg::Class::device_factory_before
// Create devices and add it into the device list
for (unsigned long i=0 ; i<devlist_ptr->length() ; i++)
{
cout4 << "Device name : " << (*devlist_ptr)[i].in() << endl;
device_list.push_back(new Vg(this, (*devlist_ptr)[i]));
}
// Manage dynamic attributes if any
erase_dynamic_attributes(devlist_ptr, get_class_attr()->get_attr_list());
// Export devices to the outside world
for (unsigned long i=1 ; i<=devlist_ptr->length() ; i++)
{
// Add dynamic attributes if any
Vg *dev = static_cast<Vg *>(device_list[device_list.size()-i]);
dev->add_dynamic_attributes();
// Check before if database used.
if ((Tango::Util::_UseDb == true) && (Tango::Util::_FileDb == false))
export_device(dev);
else
export_device(dev, dev->get_name().c_str());
}
/*----- PROTECTED REGION ID(Vg::Class::device_factory_after) ENABLED START -----*/
// Add your own code
/*----- PROTECTED REGION END -----*/ // Vg::Class::device_factory_after
}
//--------------------------------------------------------
/**
* Method : Vg::VgClass::attribute_factory()
* Description : Create the attribute object(s)
* and store them in the attribute list
*/
//--------------------------------------------------------
void VgClass::attribute_factory(vector<Tango::Attr *> &att_list)
{ /*----- PROTECTED REGION ID(Vg::Class::attribute_factory_before) ENABLED START -----*/
// Add your own code
/*----- PROTECTED REGION END -----*/ // Vg::Class::attribute_factory_before
// Attribute : Pressure
PressureAttrib *pressure = new PressureAttrib();
Tango::UserDefaultAttrProp pressure_prop;
// description not set for Pressure
// label not set for Pressure
pressure_prop.set_unit("mbar");
pressure_prop.set_standard_unit("mbar");
pressure_prop.set_display_unit("mbar");
// format not set for Pressure
// max_value not set for Pressure
// min_value not set for Pressure
// max_alarm not set for Pressure
// min_alarm not set for Pressure
// max_warning not set for Pressure
// min_warning not set for Pressure
// delta_t not set for Pressure
// delta_val not set for Pressure
pressure->set_default_properties(pressure_prop);
// Not Polled
pressure->set_disp_level(Tango::OPERATOR);
// Not memorized
// Pressure does not fire change event
// Pressure does not fire archive event
// Pressure does not fire data_ready event
att_list.push_back(pressure);
// Attribute : DeviceState
DeviceStateAttrib *devicestate = new DeviceStateAttrib();
Tango::UserDefaultAttrProp devicestate_prop;
// description not set for DeviceState
// label not set for DeviceState
// unit not set for DeviceState
// standard_unit not set for DeviceState
// display_unit not set for DeviceState
// format not set for DeviceState
// max_value not set for DeviceState
// min_value not set for DeviceState
// max_alarm not set for DeviceState
// min_alarm not set for DeviceState
// max_warning not set for DeviceState
// min_warning not set for DeviceState
// delta_t not set for DeviceState
// delta_val not set for DeviceState
devicestate->set_default_properties(devicestate_prop);
// Not Polled
devicestate->set_disp_level(Tango::OPERATOR);
devicestate->set_memorized();
devicestate->set_memorized_init(false);
// DeviceState does not fire change event
// DeviceState does not fire archive event
// DeviceState does not fire data_ready event
att_list.push_back(devicestate);
// Create a list of static attributes
create_static_attribute_list(get_class_attr()->get_attr_list());
/*----- PROTECTED REGION ID(Vg::Class::attribute_factory_after) ENABLED START -----*/
// Add your own code
/*----- PROTECTED REGION END -----*/ // Vg::Class::attribute_factory_after
}
//--------------------------------------------------------
/**
* Method : Vg::VgClass::command_factory()
* Description : Create the command object(s)
* and store them in the command list
*/
//--------------------------------------------------------
void VgClass::command_factory()
{
/*----- PROTECTED REGION ID(Vg::Class::command_factory_before) ENABLED START -----*/
/*----- PROTECTED REGION END -----*/ // Vg::Class::command_factory_before
OnClass *pOnCmd =
new OnClass("On",
Tango::DEV_VOID, Tango::DEV_VOID,
"",
"",
Tango::EXPERT);
command_list.push_back(pOnCmd);
OffClass *pOffCmd =
new OffClass("Off",
Tango::DEV_VOID, Tango::DEV_VOID,
"",
"",
Tango::EXPERT);
command_list.push_back(pOffCmd);
/*----- PROTECTED REGION ID(Vg::Class::command_factory_after) ENABLED START -----*/
/*----- PROTECTED REGION END -----*/ // Vg::Class::command_factory_after
}
//===================================================================
// Dynamic attributes related methods
//===================================================================
//--------------------------------------------------------
/**
* method : VgClass::create_static_attribute_list
* description : Create the a list of static attributes
*
* @param att_list the ceated attribute list
*/
//--------------------------------------------------------
void VgClass::create_static_attribute_list(vector<Tango::Attr *> &att_list)
{
for (unsigned long i=0 ; i<att_list.size() ; i++)
{
string att_name(att_list[i]->get_name());
transform(att_name.begin(), att_name.end(), att_name.begin(), ::tolower);
defaultAttList.push_back(att_name);
}
cout2 << defaultAttList.size() << " attributes in default list" << endl;
/*----- PROTECTED REGION ID(Vg::Class::create_static_att_list) ENABLED START -----*/
/*----- PROTECTED REGION END -----*/ // Vg::Class::create_static_att_list
}
//--------------------------------------------------------
/**
* method : VgClass::erase_dynamic_attributes
* description : delete the dynamic attributes if any.
*
* @param devlist_ptr the device list pointer
* @param list of all attributes
*/
//--------------------------------------------------------
void VgClass::erase_dynamic_attributes(const Tango::DevVarStringArray *devlist_ptr, vector<Tango::Attr *> &att_list)
{
Tango::Util *tg = Tango::Util::instance();
for (unsigned long i=0 ; i<devlist_ptr->length() ; i++)
{
Tango::DeviceImpl *dev_impl = tg->get_device_by_name(((string)(*devlist_ptr)[i]).c_str());
Vg *dev = static_cast<Vg *> (dev_impl);
vector<Tango::Attribute *> &dev_att_list = dev->get_device_attr()->get_attribute_list();
vector<Tango::Attribute *>::iterator ite_att;
for (ite_att=dev_att_list.begin() ; ite_att != dev_att_list.end() ; ++ite_att)
{
string att_name((*ite_att)->get_name_lower());
if ((att_name == "state") || (att_name == "status"))
continue;
vector<string>::iterator ite_str = find(defaultAttList.begin(), defaultAttList.end(), att_name);
if (ite_str == defaultAttList.end())
{
cout2 << att_name << " is a UNWANTED dynamic attribute for device " << (*devlist_ptr)[i] << endl;
Tango::Attribute &att = dev->get_device_attr()->get_attr_by_name(att_name.c_str());
dev->remove_attribute(att_list[att.get_attr_idx()],true);
--ite_att;
}
}
}
/*----- PROTECTED REGION ID(Vg::Class::erase_dynamic_attributes) ENABLED START -----*/
/*----- PROTECTED REGION END -----*/ // Vg::Class::erase_dynamic_attributes
}
/*----- PROTECTED REGION ID(Vg::Class::Additional Methods) ENABLED START -----*/
/*----- PROTECTED REGION END -----*/ // Vg::Class::Additional Methods
} // namespace