blob: 6bac29480b4e1ae808e9ffb8a0c6adc6dc8c93e5 [file] [log] [blame]
///////////////////////////////////////////////////////////////////////////////
// //
// Copyright (c) 2000-2019 Ericsson Telecom AB //
// //
// All rights reserved. This program and the accompanying materials //
// are made available under the terms of the Eclipse Public License v2.0 //
// which accompanies this distribution, and is available at //
// https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.html //
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////
// Module: EPTF_CLL_UIHandler_DS_Definitions
//
// Purpose:
// This module contains the functions of the UIHandler data source definitions
//
// Module Parameters:
//
// -
//
//
// Module depends on:
//
// -
//
// Current Owner:
// EMIHMIK
//
// Last Review Date:
// 2012-05-14
//
///////////////////////////////////////////////////////////
module EPTF_CLL_UIHandler_DS_Definitions {
import from EPTF_CLL_DataSource_Definitions all;
///////////////////////////////////////////////////////////
// Group: EPTF_CLL_UIHandler_DataSource
//
// Purpose:
// Grouping data types for the UIHandler DataSource.
// This group contains the list of iterator names,
// data elements and their parameters.
// These items can be used in the GUI XML as iterators
// an external data.
//
///////////////////////////////////////////////////////////
group EPTF_CLL_UIHandler_DataSource {
///////////////////////////////////////////////////////////////////////////////
// Constant: c_UIHandler_DS_sourceId
//
// Purpose:
// UIHandler iterators and data elements belong to this dataSource name
//
///////////////////////////////////////////////////////////////////////////////
const charstring c_UIHandler_DS_sourceId := "UIHandler";
///////////////////////////////////////////////////////////////////////////////
// Constant: c_UIHandler_DS_var_prefix
//
// Purpose:
// This is the prefix for UIHandler iterator variables
//
///////////////////////////////////////////////////////////////////////////////
const charstring c_UIHandler_DS_var_prefix := c_UIHandler_DS_sourceId&"_var_";
///////////////////////////
// ParamNames
///////////////////////////
group ParamNames {
} // group ParamNames
///////////////////////////
// Iterators
///////////////////////////
group Iterators {
} // group Iterators
///////////////////////////
// DataElements
///////////////////////////
group DataElements {
///////////////////////////////////////////////////////////////////////////////
// Constant: c_EPTF_UIHandler_dataElement_Help
//
// Purpose:
// This data element returns the help information about
// all dataElements supported.
// ValueType: charstring
//
// Parameters:
// - <c_EPTF_DataSource_paramNameHelpFormat> - the format of the output
//
///////////////////////////////////////////////////////////////////////////////
const charstring c_EPTF_UIHandler_dataElement_help := c_EPTF_DataSource_dataElement_Help
const EPTF_DataSource_Help_DataElement c_EPTF_UIHandler_Help_dataElement_help := c_EPTF_DataSource_Help_dataElement_genericHelp;
///////////////////////////////////////////////////////////////////////////////
// Constant: c_UIHandler_dataElement_simulation_saveDBToFile
//
// Purpose:
// Button to save the DB created from Datalements to file (simulation getData).
//
// Parameters:
// -
//
///////////////////////////////////////////////////////////////////////////////
const charstring c_UIHandler_dataElement_simulation_saveDBToFile := "savedbtofile";
const EPTF_DataSource_Help_DataElement c_UIHandler_Help_dataElement_simulation_saveDBToFile := {
name := c_UIHandler_dataElement_simulation_saveDBToFile,
valueType := intType,
description := "Button to save the DB created from Datalements to file (simulation getData)."
}
///////////////////////////////////////////////////////////////////////////////
// Constant: c_UIHandler_dataElement_progressBar
//
// Purpose:
// The main purpose is to show the progress information.
//
// Parameters:
// -
//
///////////////////////////////////////////////////////////////////////////////
const charstring c_UIHandler_dataElement_progressBar := "progressBar";
const EPTF_DataSource_Help_DataElement c_UIHandler_Help_dataElement_progressBar := {
name := c_UIHandler_dataElement_progressBar,
valueType := charstringType,
description := " The main purpose is to show the progress information."
}
///////////////////////////////////////////////////////////////////////////////
// Constant: c_UIHandler_dataElement_progressBarHistory
//
// Purpose:
// The main purpose is to show the complete list of progress information.
// All values of <c_UIHandler_dataElement_progressBar> are accumulated into one list.
//
// Parameters:
// -
//
///////////////////////////////////////////////////////////////////////////////
const charstring c_UIHandler_dataElement_progressBarHistory := "progressBarHistory";
const EPTF_DataSource_Help_DataElement c_UIHandler_Help_dataElement_progressBarHistory := {
name := c_UIHandler_dataElement_progressBarHistory,
valueType := charstringType,
description := "The main purpose is to show the complete list of progress information. All values of <c_UIHandler_dataElement_progressBar> are accumulated into one list."
}
}
///////////////////////////
// Conditions
///////////////////////////
group Conditions {
} // Conditions
// the datasource help database for UIHandler
const EPTF_DataSource_Help_DataElementChildren c_EPTF_UIHandler_help := {
{
dataElement := c_EPTF_UIHandler_Help_dataElement_help
},
{
dataElement := c_UIHandler_Help_dataElement_simulation_saveDBToFile
},
{
dataElement := c_UIHandler_Help_dataElement_progressBar
},
{
dataElement := c_UIHandler_Help_dataElement_progressBarHistory
}
}
} // group EPTF_CLL_UIHandler_DataSource
} // module EPTF_CLL_UIHandler_DS_Definitions