From 306eb28d7926eb09f43fcbae6f5fcd2cb3f23e04 Mon Sep 17 00:00:00 2001 From: Arafat Noureddine <arafat.noureddine@synchrotron-soleil.fr> Date: Wed, 6 Apr 2022 14:51:10 +0200 Subject: [PATCH] - Enhance description of some properties/attributes --- src/XiaDxp.cpp | 8 ++++++-- src/XiaDxp.h | 8 +++++--- src/XiaDxpClass.cpp | 8 ++++---- 3 files changed, 15 insertions(+), 9 deletions(-) diff --git a/src/XiaDxp.cpp b/src/XiaDxp.cpp index 9b8a19d..d846a7d 100644 --- a/src/XiaDxp.cpp +++ b/src/XiaDxp.cpp @@ -1430,7 +1430,9 @@ void XiaDxp::stop() * method: XiaDxp::set_rois_from_list * * description: method to execute "SetRoisFromList" - * ... + * Define a set of rois for each channel.<br> + * The set of rois is entered directly by user.<br> + * NB: put channel number=-1 to apply the same rois for all channels.<br> * * @param argin channel_num;roi1_begin;roi1_end;roi2_begin;roi2_end;... * @@ -1835,7 +1837,7 @@ Tango::DevVarStringArray *XiaDxp::get_rois_files_alias() * method: XiaDxp::get_data_streams * * description: method to execute "GetDataStreams" - * Returns the flyscan data streams associated with this device formatted as below :<br> + * Returns the flyscan data streams associated with this device<br> * * @return * @@ -1943,6 +1945,8 @@ Tango::DevState XiaDxp::dev_state() + + } // namespace diff --git a/src/XiaDxp.h b/src/XiaDxp.h index 1adf71e..fd6d23e 100644 --- a/src/XiaDxp.h +++ b/src/XiaDxp.h @@ -125,7 +125,7 @@ public: * Define the board type :<br> * XMAP [;path of the library handel.dll]<br> * FALCONX [;path of the library handel.dll]<br> - * SIMULATOR [;nbModules] [;nbChannels] [;acquisitionClockMs] [;loadConfigurationFileDelayMs]<br> + * SIMULATOR [;nbModules] [;nbChannels][;nbChannelsPerModule] [;acquisitionClockMs] [;loadConfigurationFileDelayMs]<br> */ string boardType; /** @@ -541,7 +541,9 @@ public: */ void save_config_file(); /** - * ... + * Define a set of rois for each channel.<br> + * The set of rois is entered directly by user.<br> + * NB: put channel number=-1 to apply the same rois for all channels.<br> * @param argin channel_num;roi1_begin;roi1_end;roi2_begin;roi2_end;... * @exception DevFailed */ @@ -572,7 +574,7 @@ public: */ void stream_reset_index(); /** - * Returns the flyscan data streams associated with this device formatted as below :<br> + * Returns the flyscan data streams associated with this device<br> * @return * @exception DevFailed */ diff --git a/src/XiaDxpClass.cpp b/src/XiaDxpClass.cpp index 3648c83..83660e8 100644 --- a/src/XiaDxpClass.cpp +++ b/src/XiaDxpClass.cpp @@ -588,7 +588,7 @@ void XiaDxpClass::attribute_factory(vector<Tango::Attr *> &att_list) board_type_prop.set_unit(" "); board_type_prop.set_standard_unit(" "); board_type_prop.set_display_unit(" "); - board_type_prop.set_description("The Board type Fixed by the BoardType property"); + board_type_prop.set_description("The Board type Fixed by the BoardType property:<br>\nXMAP<br>\nFALCONX<br>\nSIMULATOR<br>"); board_type->set_default_properties(board_type_prop); att_list.push_back(board_type); @@ -610,7 +610,7 @@ void XiaDxpClass::attribute_factory(vector<Tango::Attr *> &att_list) nb_channels_prop.set_standard_unit(" "); nb_channels_prop.set_display_unit(" "); nb_channels_prop.set_format("%d"); - nb_channels_prop.set_description("Number of total of Channels"); + nb_channels_prop.set_description("Number of total Channels "); nb_channels->set_default_properties(nb_channels_prop); att_list.push_back(nb_channels); @@ -816,7 +816,7 @@ void XiaDxpClass::set_default_property() add_wiz_dev_prop(prop_name, prop_desc); prop_name = "BoardType"; - prop_desc = "Define the board type :<br>\nXMAP [;path of the library handel.dll]<br>\nFALCONX [;path of the library handel.dll]<br>\nSIMULATOR [;nbModules] [;nbChannels] [;acquisitionClockMs] [;loadConfigurationFileDelayMs]<br>"; + prop_desc = "Define the board type :<br>\nXMAP [;path of the library handel.dll]<br>\nFALCONX [;path of the library handel.dll]<br>\nSIMULATOR [;nbModules] [;nbChannels][;nbChannelsPerModule] [;acquisitionClockMs] [;loadConfigurationFileDelayMs]<br>"; prop_def = "XMAP"; vect_data.clear(); vect_data.push_back("XMAP"); @@ -1122,7 +1122,7 @@ void XiaDxpClass::set_default_property() add_wiz_dev_prop(prop_name, prop_desc); prop_name = "__ExpertMemoryMonitor"; - prop_desc = "Enable/Disable the creation of a memory file in order to monitor the process memory usage.<BR>\nExample : <BR>\nFALSE {by default } (means do not create a memory file)<BR>\nTRUE [;c:/my_location/my_file.txt] (means create my_file.txt in c:/my_location) <BR>\n"; + prop_desc = "Enable/Disable the creation of a memory file in order to monitor the process memory usage.<BR>\nExample : <BR>\nFALSE {by default } (means do not create a memory file)<BR>\nTRUE [;c:\my_location\my_file.txt] (means create my_file.txt in c:\my_location) <BR>\n"; prop_def = "FALSE"; vect_data.clear(); vect_data.push_back("FALSE"); -- GitLab