src/LGenBase/EPTF_CLL_LGenBaseStatsUI_Definitions.ttcn

///////////////////////////////////////////////////////////////////////////////
//                                                                           //
// 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_LGenBaseStatsUI_Definitions
// 
//  Purpose:
//    This module provides definitions for displaying TitanSim load generator 
//    statistics 
// 
//  Module Parameters:
//    -
// 
//  Module depends on:
//    <EPTF_CLL_Common_Definitions>
//    <EPTF_CLL_LGenBaseStats_Definitions>
//    <EPTF_CLL_UIHandlerClient_Definitions>
//    <XUL_XTDL>
//
//  Current Owner:    ELSZSKU
// 
//  Last Review Date:
//    2008-02-26
// 
//  Detailed Comments:
// 
///////////////////////////////////////////////////////////
module EPTF_CLL_LGenBaseStatsUI_Definitions
{
//=========================================================================
// Import Part
//=========================================================================
import from EPTF_CLL_Common_Definitions all;
import from EPTF_CLL_LGenBaseStats_Definitions all;
import from EPTF_CLL_UIHandlerClient_Definitions all;
import from ttcn_ericsson_se_protocolModules_xtdp_xtdl all;

friend module EPTF_CLL_LGenBaseStatsUI_Functions;

const charstring c_EPTF_LGenBaseStatsUI_widgetIdSeparator := "-";

const charstring c_EPTF_LGenBaseStatsUI_nameOfStartBtn 		:= c_EPTF_LGenBaseStats_nameOfStartBtn;
const charstring c_EPTF_LGenBaseStatsUI_nameOfStopBtn 		:= c_EPTF_LGenBaseStats_nameOfStopBtn;
const charstring c_EPTF_LGenBaseStatsUI_nameOfAbortBtn 		:= c_EPTF_LGenBaseStats_nameOfAbortBtn;
const charstring c_EPTF_LGenBaseStatsUI_nameOfRestoreBtn 	:= c_EPTF_LGenBaseStats_nameOfRestoreBtn;
const charstring c_EPTF_LGenBaseStatsUI_nameOfPauseBtn 		:= c_EPTF_LGenBaseStats_nameOfPauseBtn;
const charstring c_EPTF_LGenBaseStatsUI_nameOfSingleShotBtn	:= c_EPTF_LGenBaseStats_nameOfSingleShotBtn; 

const integer c_EPTF_LGenBaseStatsUI_tcColTcName 					:= 0;
const integer c_EPTF_LGenBaseStatsUI_tcColEnabled 					:= 1;
const integer c_EPTF_LGenBaseStatsUI_tcColState						:= 2;
const integer c_EPTF_LGenBaseStatsUI_tcColUserData					:= 3;
const integer c_EPTF_LGenBaseStatsUI_tcColCpsToReach 				:= 4;
const integer c_EPTF_LGenBaseStatsUI_tcColLastCps					:= 5;
const integer c_EPTF_LGenBaseStatsUI_tcColNrOfAllEntities 			:= 6;
const integer c_EPTF_LGenBaseStatsUI_tcColNrOfRunningEntities 		:= 7;
const integer c_EPTF_LGenBaseStatsUI_tcColNrOfAvailableEntities 	:= 8;
const integer c_EPTF_LGenBaseStatsUI_tcColNrOfNotFinishedEntities 	:= 9;
const integer c_EPTF_LGenBaseStatsUI_tcColNrOfStarts 				:= 10;
const integer c_EPTF_LGenBaseStatsUI_tcColNrOfSuccesses				:= 11;
const integer c_EPTF_LGenBaseStatsUI_tcColNrOfFails                 := 12;
const integer c_EPTF_LGenBaseStatsUI_tcColMaxRunning				:= 13;
const integer c_EPTF_LGenBaseStatsUI_tcColMinAvailable				:= 14;
const integer c_EPTF_LGenBaseStatsUI_tcColMaxBusy					:= 15;
const integer c_EPTF_LGenBaseStatsUI_tcColSentMessages				:= 16;
const integer c_EPTF_LGenBaseStatsUI_tcColReceivedAnswers			:= 17;
const integer c_EPTF_LGenBaseStatsUI_tcColRangeLoops				:= 18;
const integer c_EPTF_LGenBaseStatsUI_tcColStateName					:= 19;
const integer c_EPTF_LGenBaseStatsUI_tcColWeight					:= 20;
const integer c_EPTF_LGenBaseStatsUI_tcColStartBtn					:= 21;
const integer c_EPTF_LGenBaseStatsUI_tcColStopBtn					:= 22;
const integer c_EPTF_LGenBaseStatsUI_tcColAbortBtn					:= 23;
const integer c_EPTF_LGenBaseStatsUI_tcColPauseBtn					:= 24;
const integer c_EPTF_LGenBaseStatsUI_tcColSingleShotBtn             := 25;
const integer c_EPTF_LGenBaseStatsUI_tcColTrafficType               := 26;
const integer c_EPTF_LGenBaseStatsUI_tcColNrOfErrors				:= 27;
const integer c_EPTF_LGenBaseStatsUI_tcColNrOfTimeouts				:= 28;

const integer c_EPTF_LGenBaseStatsUI_tcFirstColId := c_EPTF_LGenBaseStatsUI_tcColTcName;
const integer c_EPTF_LGenBaseStatsUI_tcLastColId := 28;

const integer c_EPTF_LGenBaseStatsUI_tcColNnrOfFails := c_EPTF_LGenBaseStatsUI_tcColNrOfFails
///////////////////////////////////////////////////////////
// Type: EPTF_LGenBaseStatsUI_displayOnScType
//
// Purpose:
///////////////////////////////////////////////////////////
type enumerated EPTF_LGenBaseStatsUI_displayOnScType { dsCps, dsWeight, dsBoth }

///////////////////////////////////////////////////////////
// Type: EPTF_LGenBaseStatsUI_tcVarDescriptor
//
// Purpose:
//   Traffic case variable descriptor  
//
// Elements:
//   - varName - *charstring*
//   - widgetType - <WidgetType>
//   - displayOn - <EPTF_LGenBaseStatsUI_displayOnScType>
///////////////////////////////////////////////////////////
type record EPTF_LGenBaseStatsUI_tcVarDescriptor {
  charstring varName,
  Widgettype widgetType,
  EPTF_LGenBaseStatsUI_displayOnScType displayOn
}
///////////////////////////////////////////////////////////
// Type: EPTF_LGenBaseStatsUI_varDescriptorList
//
// Purpose: List of <EPTF_LGenBaseStatsUI_tcVarDescriptor> records.
///////////////////////////////////////////////////////////
type record of EPTF_LGenBaseStatsUI_tcVarDescriptor EPTF_LGenBaseStatsUI_varDescriptorList;

const EPTF_LGenBaseStatsUI_varDescriptorList c_EPTF_LGenBaseStatsUI_tcVarDescriptor := {
  {c_EPTF_LGenBaseStats_nameOfTcName, string, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcEnabled, checkBox, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcState, integerField, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcUserData, string, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcCpsToReach, floatField, dsCps},
  {c_EPTF_LGenBaseStats_nameOfTcLastCps, floatField, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcNrOfAllEntities, integerField, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcNrOfRunningEntities, integerField, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcNrOfAvailableEntities, integerField, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcNrOfNotFinishedEntities, integerField, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcNrOfStarts, integerField, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcNrOfSuccesses, integerField, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcNrOfFails, integerField, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcMaxRunning, integerField, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcMinAvailable, integerField, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcMaxBusy, integerField, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcSentMessages, integerField, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcReceivedAnswers, integerField, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcRangeLoops, integerField, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcStateName, string, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcWeight, floatField, dsWeight},
  {c_EPTF_LGenBaseStatsUI_nameOfStartBtn, checkBox, dsBoth},
  {c_EPTF_LGenBaseStatsUI_nameOfStopBtn, checkBox, dsBoth},
  {c_EPTF_LGenBaseStatsUI_nameOfAbortBtn, checkBox, dsBoth},
  {c_EPTF_LGenBaseStatsUI_nameOfPauseBtn, checkBox, dsCps},
  {c_EPTF_LGenBaseStatsUI_nameOfSingleShotBtn, checkBox, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcTrafficType, string, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcNrOfErrors, integerField, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcNrOfTimeouts, integerField, dsBoth}
}

///////////////////////////////////////////////////////////
// Type: EPTF_LGenBaseStatsUI_tcColId
//
// Purpose:
//   Traffic case column index
/////////////////////////////////////////////////////////// 
type integer EPTF_LGenBaseStatsUI_tcColId (c_EPTF_LGenBaseStatsUI_tcFirstColId .. c_EPTF_LGenBaseStatsUI_tcLastColId);

///////////////////////////////////////////////////////////
// Type: EPTF_LGenBaseStatsUI_columnDescriptor
//
// Purpose:
//   Column descriptor  
//
// Elements:
//   - tcColId - <EPTF_LGenBaseStatsUI_tcColId>
//   - enableIfAvailable - *boolean*
///////////////////////////////////////////////////////////
type record EPTF_LGenBaseStatsUI_columnDescriptor {
  charstring colTitle,
  EPTF_LGenBaseStatsUI_tcColId tcColId,
  boolean enableIfAvailable
}

///////////////////////////////////////////////////////////
// Type: EPTF_LGenBaseStatsUI_columnDescriptorList
//
// Purpose: List of <EPTF_LGenBaseStatsUI_columnDescriptor> records.
///////////////////////////////////////////////////////////
type record of EPTF_LGenBaseStatsUI_columnDescriptor EPTF_LGenBaseStatsUI_columnDescriptorList;  

//Scenario tree
const integer c_EPTF_LGenBaseStatsUI_scColName	 					:= 0;
const integer c_EPTF_LGenBaseStatsUI_scColEnabled 					:= 1;
const integer c_EPTF_LGenBaseStatsUI_scColState						:= 2;
const integer c_EPTF_LGenBaseStatsUI_scColUserData					:= 3;
const integer c_EPTF_LGenBaseStatsUI_scColStartBtn					:= 4;
const integer c_EPTF_LGenBaseStatsUI_scColStopBtn					:= 5;
const integer c_EPTF_LGenBaseStatsUI_scColPauseBtn                  := 6;
const integer c_EPTF_LGenBaseStatsUI_scColAbortBtn					:= 7;
const integer c_EPTF_LGenBaseStatsUI_scColRestoreBtn				:= 8;
const integer c_EPTF_LGenBaseStatsUI_scColStateName					:= 9;
const integer c_EPTF_LGenBaseStatsUI_scColCPS						:= 10;
const integer c_EPTF_LGenBaseStatsUI_scColLockCPS					:= 11;
const integer c_EPTF_LGenBaseStatsUI_scColSingleShotBtn             := 12;
const integer c_EPTF_LGenBaseStatsUI_scColTrafficType               := 13;

const integer c_EPTF_LGenBaseStatsUI_scFirstColId := 0;
const integer c_EPTF_LGenBaseStatsUI_scLastColId := 13;

///////////////////////////////////////////////////////////
// Type: EPTF_LGenBaseStatsUI_scColId
//
// Purpose:
//   Scenario column index
///////////////////////////////////////////////////////////
type integer EPTF_LGenBaseStatsUI_scColId (c_EPTF_LGenBaseStatsUI_scFirstColId .. c_EPTF_LGenBaseStatsUI_scLastColId);

///////////////////////////////////////////////////////////
// Type: EPTF_LGenBaseStatsUI_scColumnDescriptor
//
// Purpose:
//   Scenario column descriptor  
//
// Elements:
//   - scColId - <EPTF_LGenBaseStatsUI_scColId>
//   - enableIfAvailable - *boolean*
///////////////////////////////////////////////////////////
type record EPTF_LGenBaseStatsUI_scColumnDescriptor {
  charstring colTitle,
  EPTF_LGenBaseStatsUI_scColId scColId,
  boolean enableIfAvailable
}

///////////////////////////////////////////////////////////
// Type: EPTF_LGenBaseStatsUI_scColumnDescriptorList
//
// Purpose: List of <EPTF_LGenBaseStatsUI_scColumnDescriptor> records.
///////////////////////////////////////////////////////////
type record of EPTF_LGenBaseStatsUI_scColumnDescriptor EPTF_LGenBaseStatsUI_scColumnDescriptorList;  

const EPTF_LGenBaseStatsUI_varDescriptorList c_EPTF_LGenBaseStatsUI_scVarDescriptor := {
  {c_EPTF_LGenBaseStats_nameOfScName, string, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfScEnabled, checkBox, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfScState, integerField, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfScUserData, string, dsBoth},
  {c_EPTF_LGenBaseStatsUI_nameOfStartBtn, pushButton, dsBoth},
  {c_EPTF_LGenBaseStatsUI_nameOfStopBtn, pushButton, dsBoth},
  {c_EPTF_LGenBaseStatsUI_nameOfPauseBtn, pushButton, dsBoth},
  {c_EPTF_LGenBaseStatsUI_nameOfAbortBtn, pushButton, dsBoth},
  {c_EPTF_LGenBaseStatsUI_nameOfRestoreBtn, pushButton, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfScStateName, string, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcCpsToReach, floatField, dsWeight},
  {c_EPTF_LGenBaseStats_nameOfScLockCPS, checkBox, dsWeight},
  {c_EPTF_LGenBaseStatsUI_nameOfSingleShotBtn, pushButton, dsBoth},
  {c_EPTF_LGenBaseStats_nameOfTcTrafficType, string, dsBoth}
}
/*
const EPTF_CharstringList c_EPTF_LGenBaseStatsUI_tcButtonNames := {
  c_EPTF_LGenBaseStatsUI_nameOfStartBtn,
  c_EPTF_LGenBaseStatsUI_nameOfStopBtn,
  c_EPTF_LGenBaseStatsUI_nameOfAbortBtn,
  c_EPTF_LGenBaseStatsUI_nameOfPauseBtn,
  c_EPTF_LGenBaseStats_nameOfTcEnabled
}
*/

///////////////////////////////////////////////////////////
// Type: EPTF_LGenBaseStatsUI_widgetSetDescriptor
//
// Purpose:
//   Widget set descriptor  
//
// Elements:
//   - column - *integer*
//   - enable - *boolean*
//   - clearIt - *boolean*
///////////////////////////////////////////////////////////
type record EPTF_LGenBaseStatsUI_widgetSetDescriptor {
  integer column,
  boolean enable,
  boolean clearIt
}

///////////////////////////////////////////////////////////
// Type: EPTF_LGenBaseStatsUI_widgetSetDescriptorList
//
// Purpose: List of <EPTF_LGenBaseStatsUI_widgetSetDescriptor> records.
///////////////////////////////////////////////////////////
type record of EPTF_LGenBaseStatsUI_widgetSetDescriptor EPTF_LGenBaseStatsUI_widgetSetDescriptorList;

const charstring c_LGenBaseStatsUI_subGUIPrefix := "subs";
///////////////////////////////////////////////////////////
//  Type: EPTF_LGenBaseStatsUI_CT
//
//  Extends: EPTF_LGenBaseStats_CT, EPTF_UIHandlerClient_CT
// 
//  Purpose:
//    Component type for the LGenBase statistics feature with GUI
/////////////////////////////////////////////////////////
type component EPTF_LGenBaseStatsUI_CT extends EPTF_LGenBaseStatsUI_Private_CT{
}

friend type component EPTF_LGenBaseStatsUI_Private_CT extends EPTF_LGenBaseStats_CT, EPTF_UIHandlerClient_CT{
  //var EPTF_BooleanList v_LGenBaseStatsUI_createdTcButtons := c_LGenBaseStatsUI_createdTcButtonsInit;
  private var charstring v_LGenBaseStatsUI_prefix := "";
  private var EPTF_LGenBaseStatsUI_columnDescriptorList v_LGenBaseStatsUI_tcColumnDescriptorList := {};
  private var EPTF_LGenBaseStatsUI_scColumnDescriptorList v_LGenBaseStatsUI_scColumnDescriptorList := {};
  private var EPTF_BooleanList v_LGenBaseStatsUI_createdTcWidgets := {};
  private var EPTF_BooleanList v_LGenBaseStatsUI_createdScWidgets := {};
  private var EPTF_BooleanList v_LGenBaseStatsUI_enabledTcWidgets := {};
  private var EPTF_BooleanList v_LGenBaseStatsUI_enabledScWidgets := {};
  private var boolean v_LGenBaseStatsUI_initialized:=false;
  private var charstring v_LGenBaseStatsUI_subGUIPrefix := c_LGenBaseStatsUI_subGUIPrefix;
  private var boolean v_LGenBaseStatsUI_dummyBool := false;
}
}