| /////////////////////////////////////////////////////////////////////////////// |
| // // |
| // Copyright (c) 2000-2017 Ericsson Telecom AB // |
| // // |
| // All rights reserved. This program and the accompanying materials // |
| // are made available under the terms of the Eclipse Public License v1.0 // |
| // which accompanies this distribution, and is available at // |
| // http://www.eclipse.org/legal/epl-v10.html // |
| /////////////////////////////////////////////////////////////////////////////// |
| |
| /////////////////////////////////////////////////////////// |
| // Module: EPTF_CLL_DataSource_Apidoc |
| // |
| // Purpose: |
| // This module contains the description of all CLL data elements. |
| // |
| // Current Owner: |
| // EKISTAM |
| // |
| // Last Review Date: |
| // 2015-xx-xx |
| // |
| // Detailed Comments: |
| // This file contains the description of all CLL data elements |
| /////////////////////////////////////////////////////////////// |
| |
| // This is a generated file, do not edit! |
| |
| // Group: "DataSource" |
| // |
| group DataSource { |
| |
| // Function: "Sources" |
| // |
| // *Description*: This iterator enlists the data sources that have been registered into the DataSource |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "Source" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Sources' source='DataSource'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "PTCs" |
| // |
| // *Description*: This data element returns the list of PTCs for a given data source |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "PTC" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='PTCs' source='DataSource'> <params> <dataparam name='Source' value='DataSource'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Source"* |
| // - TypeDescriptor - "Source" item |
| // - Description - the data source. Should be one item in the list returned by 'Sources' |
| // - Example Value - "DataSource" |
| // |
| |
| // Function: "sizeOf" |
| // |
| // *Description*: This dataelement returns the size of the iterator list or 1 for single elements |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='sizeOf' source='DataSource'> <params> <dataparam name='Source' value='DataSource'/> <dataparam name='PTCName' value=''/> <dataparam name='Element' value='PTCs'/> <dataparam name='ParamName' value='Source'/> <dataparam name='ParamValue' value='DataSource'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Source"* |
| // - TypeDescriptor - "Source" item |
| // - Description - the data source |
| // - Example Value - "DataSource" |
| // |
| // - *"PTCName"* |
| // - TypeDescriptor - "PTC" item |
| // - Description - the PTC name (optional) |
| // - Example Value - "" |
| // |
| // - *"Element"* |
| // - TypeDescriptor - charstringType |
| // - Description - the Element. This parameter is followed by an optional list of the parameterName-Value pairs |
| // - Example Value - "PTCs" |
| // |
| // - *"ParamName"* |
| // - TypeDescriptor - charstringType |
| // - Description - the ParamName |
| // - Example Value - "Source" |
| // |
| // - *"ParamValue"* |
| // - TypeDescriptor - charstringType |
| // - Description - the ParamValue |
| // - Example Value - "DataSource" |
| // |
| |
| // Function: "isWritable" |
| // |
| // *Description*: This dataelement returns whether the given element is writable |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='isWritable' source='DataSource'> <params> <dataparam name='Source' value='DataSource'/> <dataparam name='PTCName' value=''/> <dataparam name='Element' value='PTCs'/> <dataparam name='ParamName' value='Source'/> <dataparam name='ParamValue' value='DataSource'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Source"* |
| // - TypeDescriptor - "Source" item |
| // - Description - the data source |
| // - Example Value - "DataSource" |
| // |
| // - *"PTCName"* |
| // - TypeDescriptor - "PTC" item |
| // - Description - the PTC name (optional) |
| // - Example Value - "" |
| // |
| // - *"Element"* |
| // - TypeDescriptor - charstringType |
| // - Description - the Element. This parameter is followed by an optional list of the parameterName-Value pairs |
| // - Example Value - "PTCs" |
| // |
| // - *"ParamName"* |
| // - TypeDescriptor - charstringType |
| // - Description - the ParamName |
| // - Example Value - "Source" |
| // |
| // - *"ParamValue"* |
| // - TypeDescriptor - charstringType |
| // - Description - the ParamValue |
| // - Example Value - "DataSource" |
| // |
| |
| // Function: "help" |
| // |
| // *Description*: This data element returns the help information about all dataElements supported |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='help' source='DataSource'> <params> <dataparam name='Format' value='TEXT'/> <dataparam name='Source' value='DataSource'/> <dataparam name='Element' value=''/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Format"* |
| // - TypeDescriptor - charstringType |
| // - Description - The format of the output. Valid values: "JSON", "TEXT". Default: "JSON" |
| // - Example Value - "TEXT" |
| // |
| // - *"Source"* |
| // - TypeDescriptor - charstringType |
| // - Description - The source to select the help for. If not specified (or empty string "" is given) it means 'all available sources' |
| // - Example Value - "DataSource" |
| // |
| // - *"Element"* |
| // - TypeDescriptor - charstringType |
| // - Description - The element to select the help for. If not specified (or empty string "" is given) it means 'all available elements' |
| // - Example Value - "" |
| // |
| |
| // Function: "==" |
| // |
| // *Description*: This condition tests if the value of the first argument is the same as of the second |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='==' source='DataSource'> <params> <dataparam name='Par1' value='some string'/> <dataparam name='Par2' value='some other string'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Par1"* |
| // - TypeDescriptor - charstringType |
| // - Description - the first param to compare |
| // - Example Value - "some string" |
| // |
| // - *"Par2"* |
| // - TypeDescriptor - charstringType |
| // - Description - the second param to compare |
| // - Example Value - "some other string" |
| // |
| |
| // Function: "!=" |
| // |
| // *Description*: This condition tests if the value of the first argument differs from the second |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='!=' source='DataSource'> <params> <dataparam name='Par1' value='some string'/> <dataparam name='Par2' value='some other string'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Par1"* |
| // - TypeDescriptor - charstringType |
| // - Description - the first param to compare |
| // - Example Value - "some string" |
| // |
| // - *"Par2"* |
| // - TypeDescriptor - charstringType |
| // - Description - the second param to compare |
| // - Example Value - "some other string" |
| // |
| |
| // Function: ">" |
| // |
| // *Description*: This condition tests if the value of the first argument is more than the second. The value of the parameters should be a float number. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='>' source='DataSource'> <params> <dataparam name='Par1' value='1.0'/> <dataparam name='Par2' value='2.0e-2'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Par1"* |
| // - TypeDescriptor - floatType |
| // - Description - the first param to compare |
| // - Example Value - "1.0" |
| // |
| // - *"Par2"* |
| // - TypeDescriptor - floatType |
| // - Description - the second param to compare |
| // - Example Value - "2.0e-2" |
| // |
| |
| // Function: ">=" |
| // |
| // *Description*: This condition tests if the value of the first argument is more or equal than the second. The value of the parameters should be a float number. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='>=' source='DataSource'> <params> <dataparam name='Par1' value='1.0'/> <dataparam name='Par2' value='2.0e-2'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Par1"* |
| // - TypeDescriptor - floatType |
| // - Description - the first param to compare |
| // - Example Value - "1.0" |
| // |
| // - *"Par2"* |
| // - TypeDescriptor - floatType |
| // - Description - the second param to compare |
| // - Example Value - "2.0e-2" |
| // |
| |
| // Function: "<" |
| // |
| // *Description*: This condition tests if the value of the first argument is less than the second. The value of the parameters should be a float number. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='<' source='DataSource'> <params> <dataparam name='Par1' value='1.0'/> <dataparam name='Par2' value='2.0e-2'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Par1"* |
| // - TypeDescriptor - floatType |
| // - Description - the first param to compare |
| // - Example Value - "1.0" |
| // |
| // - *"Par2"* |
| // - TypeDescriptor - floatType |
| // - Description - the second param to compare |
| // - Example Value - "2.0e-2" |
| // |
| |
| // Function: "<=" |
| // |
| // *Description*: This condition tests if the value of the first argument is less or equal than the second. The value of the parameters should be a float number. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='<=' source='DataSource'> <params> <dataparam name='Par1' value='1.0'/> <dataparam name='Par2' value='2.0e-2'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Par1"* |
| // - TypeDescriptor - floatType |
| // - Description - the first param to compare |
| // - Example Value - "1.0" |
| // |
| // - *"Par2"* |
| // - TypeDescriptor - floatType |
| // - Description - the second param to compare |
| // - Example Value - "2.0e-2" |
| // |
| |
| // Function: "match" |
| // |
| // *Description*: This condition tests if the value of the first argument matches the second. The ttcn match function is called for the given arguments in order. The second parameter used as a pattern string for matching. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='match' source='DataSource'> <params> <dataparam name='Par1' value='some string'/> <dataparam name='Par2' value='*str*'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Par1"* |
| // - TypeDescriptor - charstringType |
| // - Description - the first param to compare |
| // - Example Value - "some string" |
| // |
| // - *"Par2"* |
| // - TypeDescriptor - charstringType |
| // - Description - the second param to compare. This parameter is used as a pattern string for matching |
| // - Example Value - "*str*" |
| // |
| |
| // Function: "not match" |
| // |
| // *Description*: This condition tests if the value of the first argument does not match the second. The ttcn match function is called for the given arguments in order. The second parameter used as a pattern string for matching. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='not match' source='DataSource'> <params> <dataparam name='Par1' value='some string'/> <dataparam name='Par2' value='*str*'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Par1"* |
| // - TypeDescriptor - charstringType |
| // - Description - the first param to compare |
| // - Example Value - "some string" |
| // |
| // - *"Par2"* |
| // - TypeDescriptor - charstringType |
| // - Description - the second param to compare. This parameter is used as a pattern string for matching |
| // - Example Value - "*str*" |
| // |
| |
| // Function: "and" |
| // |
| // *Description*: This condition returns the logical 'and' of the arguments |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='and' source='DataSource'> <params> <dataparam name='Par1' value='true'/> <dataparam name='Par2' value='false'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Par1"* |
| // - TypeDescriptor - boolType |
| // - Description - the first param. Type: booltype |
| // - Example Value - "true" |
| // |
| // - *"Par2"* |
| // - TypeDescriptor - boolType |
| // - Description - the second param. Type: booltype |
| // - Example Value - "false" |
| // |
| |
| // Function: "or" |
| // |
| // *Description*: This condition returns the logical 'or' of the arguments |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='or' source='DataSource'> <params> <dataparam name='Par1' value='true'/> <dataparam name='Par2' value='false'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Par1"* |
| // - TypeDescriptor - boolType |
| // - Description - the first param. Type: booltype |
| // - Example Value - "true" |
| // |
| // - *"Par2"* |
| // - TypeDescriptor - boolType |
| // - Description - the second param. Type: booltype |
| // - Example Value - "false" |
| // |
| |
| // Function: "not" |
| // |
| // *Description*: This condition returns the logical 'not' of the argument |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='not' source='DataSource'> <params> <dataparam name='Par1' value='false'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Par1"* |
| // - TypeDescriptor - boolType |
| // - Description - the first param. Type: booltype |
| // - Example Value - "false" |
| // |
| |
| // Function: "dataElementPresent" |
| // |
| // *Description*: This condition returns true if the specified dataElement is present |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='dataElementPresent' source='DataSource'> <params> <dataparam name='Source' value='DataSource'/> <dataparam name='PTCName' value=''/> <dataparam name='Element' value='PTCs'/> <dataparam name='ParamName' value='Source'/> <dataparam name='ParamValue' value='DataSource'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Source"* |
| // - TypeDescriptor - "Source" item |
| // - Description - the data source |
| // - Example Value - "DataSource" |
| // |
| // - *"PTCName"* |
| // - TypeDescriptor - "PTC" item |
| // - Description - the PTC name (optional) |
| // - Example Value - "" |
| // |
| // - *"Element"* |
| // - TypeDescriptor - charstringType |
| // - Description - the Element. This parameter is followed by an optional list of the parameterName-Value pairs |
| // - Example Value - "PTCs" |
| // |
| // - *"ParamName"* |
| // - TypeDescriptor - charstringType |
| // - Description - the ParamName |
| // - Example Value - "Source" |
| // |
| // - *"ParamValue"* |
| // - TypeDescriptor - charstringType |
| // - Description - the ParamValue |
| // - Example Value - "DataSource" |
| // |
| } // ~group |
| |
| // Group: "DsRestAPI_Timeline" |
| // |
| group DsRestAPI_Timeline { |
| |
| // Function: "help" |
| // |
| // *Description*: This data element returns the help information about all dataElements supported |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='help' source='DsRestAPI_Timeline'> <params> <dataparam name='Format' value='TEXT'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Format"* |
| // - TypeDescriptor - charstringType |
| // - Description - The format of the output. Valid values: JSON, TEXT. Default: JSON |
| // - Example Value - "TEXT" |
| // |
| |
| // Function: "Timeline" |
| // |
| // *Description*: This dataElement returns the timeline for a given dataelement. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Timeline' source='DsRestAPI_Timeline'> <params> <dataparam name='Period' value='3.0'/> <dataparam name='Maxpoints' value='255'/> <dataparam name='Since' value='1476103390'/> <dataparam name='Source' value='ExecCtrl'/> <dataparam name='PTCName' value=''/> <dataparam name='Element' value='GlobalStat'/> <dataparam name='ParamName' value='Statistic'/> <dataparam name='ParamValue' value='Success'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Period"* |
| // - TypeDescriptor - floatType |
| // - Description - The period with which the timeline is created for this dataelement (optional). |
| // - Example Value - "3.0" |
| // |
| // - *"Maxpoints"* |
| // - TypeDescriptor - intType |
| // - Description - The number of max points specified (optional). |
| // - Example Value - "255" |
| // |
| // - *"Since"* |
| // - TypeDescriptor - floatType |
| // - Description - Return only the part of the timeline, whose measurements were made since the given time (optional). |
| // - Example Value - "1476103390" |
| // |
| // - *"Source"* |
| // - TypeDescriptor - charstringType |
| // - Description - The original source of the timeline. |
| // - Example Value - "ExecCtrl" |
| // |
| // - *"PTCName"* |
| // - TypeDescriptor - charstringType |
| // - Description - The original PTC name of the timeline (optional). |
| // - Example Value - "" |
| // |
| // - *"Element"* |
| // - TypeDescriptor - charstringType |
| // - Description - The original element of the timeline. This parameter is followed by an optional list of the parameterName-Value pairs. |
| // - Example Value - "GlobalStat" |
| // |
| // - *"ParamName"* |
| // - TypeDescriptor - charstringType |
| // - Description - The ParamName. |
| // - Example Value - "Statistic" |
| // |
| // - *"ParamValue"* |
| // - TypeDescriptor - charstringType |
| // - Description - The ParamValue. |
| // - Example Value - "Success" |
| // |
| |
| // Function: "Running" |
| // |
| // *Description*: This dataElement can be used to turn the data collection on or off. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Running' source='DsRestAPI_Timeline'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "AppendFromFile" |
| // |
| // *Description*: This dataElement can be used to add elements for which a timeline will be created in a SetDataValue request. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='AppendFromFile' source='DsRestAPI_Timeline'> <params> <dataparam name='FileName' value='../request.json'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"FileName"* |
| // - TypeDescriptor - charstringType |
| // - Description - The name of the file that contains the request. |
| // - Example Value - "../request.json" |
| // |
| |
| // Function: "AppendFromJSON" |
| // |
| // *Description*: This dataElement can be used to add elements for which a timeline will be created in a SetDataValue request. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='AppendFromJSON' source='DsRestAPI_Timeline'> <params> <dataparam name='Request' value='[{"getData": {"source": "ExecCtrl", "element": "TimeElapsed", "timeline": {...}}}]'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Request"* |
| // - TypeDescriptor - charstringType |
| // - Description - The request as a JSON string. |
| // - Example Value - "[{"getData": {"source": "ExecCtrl", "element": "TimeElapsed", "timeline": {...}}}]" |
| // |
| |
| // Function: "Clear" |
| // |
| // *Description*: This dataElement can be used to clear all collected timelines in a SetDataValue request. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Clear' source='DsRestAPI_Timeline'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| } // ~group |
| |
| // Group: "Logging" |
| // |
| group Logging { |
| |
| // Function: "help" |
| // |
| // *Description*: This data element returns the help information about all dataElements supported |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='help' source='Logging'> <params> <dataparam name='Format' value='TEXT'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Format"* |
| // - TypeDescriptor - charstringType |
| // - Description - The format of the output. Valid values: JSON, TEXT. Default: JSON |
| // - Example Value - "TEXT" |
| // |
| |
| // Function: "Clients" |
| // |
| // *Description*: Iterator enlists the PTC names of registered clients. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Clients' source='Logging'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "LogEnabled" |
| // |
| // *Description*: Enabled state of global logging |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='LogEnabled' source='Logging'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "SelectionTypes" |
| // |
| // *Description*: Iterator enlists the available selection types. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "SelectionType" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='SelectionTypes' source='Logging'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "ComponentTypes" |
| // |
| // *Description*: Iterator enlists the name of the component types which registered their log classes. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "ComponentType" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ComponentTypes' source='Logging'> <params> <dataparam name='Selection' value='EPTF_CLL'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Selection"* |
| // - TypeDescriptor - "SelectionType" item |
| // - Description - The selection type to filter the component types which registered their log classes |
| // - Example Value - "EPTF_CLL" |
| // |
| |
| // Function: "Clients" |
| // |
| // *Description*: Iterator enlists only the client PTC names which PTCs registered the given component type. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Clients' source='Logging'> <params> <dataparam name='ComponentType' value='EPTF_Logging'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ComponentType"* |
| // - TypeDescriptor - "ComponentType" item |
| // - Description - Specifies the component type name which registered its log classes. |
| // - Example Value - "EPTF_Logging" |
| // |
| |
| // Function: "LogEnabled" |
| // |
| // *Description*: Enabled state of the component type log |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='LogEnabled' source='Logging'> <params> <dataparam name='ComponentType' value='EPTF_Logging'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ComponentType"* |
| // - TypeDescriptor - "ComponentType" item |
| // - Description - Specifies the component type name which registered its log classes. |
| // - Example Value - "EPTF_Logging" |
| // |
| |
| // Function: "Classes" |
| // |
| // *Description*: Iterator enlists the registered log classes |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "Class" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Classes' source='Logging'> <params> <dataparam name='ComponentType' value='EPTF_Logging'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ComponentType"* |
| // - TypeDescriptor - "ComponentType" item |
| // - Description - Specifies the component type name which registered its log classes. |
| // - Example Value - "EPTF_Logging" |
| // |
| |
| // Function: "LogEnabled" |
| // |
| // *Description*: Enabled state of the given log class of the given component type log |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='LogEnabled' source='Logging'> <params> <dataparam name='ComponentType' value='EPTF_Logging'/> <dataparam name='Class' value='Warning'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ComponentType"* |
| // - TypeDescriptor - "ComponentType" item |
| // - Description - Specifies the component type name which registered its log classes. |
| // - Example Value - "EPTF_Logging" |
| // |
| // - *"Class"* |
| // - TypeDescriptor - "Class" item |
| // - Description - Specifies the name of a registered logging class |
| // - Example Value - "Warning" |
| // |
| } // ~group |
| |
| // Group: "LoadRegulator" |
| // |
| group LoadRegulator { |
| |
| // Function: "help" |
| // |
| // *Description*: This data element returns the help information about all dataElements supported |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='help' source='LoadRegulator'> <params> <dataparam name='Format' value='TEXT'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Format"* |
| // - TypeDescriptor - charstringType |
| // - Description - The format of the output. Valid values: JSON, TEXT. Default: JSON |
| // - Example Value - "TEXT" |
| // |
| |
| // Function: "Enabled" |
| // |
| // *Description*: This dataElement returns the variable name where the 'enabled' attribute of the LoadRegulator is stored. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Enabled' source='LoadRegulator'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "CpsToReach" |
| // |
| // *Description*: This dataElement returns the variable name where the 'cpsToReach' attribute of the LoadRegulator is stored. |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='CpsToReach' source='LoadRegulator'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "LoadToReach" |
| // |
| // *Description*: This dataElement returns the variable name where the 'loadToReach' attribute of the LoadRegulator is stored. |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='LoadToReach' source='LoadRegulator'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "CurrentLoad" |
| // |
| // *Description*: This dataElement returns the variable name where the 'currentLoad' attribute of the LoadRegulator is stored. |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='CurrentLoad' source='LoadRegulator'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "LoadIsStable" |
| // |
| // *Description*: This dataElement returns the variable name where the 'loadIsStable' attribute of the LoadRegulator is stored. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='LoadIsStable' source='LoadRegulator'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| } // ~group |
| |
| // Group: "StatManager" |
| // |
| group StatManager { |
| |
| // Function: "help" |
| // |
| // *Description*: This data element returns the help information about all dataElements supported |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='help' source='StatManager'> <params> <dataparam name='Format' value='TEXT'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Format"* |
| // - TypeDescriptor - charstringType |
| // - Description - The format of the output. Valid values: JSON, TEXT. Default: JSON |
| // - Example Value - "TEXT" |
| // |
| |
| // Function: "LEDlimit" |
| // |
| // *Description*: This dataElement creates/returns a limits statistics for a given source and reference variable. |
| // |
| // *ValueType*: statusLEDType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='LEDlimit' source='StatManager'> <params> <dataparam name='blackLimit' value='10.0'/> <dataparam name='blueLimit' value='20.0'/> <dataparam name='redLimit' value='30.0'/> <dataparam name='yellowLimit' value='40.0'/> <dataparam name='greenLimit' value='50.0'/> <dataparam name='defaultColor' value='green'/> <dataparam name='enableValueInLEDText' value='yes'/> <dataparam name='VarId' value='varNameThatContainsFloatOrIntValue'/> <dataparam name='refVarId' value='referenceVarNameThatContainsFloatOrIntValue'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"blackLimit"* |
| // - TypeDescriptor - floatType |
| // - Description - Limiting value above which the LED colour becomes black (optional) |
| // - Example Value - "10.0" |
| // |
| // - *"blueLimit"* |
| // - TypeDescriptor - floatType |
| // - Description - Limiting value above which the LED colour becomes blue (optional) |
| // - Example Value - "20.0" |
| // |
| // - *"redLimit"* |
| // - TypeDescriptor - floatType |
| // - Description - Limiting value above which the LED colour becomes red (optional) |
| // - Example Value - "30.0" |
| // |
| // - *"yellowLimit"* |
| // - TypeDescriptor - floatType |
| // - Description - Limiting value above which the LED colour becomes yellow (optional) |
| // - Example Value - "40.0" |
| // |
| // - *"greenLimit"* |
| // - TypeDescriptor - floatType |
| // - Description - Limiting value above which the LED colour becomes green (optional) |
| // - Example Value - "50.0" |
| // |
| // - *"defaultColor"* |
| // - TypeDescriptor - charstringType |
| // - Description - Specifies the default colour of the LED (colour below the lowest limit). Its value should be one of: "blue","black","yellow","green" or "red". (optional, default: "black") |
| // - Example Value - "green" |
| // |
| // - *"enableValueInLEDText"* |
| // - TypeDescriptor - charstringType |
| // - Description - If set to "yes": enables value indication in the label of the statusLED. When enabled, the value of the data variable will appear in the LED text. Possible values: "yes", "no" (optional, default: "no") |
| // - Example Value - "yes" |
| // |
| // - *"VarId"* |
| // - TypeDescriptor - charstringType |
| // - Description - the name of the EPTF Variable that contains the source data for the limits statistics (its value should be float or integer type) |
| // - Example Value - "varNameThatContainsFloatOrIntValue" |
| // |
| // - *"refVarId"* |
| // - TypeDescriptor - charstringType |
| // - Description - The name of the reference variable (optional). If specified the limits are considered as relative difference in percentile from the value of the reference variable. If not specified, the limits will be taken as absolute values. The reference variable should contain a float or integer type value. |
| // - Example Value - "referenceVarNameThatContainsFloatOrIntValue" |
| // |
| |
| // Function: "GoS" |
| // |
| // *Description*: This dataElement creates/returns a GoS statistics for a given source variables. |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='GoS' source='StatManager'> <params> <dataparam name='SuccessVarName' value='varNameThatContainsIntValue'/> <dataparam name='FailVarName' value='varNameThatContainsIntValue'/> <dataparam name='TimeoutVarName' value='varNameThatContainsIntValue'/> <dataparam name='ErrorVarName' value='varNameThatContainsIntValue'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"SuccessVarName"* |
| // - TypeDescriptor - charstringType |
| // - Description - the name of the EPTF Variable that contains the Success data for the GoS statistics (its value should be integer type) |
| // - Example Value - "varNameThatContainsIntValue" |
| // |
| // - *"FailVarName"* |
| // - TypeDescriptor - charstringType |
| // - Description - the name of the EPTF Variable that contains the Fail data for the GoS statistics (its value should be integer type) |
| // - Example Value - "varNameThatContainsIntValue" |
| // |
| // - *"TimeoutVarName"* |
| // - TypeDescriptor - charstringType |
| // - Description - the name of the EPTF Variable that contains the Timeout data for the GoS statistics (its value should be integer type) |
| // - Example Value - "varNameThatContainsIntValue" |
| // |
| // - *"ErrorVarName"* |
| // - TypeDescriptor - charstringType |
| // - Description - the name of the EPTF Variable that contains the Error data for the GoS statistics (its value should be integer type) |
| // - Example Value - "varNameThatContainsIntValue" |
| // |
| } // ~group |
| |
| // Group: "UIHandler" |
| // |
| group UIHandler { |
| |
| // Function: "help" |
| // |
| // *Description*: This data element returns the help information about all dataElements supported |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='help' source='UIHandler'> <params> <dataparam name='Format' value='TEXT'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Format"* |
| // - TypeDescriptor - charstringType |
| // - Description - The format of the output. Valid values: JSON, TEXT. Default: JSON |
| // - Example Value - "TEXT" |
| // |
| |
| // Function: "savedbtofile" |
| // |
| // *Description*: Button to save the DB created from Datalements to file (simulation getData). |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='savedbtofile' source='UIHandler'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "progressBar" |
| // |
| // *Description*: The main purpose is to show the progress information. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='progressBar' source='UIHandler'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "progressBarHistory" |
| // |
| // *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. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='progressBarHistory' source='UIHandler'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| } // ~group |
| |
| // Group: "HostAdmin" |
| // |
| group HostAdmin { |
| |
| // Function: "help" |
| // |
| // *Description*: This data element returns the help information about all dataElements supported |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='help' source='HostAdmin'> <params> <dataparam name='Format' value='TEXT'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Format"* |
| // - TypeDescriptor - charstringType |
| // - Description - The format of the output. Valid values: JSON, TEXT. Default: JSON |
| // - Example Value - "TEXT" |
| // |
| |
| // Function: "Processes" |
| // |
| // *Description*: This iterator lists the processes on a given host. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "Process" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Processes' source='HostAdmin'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "ProcName" |
| // |
| // *Description*: This data element returns the name of the given process (=selfName) |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ProcName' source='HostAdmin'> <params> <dataparam name='ProcID' value='1'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ProcID"* |
| // - TypeDescriptor - "Process" item |
| // - Description - process id |
| // - Example Value - "1" |
| // |
| |
| // Function: "ProcCPULoad" |
| // |
| // *Description*: This data element returns the CPU load of the process |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ProcCPULoad' source='HostAdmin'> <params> <dataparam name='ProcID' value='1'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ProcID"* |
| // - TypeDescriptor - "Process" item |
| // - Description - process id |
| // - Example Value - "1" |
| // |
| |
| // Function: "ProcMEMUsage" |
| // |
| // *Description*: This data element returns the memory usage of the given process |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ProcMEMUsage' source='HostAdmin'> <params> <dataparam name='ProcID' value='1'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ProcID"* |
| // - TypeDescriptor - "Process" item |
| // - Description - process id |
| // - Example Value - "1" |
| // |
| |
| // Function: "CPUs" |
| // |
| // *Description*: This iterator lists the CPUs on a given host. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "CPU" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='CPUs' source='HostAdmin'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "CPULoad" |
| // |
| // *Description*: This data element returns the CPULoad of a CPU |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='CPULoad' source='HostAdmin'> <params> <dataparam name='CPU_ID' value='HostNumCPUs'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"CPU_ID"* |
| // - TypeDescriptor - Index in the list of "CPU" items |
| // - Description - Cpu id. Valid values: 0..HostNumCPUs |
| // - Example Value - "HostNumCPUs" |
| // |
| |
| // Function: "HostNumCPUs" |
| // |
| // *Description*: This data element returns the number of CPUs on the host |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='HostNumCPUs' source='HostAdmin'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "HostPhysicalMemory" |
| // |
| // *Description*: This data element returns the physical memory available on the host |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='HostPhysicalMemory' source='HostAdmin'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "HostFreeMemory" |
| // |
| // *Description*: This data element returns the free memory on the host |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='HostFreeMemory' source='HostAdmin'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "HostName" |
| // |
| // *Description*: This data element returns the name of the host |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='HostName' source='HostAdmin'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "IPv4Addr" |
| // |
| // *Description*: This data element returns the IPv4 address of the host, type charsting |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='IPv4Addr' source='HostAdmin'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "IPv6Addr" |
| // |
| // *Description*: This data element returns the IPv6 address of the host, type charsting |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='IPv6Addr' source='HostAdmin'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "HostCPULoad" |
| // |
| // *Description*: This data element returns the CPU load of the host |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='HostCPULoad' source='HostAdmin'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "MinCPULoad" |
| // |
| // *Description*: This data element returns the minimal CPU load of the host, type float |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='MinCPULoad' source='HostAdmin'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "MaxCPULoad" |
| // |
| // *Description*: This data element returns the maximal CPU load of the host, type float |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='MaxCPULoad' source='HostAdmin'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "AvgCPULoad" |
| // |
| // *Description*: This data element returns the average CPU load of the host, type float |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='AvgCPULoad' source='HostAdmin'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "ResetMinMaxAvgCPULoad" |
| // |
| // *Description*: This data element defines a button to reset the min/max/average CPU load of the host |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ResetMinMaxAvgCPULoad' source='HostAdmin'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| } // ~group |
| |
| // Group: "StatHandler" |
| // |
| group StatHandler { |
| |
| // Function: "help" |
| // |
| // *Description*: This data element returns the help information about all dataElements supported |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='help' source='StatHandler'> <params> <dataparam name='Format' value='TEXT'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Format"* |
| // - TypeDescriptor - charstringType |
| // - Description - The format of the output. Valid values: JSON, TEXT. Default: JSON |
| // - Example Value - "TEXT" |
| // |
| |
| // Function: "ResetComponent" |
| // |
| // *Description*: This constant defines the data element for the ResetComponent button |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ResetComponent' source='StatHandler'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "ResetAll" |
| // |
| // *Description*: This constant defines the data element for the ResetAll button |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ResetAll' source='StatHandler'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| } // ~group |
| |
| // Group: "ExecCtrl" |
| // |
| group ExecCtrl { |
| |
| // Function: "help" |
| // |
| // *Description*: This data element returns the help information about all dataElements supported |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='help' source='ExecCtrl'> <params> <dataparam name='Format' value='TEXT'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Format"* |
| // - TypeDescriptor - charstringType |
| // - Description - The format of the output. Valid values: JSON, TEXT. Default: JSON |
| // - Example Value - "TEXT" |
| // |
| |
| // Function: "EntityGroups" |
| // |
| // *Description*: This iterator enlists the entity groups of the whole configuration. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "EntityGroup" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='EntityGroups' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "Scenarios" |
| // |
| // *Description*: This iterator enlists the scenarios of an entity group. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "Scenario" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Scenarios' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| |
| // Function: "TrafficCases" |
| // |
| // *Description*: This iterator enlists the traffic cases of a scenario. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "TrafficCase" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TrafficCases' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "TcStats" |
| // |
| // *Description*: This iterator enlists the TC scope statistics of the given traffic cases. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "Statistic" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcStats' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "TcStat" |
| // |
| // *Description*: This dataElement returns the value of the given TC statistics. |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcStat' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> <dataparam name='Statistic' value='CurrentCPS'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case of an scenario. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| // - *"Statistic"* |
| // - TypeDescriptor - "Statistic" item |
| // - Description - Name of the TC statistics. Should be one item in the list returned by 'TcStats' |
| // - Example Value - "CurrentCPS" |
| // |
| |
| // Function: "TcStatDelta" |
| // |
| // *Description*: This dataElement returns the value of the given TC statistics delta element. |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcStatDelta' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> <dataparam name='Statistic' value='CurrentCPS'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case of an scenario. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| // - *"Statistic"* |
| // - TypeDescriptor - "Statistic" item |
| // - Description - Name of the TC statistics. Should be one item in the list returned by 'TcStats' |
| // - Example Value - "CurrentCPS" |
| // |
| |
| // Function: "FsmStats" |
| // |
| // *Description*: This iterator enlists the TC scope statistics of the FSMs of the given traffic cases. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "FSMStatistic" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='FsmStats' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case of an scenario. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "FSMStat" |
| // |
| // *Description*: This dataElement returns the value of the given FSM statistics of a TC. |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='FSMStat' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> <dataparam name='Statistic' value='NofStarts'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case of an scenario. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| // - *"Statistic"* |
| // - TypeDescriptor - "FSMStatistic" item |
| // - Description - Name of the FSM statistics. Should be one item in the list returned by 'FsmStats' |
| // - Example Value - "NofStarts" |
| // |
| |
| // Function: "TcStart" |
| // |
| // *Description*: This dataElement returns the start checkbox of the traffic case. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcStart' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case of an scenario. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcStop" |
| // |
| // *Description*: This dataElement returns the stop checkbox of the traffic case. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcStop' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case of an scenario. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcStartButton" |
| // |
| // *Description*: This dataElement returns the start button of the traffic case. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcStartButton' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case of an scenario. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcStopButton" |
| // |
| // *Description*: This dataElement returns the stop button of the traffic case. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcStopButton' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case of an scenario. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcResetStats" |
| // |
| // *Description*: This dataElement returns the resetStats button of the traffic case. This button resets the following statistics: Start, Success, Fail, Timeout, Error |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcResetStats' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case of an scenario. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcResetFSMStats" |
| // |
| // *Description*: This dataElement returns the resetStats button of the traffic case. This button resets the FSM statistics |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcResetFSMStats' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case of an scenario. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "AllTcResetStats" |
| // |
| // *Description*: This dataElement returns the resetStats button that can be used to reset the following statistics of traffic cases: Start, Success, Fail, Timeout, Error |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='AllTcResetStats' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "AllTcResetStats" |
| // |
| // *Description*: This dataElement returns the resetFSMStats button that can be used to reset all FSM statistics of every traffic case |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='AllTcResetStats' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "TcStartDelay" |
| // |
| // *Description*: This dataElement returns the start delay of the traffic case. |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcStartDelay' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case of an scenario. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcTargetCPSOrWeight" |
| // |
| // *Description*: This dataElement returns the target CPS for traffic case in non-weighted scenario and the traffic case weight for traffic case in weighted-scenario. |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcTargetCPSOrWeight' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case of an scenario. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcTimeProfile" |
| // |
| // *Description*: This dataElement returns the time profile used for the traffic case. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcTimeProfile' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case of an scenario. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcHasTimeProfile" |
| // |
| // *Description*: This dataElement returns whether the traffic case can have a TimeProfile. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcHasTimeProfile' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case of an scenario. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcRegulator" |
| // |
| // *Description*: This dataElement returns the regulator used for the traffic case CPS. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcRegulator' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case of an scenario. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcGroupFinishStatus" |
| // |
| // *Description*: This dataElement returns the traffic case group finish status LED. |
| // |
| // *ValueType*: statusLEDType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcGroupFinishStatus' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case of an scenario. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcStatus" |
| // |
| // *Description*: This dataElement returns the traffic case status LED. |
| // |
| // *ValueType*: statusLEDType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcStatus' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case of an scenario. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcExecTime" |
| // |
| // *Description*: This dataElement returns the execution time of the traffic case. |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcExecTime' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case of an scenario. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcGoS" |
| // |
| // *Description*: This dataElement returns the GoS of the traffic case. |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcGoS' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case of an scenario. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcSingleShotEntityIdx" |
| // |
| // *Description*: This dataElement returns the index of the entity for which the single shot traffic should be started for the given traffic case. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcSingleShotEntityIdx' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case of an scenario. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcSingleShotEnableLog" |
| // |
| // *Description*: This dataElement returns the enable log checkbox for the single shot for the given traffic case. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcSingleShotEnableLog' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case of an scenario. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcSingleShotStart" |
| // |
| // *Description*: This dataElement returns the start single shot button for the given traffic case. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcSingleShotStart' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case of an scenario. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcGrpFinishStatus" |
| // |
| // *Description*: This dataElement returns the traffic case group-finish status LED. |
| // |
| // *ValueType*: statusLEDType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcGrpFinishStatus' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> <dataparam name='Condition' value='Starts'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case of an scenario. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| // - *"Condition"* |
| // - TypeDescriptor - charstringType |
| // - Description - Specifies a group finish condition of a traffic case. Valid values: "FinTraffic", "RangeLoops", "Starts", "Success", "Fail", "Timeout", "Error", "ExecTime" |
| // - Example Value - "Starts" |
| // |
| |
| // Function: "ScIsWeighted" |
| // |
| // *Description*: This dataElement returns "Decl" if the scenario is non-weighted, "Weighted" if the scenario is weighted. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScIsWeighted' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScStatus" |
| // |
| // *Description*: This dataElement returns the status of the scenario. |
| // |
| // *ValueType*: statusLEDType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScStatus' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScStart" |
| // |
| // *Description*: This dataElement returns the start checkbox of the scenario. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScStart' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScStop" |
| // |
| // *Description*: This dataElement returns the stop checkbox of the scenario. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScStop' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScCPS" |
| // |
| // *Description*: This dataElement returns the scenario CPS of the weighted scenario. |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScCPS' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScTargetCPS" |
| // |
| // *Description*: This dataElement returns the target CPS of the weighted scenario. |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScTargetCPS' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScRegulatorName" |
| // |
| // *Description*: This dataElement returns the name of regulator which regulates the target CPS of the weighted scenario. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScRegulatorName' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScGrpCurrentPhase" |
| // |
| // *Description*: This dataElement returns the current phase of the scenario that is in a scenario group. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScGrpCurrentPhase' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScGrpMode" |
| // |
| // *Description*: This dataElement returns the scenario group mode of the scenario that is in a scenario group. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScGrpMode' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScGrpStatus" |
| // |
| // *Description*: This dataElement returns the scenario group status LED of the scenario that is in a scenario group. |
| // |
| // *ValueType*: statusLEDType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScGrpStatus' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScGrpStart" |
| // |
| // *Description*: This dataElement returns the scenario group start checkbox of the scenario that is in a scenario group. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScGrpStart' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScGrpTerminate" |
| // |
| // *Description*: This dataElement returns the scenario group terminate checkbox of the scenario that is in a scenario group. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScGrpTerminate' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScGrpReset" |
| // |
| // *Description*: This dataElement returns the scenario group reset checkbox of the scenario that is in a scenario group. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScGrpReset' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScGrpScStatus" |
| // |
| // *Description*: This dataElement returns the scenario group-status LED. |
| // |
| // *ValueType*: statusLEDType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScGrpScStatus' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScStartButton" |
| // |
| // *Description*: This dataElement returns the scenario start button. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScStartButton' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScStopButton" |
| // |
| // *Description*: This dataElement returns the scenario stop button. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScStopButton' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScReset" |
| // |
| // *Description*: This dataElement returns the scenario reset button. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScReset' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScInstanceName" |
| // |
| // *Description*: This dataElement returns the instance name of the scenario. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScInstanceName' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScPhaseListName" |
| // |
| // *Description*: This dataElement returns the name of the phase-list if the scenario belongs to a scenario group. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScPhaseListName' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScScGrpName" |
| // |
| // *Description*: This dataElement returns the name of the scenario group to which the scenario belongs to. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScScGrpName' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "CurrentCPS" |
| // |
| // *Description*: This dataElement returns the value of the given Current CPS statistics for the scenario. |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='CurrentCPS' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "IsWeightedSc" |
| // |
| // *Description*: This condition returns true if the given scenario is weighted. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='IsWeightedSc' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "IsInScGroup" |
| // |
| // *Description*: This condition returns true if the given scenario is in a scenario group. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='IsInScGroup' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "Phases" |
| // |
| // *Description*: This iterator enlists the phases of a scenario. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "Phase" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Phases' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "NofDeployedLGens" |
| // |
| // *Description*: This dataElement returns number of LGens the given scenario instance is distributed on. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='NofDeployedLGens' source='ExecCtrl'> <params> <dataparam name='ScenarioInstance' value='EGrpName.ScName'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ScenarioInstance"* |
| // - TypeDescriptor - "ScenarioInstance" item |
| // - Description - Name of the scenario instance. |
| // - Example Value - "EGrpName.ScName" |
| // |
| |
| // Function: "TcRegulator" |
| // |
| // *Description*: This dataElement returns the regulator used for the weighted scenario CPS. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcRegulator' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScGroupOfSc" |
| // |
| // *Description*: This dataElement returns the scenario group of the given scenario. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScGroupOfSc' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "Clients" |
| // |
| // *Description*: This iterator enlists the ExecCtrl clients (usually load generators) that the entity group is distributed on. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "LGen" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Clients' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| |
| // Function: "EGrpType" |
| // |
| // *Description*: This dataElement returns the Entity Type of an Entity Group. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='EGrpType' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| |
| // Function: "EGrpSize" |
| // |
| // *Description*: This dataElement returns the size of an Entity Group. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='EGrpSize' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| |
| // Function: "NofDeployedLGens" |
| // |
| // *Description*: This dataElement returns number of LGens the given entity group is distributed on. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='NofDeployedLGens' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| |
| // Function: "NofActiveEntities" |
| // |
| // *Description*: This dataElement returns number active entities of the given entity group. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='NofActiveEntities' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| |
| // Function: "EGrpOffset" |
| // |
| // *Description*: This dataElement returns the offset of the first entity in the entity group. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='EGrpOffset' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| |
| // Function: "EGrpLGenPool" |
| // |
| // *Description*: This dataElement returns the name of the LGen pool on which the entity group is distributed on. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='EGrpLGenPool' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| |
| // Function: "Clients" |
| // |
| // *Description*: This iterator enlists all the ExecCtrl clients (usually load generators). |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "LGen" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Clients' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "EntityGroups" |
| // |
| // *Description*: This iterator enlists the entity groups deployed onto the specified client PTC. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "EntityGroup" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='EntityGroups' source='ExecCtrl'> <params> <dataparam name='LGen' value='LGen01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"LGen"* |
| // - TypeDescriptor - "LGen" item |
| // - Description - Name of the ExecCtrl client load generator PTC. Should be one item in the list returned by 'Clients' |
| // - Example Value - "LGen01" |
| // |
| |
| // Function: "ScStatusForLGen" |
| // |
| // *Description*: This dataElement returns the status of the scenario on the given LGen. |
| // |
| // *ValueType*: statusLEDType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScStatusForLGen' source='ExecCtrl'> <params> <dataparam name='LGen' value='LGen01'/> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"LGen"* |
| // - TypeDescriptor - "LGen" item |
| // - Description - Name of the ExecCtrl client load generator PTC. Should be one item in the list returned by 'Clients' |
| // - Example Value - "LGen01" |
| // |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "EGrpSizeForLGen" |
| // |
| // *Description*: This dataElement returns the size of that part of the entity group which is allocated on the given LGen. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='EGrpSizeForLGen' source='ExecCtrl'> <params> <dataparam name='LGen' value='LGen01'/> <dataparam name='EntityGroup' value='EGrp01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"LGen"* |
| // - TypeDescriptor - "LGen" item |
| // - Description - Name of the ExecCtrl client load generator PTC. Should be one item in the list returned by 'Clients' |
| // - Example Value - "LGen01" |
| // |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| |
| // Function: "EGrpOffsetForLGen" |
| // |
| // *Description*: This dataElement returns the offset of the first entity of the entity group which is allocated on the given LGen. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='EGrpOffsetForLGen' source='ExecCtrl'> <params> <dataparam name='LGen' value='LGen01'/> <dataparam name='EntityGroup' value='EGrp01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"LGen"* |
| // - TypeDescriptor - "LGen" item |
| // - Description - Name of the ExecCtrl client load generator PTC. Should be one item in the list returned by 'Clients' |
| // - Example Value - "LGen01" |
| // |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| |
| // Function: "EntityTypesForLGen" |
| // |
| // *Description*: This iterator enlists the supported entity types of the load generator clients. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "EntityType" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='EntityTypesForLGen' source='ExecCtrl'> <params> <dataparam name='LGen' value='LGen01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"LGen"* |
| // - TypeDescriptor - "LGen" item |
| // - Description - Name of the ExecCtrl client load generator PTC. Should be one item in the list returned by 'Clients' |
| // - Example Value - "LGen01" |
| // |
| |
| // Function: "NofMaxAvailEntitiesForLGen" |
| // |
| // *Description*: This dataElement returns the number of max available entities for an LGen for a given entity type. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='NofMaxAvailEntitiesForLGen' source='ExecCtrl'> <params> <dataparam name='LGen' value='LGen01'/> <dataparam name='EntityType' value='ExecCtrlDefaultETypeName'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"LGen"* |
| // - TypeDescriptor - "LGen" item |
| // - Description - Name of the ExecCtrl client load generator PTC. Should be one item in the list returned by 'Clients' |
| // - Example Value - "LGen01" |
| // |
| // - *"EntityType"* |
| // - TypeDescriptor - "EntityType" item |
| // - Description - Name of the entity type. Should be one item in the list returned by 'EntityTypesForLGen' |
| // - Example Value - "ExecCtrlDefaultETypeName" |
| // |
| |
| // Function: "NofCurrentAvailEntitiesForLGen" |
| // |
| // *Description*: This dataElement returns the number of current available entities for an LGen for a given entity type. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='NofCurrentAvailEntitiesForLGen' source='ExecCtrl'> <params> <dataparam name='LGen' value='LGen01'/> <dataparam name='EntityType' value='ExecCtrlDefaultETypeName'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"LGen"* |
| // - TypeDescriptor - "LGen" item |
| // - Description - Name of the ExecCtrl client load generator PTC. Should be one item in the list returned by 'Clients' |
| // - Example Value - "LGen01" |
| // |
| // - *"EntityType"* |
| // - TypeDescriptor - "EntityType" item |
| // - Description - Name of the entity type. Should be one item in the list returned by 'EntityTypesForLGen' |
| // - Example Value - "ExecCtrlDefaultETypeName" |
| // |
| |
| // Function: "EGrpsOnClients" |
| // |
| // *Description*: This iterator enlists all the EntityGroups on all Clients. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "EGrpOnClient" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='EGrpsOnClients' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "EntityGroupOfEGrpOnClient" |
| // |
| // *Description*: This dataElement returns the entity group for the EGrpOnClient item. |
| // |
| // *ValueType*: charstringType |
| // |
| // *TypeDescriptor*: "EntityGroup" item |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='EntityGroupOfEGrpOnClient' source='ExecCtrl'> <params> <dataparam name='EGrpOnClient' value='0.0'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EGrpOnClient"* |
| // - TypeDescriptor - "EGrpOnClient" item |
| // - Description - A pair of ExecCtrl EntityGroup and client load generator PTC. Should be one item in the list returned by 'EGrpsOnClients' |
| // - Example Value - "0.0" |
| // |
| |
| // Function: "ClientOfEGrpOnClient" |
| // |
| // *Description*: This dataElement returns the client name for the EGrpOnClient item. |
| // |
| // *ValueType*: charstringType |
| // |
| // *TypeDescriptor*: "LGen" item |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ClientOfEGrpOnClient' source='ExecCtrl'> <params> <dataparam name='EGrpOnClient' value='0.0'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EGrpOnClient"* |
| // - TypeDescriptor - "EGrpOnClient" item |
| // - Description - A pair of ExecCtrl EntityGroup and client load generator PTC. Should be one item in the list returned by 'EGrpsOnClients' |
| // - Example Value - "0.0" |
| // |
| |
| // Function: "EntityTypesForLGenOnClients" |
| // |
| // *Description*: This iterator enlists all the EntityTypes on all Clients. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "EntityTypeForLGenOnClient" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='EntityTypesForLGenOnClients' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "EntityTypeOfEntityTypesForLGenOnClients" |
| // |
| // *Description*: This dataElement returns the entity type for the EntityTypesForLGenOnClients item. |
| // |
| // *ValueType*: charstringType |
| // |
| // *TypeDescriptor*: "EntityType" item |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='EntityTypeOfEntityTypesForLGenOnClients' source='ExecCtrl'> <params> <dataparam name='EntityTypeForLGenOnClient' value='0.0'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityTypeForLGenOnClient"* |
| // - TypeDescriptor - "EntityTypeForLGenOnClient" item |
| // - Description - A pair of ExecCtrl entity type and client load generator PTC. Should be one item in the list returned by 'EntityTypesForLGenOnClients' |
| // - Example Value - "0.0" |
| // |
| |
| // Function: "ClientOfEntityTypesForLGenOnClients" |
| // |
| // *Description*: This dataElement returns the client name for the EntityTypesForLGenOnClients item. |
| // |
| // *ValueType*: charstringType |
| // |
| // *TypeDescriptor*: "LGen" item |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ClientOfEntityTypesForLGenOnClients' source='ExecCtrl'> <params> <dataparam name='EntityTypeForLGenOnClient' value='0.0'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityTypeForLGenOnClient"* |
| // - TypeDescriptor - "EntityTypeForLGenOnClient" item |
| // - Description - A pair of ExecCtrl entity type and client load generator PTC. Should be one item in the list returned by 'EntityTypesForLGenOnClients' |
| // - Example Value - "0.0" |
| // |
| |
| // Function: "ScenariosOnClients" |
| // |
| // *Description*: This iterator enlists all the Scenarios on all EntityGroups of all Clients. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "ScenarioOnClient" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScenariosOnClients' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "ClientOfScenariosOnClients" |
| // |
| // *Description*: This dataElement returns the client name for the ScenariosOnClients item. |
| // |
| // *ValueType*: charstringType |
| // |
| // *TypeDescriptor*: "LGen" item |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ClientOfScenariosOnClients' source='ExecCtrl'> <params> <dataparam name='ScenarioOnClient' value='0.0.0'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ScenarioOnClient"* |
| // - TypeDescriptor - "ScenarioOnClient" item |
| // - Description - A triple of ExecCtrl Scenario, EntityGroup and client load generator PTC. Should be one item in the list returned by 'ScenariosOnClients' |
| // - Example Value - "0.0.0" |
| // |
| |
| // Function: "EntityGroupOfScenariosOnClients" |
| // |
| // *Description*: This dataElement returns the EntityGroup for the ScenariosOnClients item. |
| // |
| // *ValueType*: charstringType |
| // |
| // *TypeDescriptor*: "EntityGroup" item |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='EntityGroupOfScenariosOnClients' source='ExecCtrl'> <params> <dataparam name='ScenarioOnClient' value='0.0.0'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ScenarioOnClient"* |
| // - TypeDescriptor - "ScenarioOnClient" item |
| // - Description - A triple of ExecCtrl Scenario, EntityGroup and client load generator PTC. Should be one item in the list returned by 'ScenariosOnClients' |
| // - Example Value - "0.0.0" |
| // |
| |
| // Function: "ScenarioOfScenariosOnClients" |
| // |
| // *Description*: This dataElement returns the Scenario for the ScenariosOnClients item. |
| // |
| // *ValueType*: charstringType |
| // |
| // *TypeDescriptor*: "Scenario" item |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScenarioOfScenariosOnClients' source='ExecCtrl'> <params> <dataparam name='ScenarioOnClient' value='0.0.0'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ScenarioOnClient"* |
| // - TypeDescriptor - "ScenarioOnClient" item |
| // - Description - A triple of ExecCtrl Scenario, EntityGroup and client load generator PTC. Should be one item in the list returned by 'ScenariosOnClients' |
| // - Example Value - "0.0.0" |
| // |
| |
| // Function: "TrafficCasesOfScenarios" |
| // |
| // *Description*: This iterator enlists all the TrafficCases of all Scenarios. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "TrafficCaseOfScenario" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TrafficCasesOfScenarios' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "ScenarioOfTrafficCasesOfScenarios" |
| // |
| // *Description*: This dataElement returns the ScenarioInstance for the TrafficCasesOfScenarios item. |
| // |
| // *ValueType*: charstringType |
| // |
| // *TypeDescriptor*: "ScenarioInstance" item |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScenarioOfTrafficCasesOfScenarios' source='ExecCtrl'> <params> <dataparam name='TrafficCaseOfScenario' value='0.0'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"TrafficCaseOfScenario"* |
| // - TypeDescriptor - "TrafficCaseOfScenario" item |
| // - Description - A pair of ExecCtrl ScenarioInstance and TrafficCase. Should be one item in the list returned by 'TrafficCasesOfScenarios' |
| // - Example Value - "0.0" |
| // |
| |
| // Function: "TrafficCaseOfTrafficCasesOfScenarios" |
| // |
| // *Description*: This dataElement returns the TrafficCase for the TrafficCasesOfScenarios item. |
| // |
| // *ValueType*: charstringType |
| // |
| // *TypeDescriptor*: "TrafficCase" item |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TrafficCaseOfTrafficCasesOfScenarios' source='ExecCtrl'> <params> <dataparam name='TrafficCaseOfScenario' value='0.0'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"TrafficCaseOfScenario"* |
| // - TypeDescriptor - "TrafficCaseOfScenario" item |
| // - Description - A pair of ExecCtrl ScenarioInstance and TrafficCase. Should be one item in the list returned by 'TrafficCasesOfScenarios' |
| // - Example Value - "0.0" |
| // |
| |
| // Function: "FSMStatsOfTrafficCases" |
| // |
| // *Description*: This iterator enlists all available FSMStats of all TrafficCases of all Scenarios. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "FSMStatOfTrafficCases" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='FSMStatsOfTrafficCases' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "ScenarioOfFSMStatsOfTrafficCases" |
| // |
| // *Description*: This dataElement returns the ScenarioInstance for the FSMStatsOfTrafficCases item. |
| // |
| // *ValueType*: charstringType |
| // |
| // *TypeDescriptor*: "ScenarioInstance" item |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScenarioOfFSMStatsOfTrafficCases' source='ExecCtrl'> <params> <dataparam name='FSMStatsOfTrafficCase' value='0.0.0.0'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"FSMStatsOfTrafficCase"* |
| // - TypeDescriptor - "FSMStatOfTrafficCases" item |
| // - Description - A concatenated list of ExecCtrl ScenarioInstance, TrafficCase, FSMStat id and index. Should be one item in the list returned by 'FSMStatsOfTrafficCases' |
| // - Example Value - "0.0.0.0" |
| // |
| |
| // Function: "TrafficCaseOfFSMStatsOfTrafficCases" |
| // |
| // *Description*: This dataElement returns the TrafficCase for the TrafficCasesOfScenarios item. |
| // |
| // *ValueType*: charstringType |
| // |
| // *TypeDescriptor*: "TrafficCase" item |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TrafficCaseOfFSMStatsOfTrafficCases' source='ExecCtrl'> <params> <dataparam name='FSMStatsOfTrafficCase' value='0.0.0.0'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"FSMStatsOfTrafficCase"* |
| // - TypeDescriptor - "FSMStatOfTrafficCases" item |
| // - Description - A concatenated list of ExecCtrl ScenarioInstance, TrafficCase, FSMStat id and index. Should be one item in the list returned by 'FSMStatsOfTrafficCases' |
| // - Example Value - "0.0.0.0" |
| // |
| |
| // Function: "FSMStatNameOfFSMStatsOfTrafficCases" |
| // |
| // *Description*: This dataElement returns the FSMStatName for the TrafficCasesOfScenarios item. |
| // |
| // *ValueType*: charstringType |
| // |
| // *TypeDescriptor*: "FSMStatistic" item |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='FSMStatNameOfFSMStatsOfTrafficCases' source='ExecCtrl'> <params> <dataparam name='FSMStatsOfTrafficCase' value='0.0.0.0'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"FSMStatsOfTrafficCase"* |
| // - TypeDescriptor - "FSMStatOfTrafficCases" item |
| // - Description - A concatenated list of ExecCtrl ScenarioInstance, TrafficCase, FSMStat id and index. Should be one item in the list returned by 'FSMStatsOfTrafficCases' |
| // - Example Value - "0.0.0.0" |
| // |
| |
| // Function: "ScenariosOfScenarioGroupsWithPhaseList" |
| // |
| // *Description*: This iterator enlists all Scenarios of the ScenarioGroups with the given PhaseList. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "ScenarioOfScenarioGroup" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScenariosOfScenarioGroupsWithPhaseList' source='ExecCtrl'> <params> <dataparam name='PhaseList' value='BasicPhases'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"PhaseList"* |
| // - TypeDescriptor - "PhaseList" item |
| // - Description - Name of the phaselist. Should be one item in the list returned by 'PhaseLists' |
| // - Example Value - "BasicPhases" |
| // |
| |
| // Function: "ScenarioOfScenariosOfScenarioGroupsWithPhaseList" |
| // |
| // *Description*: This dataElement returns the ScenarioInstance for the ScenariosOfScenarioGroupsWithPhaseList item. |
| // |
| // *ValueType*: charstringType |
| // |
| // *TypeDescriptor*: "ScenarioInstance" item |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScenarioOfScenariosOfScenarioGroupsWithPhaseList' source='ExecCtrl'> <params> <dataparam name='ScenarioOfScenarioGroup' value='0.0'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ScenarioOfScenarioGroup"* |
| // - TypeDescriptor - "ScenarioOfScenarioGroup" item |
| // - Description - A pair of ExecCtrl ScenarioInstance and ScenarioGroup. Should be one item in the list returned by 'ScenariosOfScenarioGroupsWithPhaseList' |
| // - Example Value - "0.0" |
| // |
| |
| // Function: "ScenarioGroupOfScenariosOfScenarioGroupsWithPhaseList" |
| // |
| // *Description*: This dataElement returns the ScenarioGroup for the ScenariosOfScenarioGroupsWithPhaseList item. |
| // |
| // *ValueType*: charstringType |
| // |
| // *TypeDescriptor*: "ScenarioGroup" item |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScenarioGroupOfScenariosOfScenarioGroupsWithPhaseList' source='ExecCtrl'> <params> <dataparam name='ScenarioOfScenarioGroup' value='0.0'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ScenarioOfScenarioGroup"* |
| // - TypeDescriptor - "ScenarioOfScenarioGroup" item |
| // - Description - A pair of ExecCtrl ScenarioInstance and ScenarioGroup. Should be one item in the list returned by 'ScenariosOfScenarioGroupsWithPhaseList' |
| // - Example Value - "0.0" |
| // |
| |
| // Function: "Regulators" |
| // |
| // *Description*: This iterator enlists the regulators appearing in the configuration. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "RegulatorName" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Regulators' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "RegulatorTotalValue" |
| // |
| // *Description*: This dataElement returns total value of the regulator. This total value is devided among the regulated items regulated by the regulator according to their weights. |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='RegulatorTotalValue' source='ExecCtrl'> <params> <dataparam name='RegulatorName' value='LoadRegulator'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"RegulatorName"* |
| // - TypeDescriptor - "RegulatorName" item |
| // - Description - Name of the regulator. Should be one item in the list returned by 'Regulators' |
| // - Example Value - "LoadRegulator" |
| // |
| |
| // Function: "RegulatorTargetLoad" |
| // |
| // *Description*: This dataElement returns target load of the regulator. The regulator adapts the total value so that the curret load reach this value. |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='RegulatorTargetLoad' source='ExecCtrl'> <params> <dataparam name='RegulatorName' value='LoadRegulator'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"RegulatorName"* |
| // - TypeDescriptor - "RegulatorName" item |
| // - Description - Name of the regulator. Should be one item in the list returned by 'Regulators' |
| // - Example Value - "LoadRegulator" |
| // |
| |
| // Function: "RegulatorCurrentLoad" |
| // |
| // *Description*: This dataElement returns current load of the regulator. |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='RegulatorCurrentLoad' source='ExecCtrl'> <params> <dataparam name='RegulatorName' value='LoadRegulator'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"RegulatorName"* |
| // - TypeDescriptor - "RegulatorName" item |
| // - Description - Name of the regulator. Should be one item in the list returned by 'Regulators' |
| // - Example Value - "LoadRegulator" |
| // |
| |
| // Function: "RegulatorStatus" |
| // |
| // *Description*: This dataElement returns status LED of the regulator. |
| // |
| // *ValueType*: statusLEDType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='RegulatorStatus' source='ExecCtrl'> <params> <dataparam name='RegulatorName' value='LoadRegulator'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"RegulatorName"* |
| // - TypeDescriptor - "RegulatorName" item |
| // - Description - Name of the regulator. Should be one item in the list returned by 'Regulators' |
| // - Example Value - "LoadRegulator" |
| // |
| |
| // Function: "ScenarioGroups" |
| // |
| // *Description*: This iterator enlists the scenario groups of a configuration. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "ScenarioGroup" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScenarioGroups' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "Scenarios" |
| // |
| // *Description*: This iterator enlists the scenarios of a scenario group. Returns the scenario instance name |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "ScenarioInstance" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Scenarios' source='ExecCtrl'> <params> <dataparam name='ScenarioGroup' value='ScGrp'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ScenarioGroup"* |
| // - TypeDescriptor - "ScenarioGroup" item |
| // - Description - Name of the scenario group. Should be one item in the list returned by 'ScenarioGroups' |
| // - Example Value - "ScGrp" |
| // |
| |
| // Function: "TrafficCases" |
| // |
| // *Description*: This iterator enlists the traffic cases of a scenario instance. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "TrafficCase" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TrafficCases' source='ExecCtrl'> <params> <dataparam name='ScenarioInstance' value='EGrpName.ScName'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ScenarioInstance"* |
| // - TypeDescriptor - "ScenarioInstance" item |
| // - Description - Name of the scenario instance. |
| // - Example Value - "EGrpName.ScName" |
| // |
| |
| // Function: "ScGrpScStatus" |
| // |
| // *Description*: This dataElement returns the scenario group-status LED inside the scenario group. |
| // |
| // *ValueType*: statusLEDType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScGrpScStatus' source='ExecCtrl'> <params> <dataparam name='ScenarioGroup' value='ScGrp'/> <dataparam name='ScenarioInstance' value='EGrpName.ScName'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ScenarioGroup"* |
| // - TypeDescriptor - "ScenarioGroup" item |
| // - Description - Name of the scenario group. Should be one item in the list returned by 'ScenarioGroups' |
| // - Example Value - "ScGrp" |
| // |
| // - *"ScenarioInstance"* |
| // - TypeDescriptor - "ScenarioInstance" item |
| // - Description - Name of the scenario instance. |
| // - Example Value - "EGrpName.ScName" |
| // |
| |
| // Function: "EntityGroupOfScenarioInstance" |
| // |
| // *Description*: This dataElement returns the entity group name for the scenario instance. |
| // |
| // *ValueType*: charstringType |
| // |
| // *TypeDescriptor*: "EntityGroup" item |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='EntityGroupOfScenarioInstance' source='ExecCtrl'> <params> <dataparam name='ScenarioInstance' value='EGrpName.ScName'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ScenarioInstance"* |
| // - TypeDescriptor - "ScenarioInstance" item |
| // - Description - Name of the scenario instance. |
| // - Example Value - "EGrpName.ScName" |
| // |
| |
| // Function: "ScenarioTypeNameOfScenarioInstance" |
| // |
| // *Description*: This dataElement returns the scenario type name for the scenario instance. |
| // |
| // *ValueType*: charstringType |
| // |
| // *TypeDescriptor*: "Scenario" item |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScenarioTypeNameOfScenarioInstance' source='ExecCtrl'> <params> <dataparam name='ScenarioInstance' value='EGrpName.ScName'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ScenarioInstance"* |
| // - TypeDescriptor - "ScenarioInstance" item |
| // - Description - Name of the scenario instance. |
| // - Example Value - "EGrpName.ScName" |
| // |
| |
| // Function: "ScGrpCurrentPhase" |
| // |
| // *Description*: This dataElement returns the current phase of the scenario group. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScGrpCurrentPhase' source='ExecCtrl'> <params> <dataparam name='ScenarioGroup' value='ScGrp'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ScenarioGroup"* |
| // - TypeDescriptor - "ScenarioGroup" item |
| // - Description - Name of the scenario group. Should be one item in the list returned by 'ScenarioGroups' |
| // - Example Value - "ScGrp" |
| // |
| |
| // Function: "ScGrpMode" |
| // |
| // *Description*: This dataElement returns the scenario group mode. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScGrpMode' source='ExecCtrl'> <params> <dataparam name='ScenarioGroup' value='ScGrp'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ScenarioGroup"* |
| // - TypeDescriptor - "ScenarioGroup" item |
| // - Description - Name of the scenario group. Should be one item in the list returned by 'ScenarioGroups' |
| // - Example Value - "ScGrp" |
| // |
| |
| // Function: "ScGrpStatus" |
| // |
| // *Description*: This dataElement returns the scenario group status LED. |
| // |
| // *ValueType*: statusLEDType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScGrpStatus' source='ExecCtrl'> <params> <dataparam name='ScenarioGroup' value='ScGrp'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ScenarioGroup"* |
| // - TypeDescriptor - "ScenarioGroup" item |
| // - Description - Name of the scenario group. Should be one item in the list returned by 'ScenarioGroups' |
| // - Example Value - "ScGrp" |
| // |
| |
| // Function: "ScGrpStart" |
| // |
| // *Description*: This dataElement returns the scenario group start checkbox. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScGrpStart' source='ExecCtrl'> <params> <dataparam name='ScenarioGroup' value='ScGrp'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ScenarioGroup"* |
| // - TypeDescriptor - "ScenarioGroup" item |
| // - Description - Name of the scenario group. Should be one item in the list returned by 'ScenarioGroups' |
| // - Example Value - "ScGrp" |
| // |
| |
| // Function: "ScGrpReset" |
| // |
| // *Description*: This dataElement returns the scenario group reset checkbox. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScGrpReset' source='ExecCtrl'> <params> <dataparam name='ScenarioGroup' value='ScGrp'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ScenarioGroup"* |
| // - TypeDescriptor - "ScenarioGroup" item |
| // - Description - Name of the scenario group. Should be one item in the list returned by 'ScenarioGroups' |
| // - Example Value - "ScGrp" |
| // |
| |
| // Function: "RegulatedItems" |
| // |
| // *Description*: This iterator enlists the regulated items in the configuration. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "RegulatedItemId" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='RegulatedItems' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "RegulatedItemType" |
| // |
| // *Description*: This dataElement returns the regulated item type ("Scenario CPS" or "TrafficCase CPS")for the regulated item. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='RegulatedItemType' source='ExecCtrl'> <params> <dataparam name='RegulatedItemId' value='CpsToReach'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"RegulatedItemId"* |
| // - TypeDescriptor - "RegulatedItemId" item |
| // - Description - Id of the regulated item. Should be one item in the list returned by 'RegulatedItems' |
| // - Example Value - "CpsToReach" |
| // |
| |
| // Function: "RegulatedItemName" |
| // |
| // *Description*: This dataElement returns the regulated item name of the regulated item. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='RegulatedItemName' source='ExecCtrl'> <params> <dataparam name='RegulatedItemId' value='CpsToReach'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"RegulatedItemId"* |
| // - TypeDescriptor - "RegulatedItemId" item |
| // - Description - Id of the regulated item. Should be one item in the list returned by 'RegulatedItems' |
| // - Example Value - "CpsToReach" |
| // |
| |
| // Function: "RegulatorName" |
| // |
| // *Description*: This dataElement returns the regulator name that regulates the regulated item. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='RegulatorName' source='ExecCtrl'> <params> <dataparam name='RegulatedItemId' value='CpsToReach'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"RegulatedItemId"* |
| // - TypeDescriptor - "RegulatedItemId" item |
| // - Description - Id of the regulated item. Should be one item in the list returned by 'RegulatedItems' |
| // - Example Value - "CpsToReach" |
| // |
| |
| // Function: "RegulatedItemWeight" |
| // |
| // *Description*: This dataElement returns the weight of the regulated item. |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='RegulatedItemWeight' source='ExecCtrl'> <params> <dataparam name='RegulatedItemId' value='CpsToReach'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"RegulatedItemId"* |
| // - TypeDescriptor - "RegulatedItemId" item |
| // - Description - Id of the regulated item. Should be one item in the list returned by 'RegulatedItems' |
| // - Example Value - "CpsToReach" |
| // |
| |
| // Function: "RegulatedItemEnabled" |
| // |
| // *Description*: This dataElement returns the checkbox to enable the regulation of the regulated item. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='RegulatedItemEnabled' source='ExecCtrl'> <params> <dataparam name='RegulatedItemId' value='CpsToReach'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"RegulatedItemId"* |
| // - TypeDescriptor - "RegulatedItemId" item |
| // - Description - Id of the regulated item. Should be one item in the list returned by 'RegulatedItems' |
| // - Example Value - "CpsToReach" |
| // |
| |
| // Function: "Phases" |
| // |
| // *Description*: This iterator enlists the phases. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "Phase" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Phases' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "ScGrpEnablePhase" |
| // |
| // *Description*: This dataElement returns the enable phase checkbox for the given scenario group. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScGrpEnablePhase' source='ExecCtrl'> <params> <dataparam name='ScenarioGroup' value='ScGrp'/> <dataparam name='Phase' value='loadgen'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ScenarioGroup"* |
| // - TypeDescriptor - "ScenarioGroup" item |
| // - Description - Name of the scenario group. Should be one item in the list returned by 'ScenarioGroups' |
| // - Example Value - "ScGrp" |
| // |
| // - *"Phase"* |
| // - TypeDescriptor - "Phase" item |
| // - Description - Name of the phase. Should be one item in the list returned by 'Phases' |
| // - Example Value - "loadgen" |
| // |
| |
| // Function: "ScGrpScEnablePhase" |
| // |
| // *Description*: This dataElement returns the enable phase checkbox for the given phase for the given scenario in a scenario group. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScGrpScEnablePhase' source='ExecCtrl'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='Phase' value='loadgen'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario of an entity group. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"Phase"* |
| // - TypeDescriptor - "Phase" item |
| // - Description - Name of the phase. Should be one item in the list returned by 'Phases' |
| // - Example Value - "loadgen" |
| // |
| |
| // Function: "ScGrpScEnablePhase" |
| // |
| // *Description*: This dataElement returns the enable phase checkbox for the given phase for the given scenario instance in a scenario group. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScGrpScEnablePhase' source='ExecCtrl'> <params> <dataparam name='ScenarioInstance' value='EGrpName.ScName'/> <dataparam name='Phase' value='loadgen'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ScenarioInstance"* |
| // - TypeDescriptor - "ScenarioInstance" item |
| // - Description - Name of the scenario instance. |
| // - Example Value - "EGrpName.ScName" |
| // |
| // - *"Phase"* |
| // - TypeDescriptor - "Phase" item |
| // - Description - Name of the phase. Should be one item in the list returned by 'Phases' |
| // - Example Value - "loadgen" |
| // |
| |
| // Function: "PhaseLists" |
| // |
| // *Description*: This iterator enlists the phaselists. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "PhaseList" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='PhaseLists' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "Phases" |
| // |
| // *Description*: This iterator enlists the phases of phaselist. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "Phase" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Phases' source='ExecCtrl'> <params> <dataparam name='PhaseList' value='BasicPhases'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"PhaseList"* |
| // - TypeDescriptor - "PhaseList" item |
| // - Description - Name of the phaselist. Should be one item in the list returned by 'PhaseLists' |
| // - Example Value - "BasicPhases" |
| // |
| |
| // Function: "Phases" |
| // |
| // *Description*: This iterator enlists the phases of a scenario group. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "Phase" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Phases' source='ExecCtrl'> <params> <dataparam name='ScenarioGroup' value='ScGrp'/> <dataparam name='PhaseList' value='BasicPhases'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"ScenarioGroup"* |
| // - TypeDescriptor - "ScenarioGroup" item |
| // - Description - Name of the scenario group. Should be one item in the list returned by 'ScenarioGroups' |
| // - Example Value - "ScGrp" |
| // |
| // - *"PhaseList"* |
| // - TypeDescriptor - "PhaseList" item |
| // - Description - Name of the phaselist. Should be one item in the list returned by 'PhaseLists' |
| // - Example Value - "BasicPhases" |
| // |
| |
| // Function: "ScenarioGroups" |
| // |
| // *Description*: This iterator enlists the scenario groups of a configuration for a given phase list. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "ScenarioGroup" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScenarioGroups' source='ExecCtrl'> <params> <dataparam name='PhaseList' value='BasicPhases'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"PhaseList"* |
| // - TypeDescriptor - "PhaseList" item |
| // - Description - Name of the phaselist. Should be one item in the list returned by 'PhaseLists' |
| // - Example Value - "BasicPhases" |
| // |
| |
| // Function: "PhaseListEnablePhase" |
| // |
| // *Description*: This dataElement returns the enable phase checkbox for the given Phase in given PhaseList. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='PhaseListEnablePhase' source='ExecCtrl'> <params> <dataparam name='PhaseList' value='BasicPhases'/> <dataparam name='Phase' value='loadgen'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"PhaseList"* |
| // - TypeDescriptor - "PhaseList" item |
| // - Description - Name of the phaselist. Should be one item in the list returned by 'PhaseLists' |
| // - Example Value - "BasicPhases" |
| // |
| // - *"Phase"* |
| // - TypeDescriptor - "Phase" item |
| // - Description - Name of the phase. Should be one item in the list returned by 'Phases' |
| // - Example Value - "loadgen" |
| // |
| |
| // Function: "GlobalStats" |
| // |
| // *Description*: This iterator enlists the global scope statistic. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "GlobalStatistic" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='GlobalStats' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "GlobalStat" |
| // |
| // *Description*: This dataElement returns the value of the given global statistics. |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='GlobalStat' source='ExecCtrl'> <params> <dataparam name='Statistic' value='Success'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Statistic"* |
| // - TypeDescriptor - "GlobalStatistic" item |
| // - Description - Name of the global statistics. Should be one item in the list returned by 'GlobalStats' |
| // - Example Value - "Success" |
| // |
| |
| // Function: "Progressbar" |
| // |
| // *Description*: This dataElement returns the ProgressBar variable. Shows the progress as a percentage value. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Progressbar' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "ProgressbarText" |
| // |
| // *Description*: This dataElement returns the ProgressBar text variable. It contains a text of what is in progress. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ProgressbarText' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "GlobalProgressbar" |
| // |
| // *Description*: This dataElement returns the Global ProgressBar variable. Shows the global progress as a percentage value. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='GlobalProgressbar' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "Exit" |
| // |
| // *Description*: This dataElement returns the ExitButton variable. When its value is changed, the button is pressed. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Exit' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "EndOfConfig" |
| // |
| // *Description*: This dataElement returns the EndOfConfig variable. Green LED indicates when the configuration is finished. |
| // |
| // *ValueType*: statusLEDType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='EndOfConfig' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "ReadyToRun" |
| // |
| // *Description*: This dataElement returns the ReadyToRun variable. Green LED indicates when the traffic cases are ready to run. |
| // |
| // *ValueType*: statusLEDType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ReadyToRun' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "GUIDone" |
| // |
| // *Description*: This dataElement returns the GUIDone variable. Green LED indicates when the GUI is ready. |
| // |
| // *ValueType*: statusLEDType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='GUIDone' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "EndOfTest" |
| // |
| // *Description*: This dataElement returns the EndOfTest variable. Green LED indicates when the Test is done, and the test report is generated. |
| // |
| // *ValueType*: statusLEDType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='EndOfTest' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "TimeElapsed" |
| // |
| // *Description*: This dataElement returns the TimeElapsed variable. Its value shows the elapsed time since the main StartButton was pressed. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TimeElapsed' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "Start" |
| // |
| // *Description*: This dataElement returns the Start test variable. The main StartButton can be pressed by changing the value of this variable. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Start' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "Stop" |
| // |
| // *Description*: This dataElement returns the Stop test variable. The main StopButton can be pressed by changing the value of this variable. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Stop' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "Terminate" |
| // |
| // *Description*: This dataElement returns the Terminate test variable. The main TerminateButton can be pressed by changing the value of this variable. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Terminate' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "Snapshot" |
| // |
| // *Description*: This dataElement returns the Snapshot test variable. The main SnapshotButton can be pressed by changing the value of this variable. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Snapshot' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "Restart" |
| // |
| // *Description*: This dataElement restarts the application. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Restart' source='ExecCtrl'> <params> <dataparam name='Executable' value='Executable'/> <dataparam name='ConfigFile' value='ConfigFile.cfg'/> <dataparam name='TestCases' value='Main_module.tc_1 Main_module.tc_2'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Executable"* |
| // - TypeDescriptor - charstringType |
| // - Description - Name of the Executable. |
| // - Example Value - "Executable" |
| // |
| // - *"ConfigFile"* |
| // - TypeDescriptor - charstringType |
| // - Description - Name of the Configuration File |
| // - Example Value - "ConfigFile.cfg" |
| // |
| // - *"TestCases"* |
| // - TypeDescriptor - charstringlistType |
| // - Description - Name of the TestCases separated by space |
| // - Example Value - "Main_module.tc_1 Main_module.tc_2" |
| // |
| |
| // Function: "StartCommand" |
| // |
| // *Description*: This dataElement returns the Start Command of the application. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='StartCommand' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "Executable" |
| // |
| // *Description*: This dataElement returns the Executable of the application. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Executable' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "ConfigFile" |
| // |
| // *Description*: This dataElement returns the ConfigFile of the application. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ConfigFile' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "TestCases" |
| // |
| // *Description*: This dataElement returns the TestCases of the application. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TestCases' source='ExecCtrl'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| } // ~group |
| |
| // Group: "LGenBase" |
| // |
| group LGenBase { |
| |
| // Function: "help" |
| // |
| // *Description*: This data element returns the help information about all dataElements supported |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='help' source='LGenBase'> <params> <dataparam name='Format' value='TEXT'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Format"* |
| // - TypeDescriptor - charstringType |
| // - Description - The format of the output. Valid values: JSON, TEXT. Default: JSON |
| // - Example Value - "TEXT" |
| // |
| |
| // Function: "EntityGroups" |
| // |
| // *Description*: This iterator returns the list of entity groups. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "EntityGroup" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='EntityGroups' source='LGenBase'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "Scenarios" |
| // |
| // *Description*: This iterator returns the list of scenarios in the specified entity group. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "Scenario" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Scenarios' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| |
| // Function: "TrafficCases" |
| // |
| // *Description*: This iterator returns the list of traffic cases in the specified scenario. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "TrafficCase" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TrafficCases' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "TrafficCasesOfScenarios" |
| // |
| // *Description*: This iterator returns the list of traffic cases of all scenarios. |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "TrafficCaseOfScenario" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TrafficCasesOfScenarios' source='LGenBase'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "EntityGroupOfTrafficCasesOfScenarios" |
| // |
| // *Description*: This dataElement returns the EntityGroup for the TrafficCasesOfScenarios item. |
| // |
| // *ValueType*: charstringType |
| // |
| // *TypeDescriptor*: "EntityGroup" item |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='EntityGroupOfTrafficCasesOfScenarios' source='LGenBase'> <params> <dataparam name='TrafficCaseOfScenarios' value='0.0.0'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"TrafficCaseOfScenarios"* |
| // - TypeDescriptor - "TrafficCaseOfScenario" item |
| // - Description - A triple of LGenBase entity group, scenario and traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "0.0.0" |
| // |
| |
| // Function: "ScenarioOfTrafficCasesOfScenarios" |
| // |
| // *Description*: This dataElement returns the Scenario for the TrafficCasesOfScenarios item. |
| // |
| // *ValueType*: charstringType |
| // |
| // *TypeDescriptor*: "Scenario" item |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScenarioOfTrafficCasesOfScenarios' source='LGenBase'> <params> <dataparam name='TrafficCaseOfScenarios' value='0.0.0'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"TrafficCaseOfScenarios"* |
| // - TypeDescriptor - "TrafficCaseOfScenario" item |
| // - Description - A triple of LGenBase entity group, scenario and traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "0.0.0" |
| // |
| |
| // Function: "TrafficCaseOfTrafficCasesOfScenarios" |
| // |
| // *Description*: This dataElement returns the TrafficCase for the TrafficCasesOfScenarios item. |
| // |
| // *ValueType*: charstringType |
| // |
| // *TypeDescriptor*: "TrafficCase" item |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TrafficCaseOfTrafficCasesOfScenarios' source='LGenBase'> <params> <dataparam name='TrafficCaseOfScenarios' value='0.0.0'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"TrafficCaseOfScenarios"* |
| // - TypeDescriptor - "TrafficCaseOfScenario" item |
| // - Description - A triple of LGenBase entity group, scenario and traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "0.0.0" |
| // |
| |
| // Function: "NrOfStarts" |
| // |
| // *Description*: This data element returns the number of starts. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='NrOfStarts' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "NrOfSuccesses" |
| // |
| // *Description*: This data element returns the number of succeeded traffic cases. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='NrOfSuccesses' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "NrOfFails" |
| // |
| // *Description*: This data element returns the number of failed traffic cases. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='NrOfFails' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "NrOfNotFinishedEntities" |
| // |
| // *Description*: This data element returns the number of finished traffic cases. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='NrOfNotFinishedEntities' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "NrOfAllEntities" |
| // |
| // *Description*: This data element returns the number of all entities. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='NrOfAllEntities' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "NrOfRunningEntities" |
| // |
| // *Description*: This data element returns the number of running entities for the specified traffic case. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='NrOfRunningEntities' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "NrOfAvailableEntities" |
| // |
| // *Description*: This data element returns the number of available entities for the specified traffic case. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='NrOfAvailableEntities' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcState" |
| // |
| // *Description*: This data element returns the state of specified traffic case. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcState' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcStateName" |
| // |
| // *Description*: This data element returns the state name of specified traffic case. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcStateName' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcUserData" |
| // |
| // *Description*: This data element returns the user data linked to specified traffic case. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcUserData' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "SentMessages" |
| // |
| // *Description*: This data element returns the number of sent messages by the specified traffic case. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='SentMessages' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "ReceivedAnswers" |
| // |
| // *Description*: This data element returns the number of received messages by the specified traffic case. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ReceivedAnswers' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "RangeLoops" |
| // |
| // *Description*: This data element returns the range loops of specified traffic case. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='RangeLoops' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "CpsToReach" |
| // |
| // *Description*: This data element can be used to set and get the target CPS value of the specified traffic case. |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='CpsToReach' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "LastCps" |
| // |
| // *Description*: This data element returns the last (current) CPS of specified traffic case. |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='LastCps' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TCName" |
| // |
| // *Description*: This data element returns the name specified traffic case. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TCName' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "UniqueName" |
| // |
| // *Description*: This data element returns the unique name of specified traffic case. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='UniqueName' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcEnabled" |
| // |
| // *Description*: This data element returns true if traffic case is enabled, and false otherwise. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcEnabled' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "MinAvailableEntities" |
| // |
| // *Description*: This data element returns the smallest number of available entities during the specified traffic case execution. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='MinAvailableEntities' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "MaxRunningEntities" |
| // |
| // *Description*: This data element returns the highest number of running entities during the specified traffic case execution. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='MaxRunningEntities' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "MaxBusyEntities" |
| // |
| // *Description*: This data element returns the highest number of busy entities during the specified traffic case execution. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='MaxBusyEntities' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "Weight" |
| // |
| // *Description*: This data element returns the weight of specified traffic case. |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Weight' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TrafficType" |
| // |
| // *Description*: This data element returns the traffic type of specified traffic case. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TrafficType' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "NrOfErrors" |
| // |
| // *Description*: This data element returns the number of errors reported by the specified traffic case. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='NrOfErrors' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "NrOfTimeouts" |
| // |
| // *Description*: This data element returns the number of timeouts reported by the specified traffic case. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='NrOfTimeouts' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcStartButton" |
| // |
| // *Description*: This data element returns the start button (checkbox) of specified traffic case. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcStartButton' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcStopButton" |
| // |
| // *Description*: This data element returns the stop button (checkbox) of specified traffic case. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcStopButton' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcAbortButton" |
| // |
| // *Description*: This data element returns the abort button (checkbox) of specified traffic case. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcAbortButton' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcRestoreButton" |
| // |
| // *Description*: This data element returns the abort button (checkbox) of specified traffic case. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcRestoreButton' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcPauseButton" |
| // |
| // *Description*: This data element returns the pause button (checkbox) of specified traffic case. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcPauseButton' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcSingleShotBtn" |
| // |
| // *Description*: This data element returns the single shot button (checkbox) of specified traffic case. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcSingleShotBtn' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "TcEnabledAtStartup" |
| // |
| // *Description*: This data element returns true if traffic case is enabled at start up, and returns false otherwise. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='TcEnabledAtStartup' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "IsTcPresent" |
| // |
| // *Description*: This condition returns true if specified traffic case exists, and returns false otherwise. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='IsTcPresent' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> <dataparam name='TrafficCase' value='TrafficCase01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| // - *"TrafficCase"* |
| // - TypeDescriptor - "TrafficCase" item |
| // - Description - Name of the traffic case. Should be one item in the list returned by 'TrafficCases' |
| // - Example Value - "TrafficCase01" |
| // |
| |
| // Function: "ScName" |
| // |
| // *Description*: This data element returns the name of specified scenario. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScName' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScEnabled" |
| // |
| // *Description*: This data element returns the enabled state of specified scenario. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScEnabled' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScState" |
| // |
| // *Description*: This data element returns the state of specified scenario. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScState' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScStateName" |
| // |
| // *Description*: This data element returns the state name of specified scenario. |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScStateName' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScLockCPS" |
| // |
| // *Description*: This data element returns true if the specified scenario's CPS is locked, and returns false otherwise. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScLockCPS' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScCpsToReach" |
| // |
| // *Description*: This data element can be used to set and get the target CPS for the specified scenario. |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScCpsToReach' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScStartButton" |
| // |
| // *Description*: This data element returns the start push button's value of specified scenario. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScStartButton' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScStopButton" |
| // |
| // *Description*: This data element returns the stop push button's value of specified scenario. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScStopButton' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScAbortButton" |
| // |
| // *Description*: This data element returns the abort push button's value of specified scenario. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScAbortButton' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScRestoreButton" |
| // |
| // *Description*: This data element returns the restore push button's value of specified scenario. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScRestoreButton' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScPauseButton" |
| // |
| // *Description*: This data element returns the pause push button's value of specified scenario. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScPauseButton' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "ScSingleShotBtn" |
| // |
| // *Description*: This data element returns the single shot push button's value of specified scenario. |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ScSingleShotBtn' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "IsWeightedSc" |
| // |
| // *Description*: This condition returns true if specified scenario is weighted, and returns false otherwise. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='IsWeightedSc' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "IsScPresent" |
| // |
| // *Description*: This condition returns true if specified scenario exists, and returns false otherwise. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='IsScPresent' source='LGenBase'> <params> <dataparam name='EntityGroup' value='EGrp01'/> <dataparam name='Scenario' value='Scenario01'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"EntityGroup"* |
| // - TypeDescriptor - "EntityGroup" item |
| // - Description - Name of the entity group the traffic case belongs to. Should be one item in the list returned by 'EntityGroups' |
| // - Example Value - "EGrp01" |
| // |
| // - *"Scenario"* |
| // - TypeDescriptor - "Scenario" item |
| // - Description - Name of the scenario the traffic case belongs to. Should be one item in the list returned by 'Scenarios' |
| // - Example Value - "Scenario01" |
| // |
| |
| // Function: "HasActiveTc" |
| // |
| // *Description*: This condition returns true if the current PTC has at least one active traffic case, and returns false otherwise. |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='HasActiveTc' source='LGenBase'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| } // ~group |
| |
| // Group: "HostAdminServer" |
| // |
| group HostAdminServer { |
| |
| // Function: "help" |
| // |
| // *Description*: This data element returns the help information about all dataElements supported |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='help' source='HostAdminServer'> <params> <dataparam name='Format' value='TEXT'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"Format"* |
| // - TypeDescriptor - charstringType |
| // - Description - The format of the output. Valid values: JSON, TEXT. Default: JSON |
| // - Example Value - "TEXT" |
| // |
| |
| // Function: "isMultipleHosts" |
| // |
| // *Description*: This condition returns true if there are more than one hosts |
| // |
| // *ValueType*: boolType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='isMultipleHosts' source='HostAdminServer'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "ProcessSortOptionList" |
| // |
| // *Description*: This iterator enlists the sort options for process sorting that can be used in the data element "ProcessSortOption" |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ProcessSortOptionList' source='HostAdminServer'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "ProcessSortOption" |
| // |
| // *Description*: DataElement to set the process sort option. Value should be one of: { "EPTF SelfName", "CPU Load", "Memory Usage", "Unsorted" } which is the list returned by the iterator "ProcessSortOptionList" |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ProcessSortOption' source='HostAdminServer'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "NofHosts" |
| // |
| // *Description*: This dataElement returns the number of hosts |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='NofHosts' source='HostAdminServer'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "Hosts" |
| // |
| // *Description*: This iterator enlists the hosts tracked by the HostAdminServer |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "HostName" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='Hosts' source='HostAdminServer'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "CPUs" |
| // |
| // *Description*: This iterator enlists the CPUs for a host |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "CPU" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='CPUs' source='HostAdminServer'> <params> <dataparam name='HostName' value=''/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"HostName"* |
| // - TypeDescriptor - "HostName" item |
| // - Description - the name of the host. Should be one item in the list given by the iterator "Hosts" |
| // - Example Value - "" |
| // |
| |
| // Function: "PerCpuLoad" |
| // |
| // *Description*: This dataElement returns the PerCpuLoad variable for a cpu on a host |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='PerCpuLoad' source='HostAdminServer'> <params> <dataparam name='HostName' value=''/> <dataparam name='CpuIdx' value='0'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"HostName"* |
| // - TypeDescriptor - "HostName" item |
| // - Description - the name of the host |
| // - Example Value - "" |
| // |
| // - *"CpuIdx"* |
| // - TypeDescriptor - "CPU" item |
| // - Description - Specifies the CPU index (as returned by the CPUs iterator) |
| // - Example Value - "0" |
| // |
| |
| // Function: "ProcessesOnHost" |
| // |
| // *Description*: This iterator enlists the processes on a given host |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "ProcessOnHost" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ProcessesOnHost' source='HostAdminServer'> <params> <dataparam name='HostName' value=''/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"HostName"* |
| // - TypeDescriptor - "HostName" item |
| // - Description - the name of the host. Should be one item in the list given by the iterator "Hosts" |
| // - Example Value - "" |
| // |
| |
| // Function: "SelfName" |
| // |
| // *Description*: This dataElement returns the SelfName variable for a process |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='SelfName' source='HostAdminServer'> <params> <dataparam name='HostName' value=''/> <dataparam name='ProcessIdx' value='0'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"HostName"* |
| // - TypeDescriptor - "HostName" item |
| // - Description - the name of the host |
| // - Example Value - "" |
| // |
| // - *"ProcessIdx"* |
| // - TypeDescriptor - "ProcessOnHost" item |
| // - Description - Specifies the process index (as returned by the processes iterator) |
| // - Example Value - "0" |
| // |
| |
| // Function: "CpuLoad" |
| // |
| // *Description*: This dataElement returns the CpuLoad variable for a process or host |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='CpuLoad' source='HostAdminServer'> <params> <dataparam name='SelfName' value=''/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"SelfName"* |
| // - TypeDescriptor - "ProcessName" item |
| // - Description - Specifies the selfName of a process |
| // - Example Value - "" |
| // |
| |
| // Function: "MemUsage" |
| // |
| // *Description*: This dataElement returns the MemUsage variable for a process |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='MemUsage' source='HostAdminServer'> <params> <dataparam name='SelfName' value=''/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"SelfName"* |
| // - TypeDescriptor - "ProcessName" item |
| // - Description - Specifies the selfName of a process |
| // - Example Value - "" |
| // |
| |
| // Function: "MemUsageHRF" |
| // |
| // *Description*: his dataElement returns the MemUsage variable for a process in Human Readable Fromat |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='MemUsageHRF' source='HostAdminServer'> <params> <dataparam name='SelfName' value=''/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"SelfName"* |
| // - TypeDescriptor - "ProcessName" item |
| // - Description - Specifies the selfName of a process |
| // - Example Value - "" |
| // |
| |
| // Function: "HostName" |
| // |
| // *Description*: This dataElement returns the host name variable for a process |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='HostName' source='HostAdminServer'> <params> <dataparam name='SelfName' value=''/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"SelfName"* |
| // - TypeDescriptor - "ProcessName" item |
| // - Description - Specifies the selfName of a process |
| // - Example Value - "" |
| // |
| |
| // Function: "CpuLoad" |
| // |
| // *Description*: This dataElement returns the CpuLoad variable for a process or host |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='CpuLoad' source='HostAdminServer'> <params> <dataparam name='HostName' value=''/> <dataparam name='ProcessIdx' value=''/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"HostName"* |
| // - TypeDescriptor - "HostName" item |
| // - Description - the name of the host |
| // - Example Value - "" |
| // |
| // - *"ProcessIdx"* |
| // - TypeDescriptor - "ProcessOnHost" item |
| // - Description - Specifies the process index (as returned by the processes iterator |
| // - Example Value - "" |
| // |
| |
| // Function: "MemUsage" |
| // |
| // *Description*: This dataElement returns the MemUsage variable for a process |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='MemUsage' source='HostAdminServer'> <params> <dataparam name='HostName' value=''/> <dataparam name='ProcessIdx' value=''/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"HostName"* |
| // - TypeDescriptor - "HostName" item |
| // - Description - the name of the host |
| // - Example Value - "" |
| // |
| // - *"ProcessIdx"* |
| // - TypeDescriptor - "ProcessOnHost" item |
| // - Description - Specifies the process index (as returned by the processes iterator |
| // - Example Value - "" |
| // |
| |
| // Function: "MemUsageHRF" |
| // |
| // *Description*: his dataElement returns the MemUsage variable for a process in Human Readable Fromat |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='MemUsageHRF' source='HostAdminServer'> <params> <dataparam name='HostName' value=''/> <dataparam name='ProcessIdx' value=''/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"HostName"* |
| // - TypeDescriptor - "HostName" item |
| // - Description - the name of the host |
| // - Example Value - "" |
| // |
| // - *"ProcessIdx"* |
| // - TypeDescriptor - "ProcessOnHost" item |
| // - Description - Specifies the process index (as returned by the processes iterator |
| // - Example Value - "" |
| // |
| |
| // Function: "PID" |
| // |
| // *Description*: This dataElement returns the PID variable for a process |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='PID' source='HostAdminServer'> <params> <dataparam name='HostName' value=''/> <dataparam name='ProcessIdx' value='0'/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"HostName"* |
| // - TypeDescriptor - "HostName" item |
| // - Description - the name of the host |
| // - Example Value - "" |
| // |
| // - *"ProcessIdx"* |
| // - TypeDescriptor - "ProcessOnHost" item |
| // - Description - Specifies the process index (as returned by the processes iterator) |
| // - Example Value - "0" |
| // |
| |
| // Function: "IPv4Addr" |
| // |
| // *Description*: This dataElement returns the IPv4 Address variable for a host |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='IPv4Addr' source='HostAdminServer'> <params> <dataparam name='HostName' value=''/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"HostName"* |
| // - TypeDescriptor - "HostName" item |
| // - Description - the name of the host |
| // - Example Value - "" |
| // |
| |
| // Function: "IPv6Addr" |
| // |
| // *Description*: This dataElement returns the IPv6 Address variable for a host |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='IPv6Addr' source='HostAdminServer'> <params> <dataparam name='HostName' value=''/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"HostName"* |
| // - TypeDescriptor - "HostName" item |
| // - Description - the name of the host |
| // - Example Value - "" |
| // |
| |
| // Function: "PhysicalMem" |
| // |
| // *Description*: This dataElement returns the PhysicalMem [kB] variable for a host |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='PhysicalMem' source='HostAdminServer'> <params> <dataparam name='HostName' value=''/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"HostName"* |
| // - TypeDescriptor - "HostName" item |
| // - Description - the name of the host |
| // - Example Value - "" |
| // |
| |
| // Function: "PhysicalMemHRF" |
| // |
| // *Description*: This dataElement returns the PhysicalMem variable for a host in Human Readable Fromat (e.g. '1.5 MB', '3.8 GB') |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='PhysicalMemHRF' source='HostAdminServer'> <params> <dataparam name='HostName' value=''/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"HostName"* |
| // - TypeDescriptor - "HostName" item |
| // - Description - the name of the host |
| // - Example Value - "" |
| // |
| |
| // Function: "FreeMem" |
| // |
| // *Description*: This dataElement returns the FreeMem [kB] variable for a host |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='FreeMem' source='HostAdminServer'> <params> <dataparam name='HostName' value=''/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"HostName"* |
| // - TypeDescriptor - "HostName" item |
| // - Description - the name of the host |
| // - Example Value - "" |
| // |
| |
| // Function: "FreeMemHRF" |
| // |
| // *Description*: This dataElement returns the FreeMem variable for a host in Human Readable Fromat (e.g. '1.5 MB', '3.8 GB') |
| // |
| // *ValueType*: charstringType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='FreeMemHRF' source='HostAdminServer'> <params> <dataparam name='HostName' value=''/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"HostName"* |
| // - TypeDescriptor - "HostName" item |
| // - Description - the name of the host |
| // - Example Value - "" |
| // |
| |
| // Function: "CpuLoad" |
| // |
| // *Description*: This dataElement returns the CpuLoad variable for a process or host |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='CpuLoad' source='HostAdminServer'> <params> <dataparam name='HostName' value=''/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"HostName"* |
| // - TypeDescriptor - "HostName" item |
| // - Description - the name of the host |
| // - Example Value - "" |
| // |
| |
| // Function: "CpuMin" |
| // |
| // *Description*: This dataElement returns the CpuMin variable for a host |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='CpuMin' source='HostAdminServer'> <params> <dataparam name='HostName' value=''/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"HostName"* |
| // - TypeDescriptor - "HostName" item |
| // - Description - the name of the host |
| // - Example Value - "" |
| // |
| |
| // Function: "CpuMax" |
| // |
| // *Description*: This dataElement returns the CpuMax variable for a host |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='CpuMax' source='HostAdminServer'> <params> <dataparam name='HostName' value=''/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"HostName"* |
| // - TypeDescriptor - "HostName" item |
| // - Description - the name of the host |
| // - Example Value - "" |
| // |
| |
| // Function: "CpuAvg" |
| // |
| // *Description*: This dataElement returns the CpuAvg variable for a host |
| // |
| // *ValueType*: floatType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='CpuAvg' source='HostAdminServer'> <params> <dataparam name='HostName' value=''/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"HostName"* |
| // - TypeDescriptor - "HostName" item |
| // - Description - the name of the host |
| // - Example Value - "" |
| // |
| |
| // Function: "ResetMinMaxAvgCPULoad" |
| // |
| // *Description*: This dataElement returns the ResetMinMaxAvgCPULoad variable for a host which can be used to reset the Min/Max/Avg/CPULoad |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ResetMinMaxAvgCPULoad' source='HostAdminServer'> <params> <dataparam name='HostName' value=''/> </params> </datadescription> |
| // |
| // *Parameters*: |
| // - *"HostName"* |
| // - TypeDescriptor - "HostName" item |
| // - Description - the name of the host |
| // - Example Value - "" |
| // |
| |
| // Function: "ProcessNames" |
| // |
| // *Description*: This iterator enlists the process names (globally, regardless of hostname) |
| // |
| // *ValueType*: charstringlistType |
| // |
| // *TypeDescriptor*: List of "ProcessName" items |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ProcessNames' source='HostAdminServer'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| |
| // Function: "ResetMinMaxAvgCPULoad" |
| // |
| // *Description*: This dataElement returns the ResetMinMaxAvgCPULoad variable for all hosts |
| // |
| // *ValueType*: intType |
| // |
| // *CLI Example*: ds get <datadescription xmlns='http://ttcn.ericsson.se/protocolModules/xtdp/xtdl' element='ResetMinMaxAvgCPULoad' source='HostAdminServer'> <params> </params> </datadescription> |
| // |
| // *Parameters*: None. |
| } // ~group |
