################################################################################
#                                                                              #
#    Copyright 1997 - 2020 by IXIA  Keysight                                   #
#    All Rights Reserved.                                                      #
#                                                                              #
################################################################################

################################################################################
#                                                                              #
#                                LEGAL  NOTICE:                                #
#                                ==============                                #
# The following code and documentation (hereinafter "the script") is an        #
# example script for demonstration purposes only.                              #
# The script is not a standard commercial product offered by Ixia and have     #
# been developed and is being provided for use only as indicated herein. The   #
# script [and all modifications enhancements and updates thereto (whether      #
# made by Ixia and/or by the user and/or by a third party)] shall at all times #
# remain the property of Ixia.                                                 #
#                                                                              #
# Ixia does not warrant (i) that the functions contained in the script will    #
# meet the users requirements or (ii) that the script will be without          #
# omissions or error-free.                                                     #
# THE SCRIPT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND AND IXIA         #
# DISCLAIMS ALL WARRANTIES EXPRESS IMPLIED STATUTORY OR OTHERWISE              #
# INCLUDING BUT NOT LIMITED TO ANY WARRANTY OF MERCHANTABILITY AND FITNESS FOR #
# A PARTICULAR PURPOSE OR OF NON-INFRINGEMENT.                                 #
# THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SCRIPT  IS WITH THE #
# USER.                                                                        #
# IN NO EVENT SHALL IXIA BE LIABLE FOR ANY DAMAGES RESULTING FROM OR ARISING   #
# OUT OF THE USE OF OR THE INABILITY TO USE THE SCRIPT OR ANY PART THEREOF     #
# INCLUDING BUT NOT LIMITED TO ANY LOST PROFITS LOST BUSINESS LOST OR          #
# DAMAGED DATA OR SOFTWARE OR ANY INDIRECT INCIDENTAL PUNITIVE OR              #
# CONSEQUENTIAL DAMAGES EVEN IF IXIA HAS BEEN ADVISED OF THE POSSIBILITY OF    #
# SUCH DAMAGES IN ADVANCE.                                                     #
# Ixia will not be required to provide any software maintenance or support     #
# services of any kind (e.g. any error corrections) in connection with the     #
# script or any part thereof. The user acknowledges that although Ixia may     #
# from time to time and in its sole discretion provide maintenance or support  #
# services for the script any such services are subject to the warranty and    #
# damages limitations set forth herein and will not obligate Ixia to provide   #
# any additional maintenance or support services.                              #
#                                                                              #
################################################################################



################################################################################
#                                                                              #
# Description:                                                                 #
#    This script intends to demonstrate how a custom view is saved and 		   #
#	 generated using a scriptgen file								           #
# Module:                                                                      #
#    The sample was tested on an XMVDC16 module.                               #
################################################################################

# edit this variables values to match your setup
namespace eval ::ixia {
    set ixTclServer 127.0.0.1
    set ixTclPort   8009
    set ports       {{10.215.170.111 1 11} {10.215.170.111 1 12}}
}

puts "Load ixNetwork Tcl API package"
package req IxTclNetwork

puts "Connect to IxNetwork Tcl server"
ixNet connect $::ixia::ixTclServer -port $::ixia::ixTclPort -version 6.30 –setAttribute strict

puts "Load the IxNetwork config"
ixNet exec loadConfig [ixNet readFrom config.traffic-basic.ixncfg]
set vPorts [ixNet getList [ixNet getRoot] vport]

puts "Assigning virtual ports to real ports"
::ixTclNet::AssignPorts $::ixia::ports {} $vPorts force

puts "Starting all protocols"
ixNet exec startAllProtocols

puts "Waiting for 30 sec"
after 30000

puts "Applying the traffic"
ixNet setAttr [ixNet getRoot]/traffic -refreshLearnedInfoBeforeApply true
ixNet exec apply [ixNet getRoot]/traffic

puts -nonewline "Starting the traffic "
ixNet exec start [ixNet getRoot]/traffic

set count 0
while { [ixNet getAttr [ixNet getRoot]/traffic -state] != "started" } {
    puts -nonewline "."
    after 1000
    incr count
    if { $count > 90 } {
        error "Waited for 90 sec, Traffic still not in started state !"
    }
}
puts "."

puts "Leting the traffic run for 30 sec"
after 30000

puts "Add the custom view"
set custom_view [ixNet add [ixNet getRoot]/statistics view]
ixNet setAttr $custom_view -caption "custom-view-traffic"
ixNet setAttr $custom_view -type layer23TrafficPort
ixNet setAttr $custom_view -visible true
ixNet commit
set custom_view [lindex [ixNet remapIds $custom_view] 0]

puts "Retrieve relevant filters for the view"
set availablePortFilter [ixNet getList $custom_view availablePortFilter]

puts "Configure the filter selection area"
ixNet setAttr $custom_view/layer23TrafficPortFilter -portFilterIds $availablePortFilter
ixNet commit

puts "Enable the stats columns to be disaplyed"
set statsList [ixNet getList $custom_view statistic]
foreach stat $statsList {
    ixNet setAttr $stat -enabled true
}
ixNet commit

puts "Get the custom view going and start retrieveing stats"
ixNet setAttribute $custom_view -enabled true
ixNet commit

set language "tcl"
set ext "tcl"
set type "ixNet"
set interp "tclsh"
set location "C:\\IxNetworkExports\\"
set pc_time [clock format [clock sec] -format "%Y_%m_%d_%H_%M"]
set fileName "_ScriptGen_${type}.tcl"
set path "$location\\$pc_time$fileName"

set objRef [ixNet getRoot]globals/scriptgen

ixNet setMultiAttribute $objRef \
			-serializationType $type \
			-language $language \
			-includeConnect true \
			-linePerAttribute true
ixNet setMultiAttribute $objRef/ixNetCodeOptions \
			-includeDefaultValues false \
			-includeTraffic true \
			-includeTrafficFlowGroup true \
			-includeTrafficStack true \
			-includeQuickTest true \
			-includeStatistic true \
			-includeTestComposer false
ixNet commit

puts "Generate Low Level TCL scriptgen '$path'"
set createDuration [time {ixNet exec generate $objRef [ixNet writeTo $path -ixNetRelative -overwrite]}]
puts "Elapsed time to generate scriptgen $path $createDuration"; update

puts "Load the Low Level TCL scriptgen file"
catch {source "$path"} errMessage
if { $errMessage != 0 } {
	puts "Failed to load the Low Level TCL scriptgen file; error = $errMessage"
} else {
	puts "Load succeed"
}

puts "Connect to IxNetwork Tcl server"
ixNet connect $::ixia::ixTclServer -port $::ixia::ixTclPort -version 6.30 –setAttribute strict

puts "Waiting 30 sec for ports to come up"
after 30000

puts "Starting all protocols"
ixNet exec startAllProtocols

puts "Waiting for 30 sec"
after 30000

puts "Applying the traffic"
ixNet setAttr [ixNet getRoot]/traffic -refreshLearnedInfoBeforeApply true
ixNet exec apply [ixNet getRoot]/traffic

puts -nonewline "Starting the traffic "
ixNet exec start [ixNet getRoot]/traffic

set count 0
while { [ixNet getAttr [ixNet getRoot]/traffic -state] != "started" } {
    puts -nonewline "."
    after 1000
    incr count
    if { $count > 90 } {
        error "Waited for 90 sec, Traffic still not in started state !"
    }
}
puts "."

puts "Leting the traffic run for 30 sec"
after 30000

puts "Execute ::IxScriptgen::_statistic() :"
catch {::IxScriptgen::_statistic} errMessage4
if { $errMessage4 ne "0" } {
	error "Failed to execute _statistic ; error = $errMessage4"
} else {
	puts "Execute _statistic succeed"
}

puts "Wait 30 sec"
after 30000

set view "custom-view-traffic"
set index [lsearch -regexp [ixNet getL [ixNet getRoot]/statistics view] "$view"]	
if {$index== -1} {
	error "Cannot find $view in view list !"

}
set usedView [lindex [ixNet getL [ixNet getRoot]/statistics view] $index]

puts "Check if $view view is ready"
set pageReady [ixNet getAttr $usedView/page -isReady]
for {set i 0} {$i <= 10 && $pageReady ne "true"} {incr i} {
	puts "Stats from $view are not ready yet"
	puts "Wait 3 seconds and verify again"
	after 3000
	set pageReady [ixNet getAttr $obj/page -isReady]
}

if {$pageReady ne true} {
	puts "Statistics from $view are not ready !"
}
puts "Statistics from $view are ready"

puts "TEST END ."

puts " "
puts " "
puts "For more info please refer to the user manual or the built-in help"
puts " "
puts "ixNet help ::ixNet::OBJ-/statistics/view"
puts "[ixNet help ::ixNet::OBJ-/statistics/view]"
puts " "
puts "ixNet help ::ixNet::OBJ-/statistics/view/layer23TrafficPortFilter"
puts "[ixNet help ::ixNet::OBJ-/statistics/view/layer23TrafficPortFilter]"
puts " "
puts "ixNet help ::ixNet::OBJ-/statistics/view/statistic"
puts "[ixNet help ::ixNet::OBJ-/statistics/view/statistic]"