Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
SimulationPanel Class Reference

SimulationPanel allows for UI manipulation of the Simulation Panel. More...

Public Member Functions

void setVisible (bool)
 Shows or hides this widget from view. More...
 
void setWidgetVisible (string, bool)
 Shows or hides the specified child widget. More...
 
void setDisabled (bool)
 Enables or disables input events to this widget. More...
 
void setWidgetDisable (string, bool)
 Enables or disables the specified child widget. More...
 
void resetSimulation ()
 Simulates clicking on the Reset Simulation button. More...
 
void play ()
 Simulates clicking on the Auto Capture / Play button. More...
 
void back ()
 Simulates clicking on the Back button. More...
 
void forward ()
 Simulates clicking on the Capture / Forward button. More...
 
bool isPlaying ()
 Returns true if the simulation is currently playing, otherwise false. More...
 
void populateEventList ()
 Refreshes the display of the event list. More...
 
void changePlaySpeed (int)
 Changes the play speed of the simulation. More...
 
void setFilter (QString, bool)
 Enables or disables the specified event list filter. More...
 
void setAllFilters ()
 Enables or disables all of the event list filters. More...
 
void showFiltersDialog ()
 Simulates clicking on the Edit Filters button. More...
 
void setConstantDelay (bool)
 Enables or disables constant delay. More...
 

Detailed Description

SimulationPanel allows for UI manipulation of the Simulation Panel.

Member Function Documentation

◆ back()

void SimulationPanel::back ( )

Simulates clicking on the Back button.

◆ changePlaySpeed()

void SimulationPanel::changePlaySpeed ( int  )

Changes the play speed of the simulation.

Parameters
value,thevalue of the play speed.

◆ forward()

void SimulationPanel::forward ( )

Simulates clicking on the Capture / Forward button.

◆ isPlaying()

bool SimulationPanel::isPlaying ( )

Returns true if the simulation is currently playing, otherwise false.

Returns
bool, true if the simulation is currently playing, otherwise false.

◆ play()

void SimulationPanel::play ( )

Simulates clicking on the Auto Capture / Play button.

◆ populateEventList()

void SimulationPanel::populateEventList ( )

Refreshes the display of the event list.

Remarks
This function is generally not required unless there was direct manipulate of the events in the engine.

◆ resetSimulation()

void SimulationPanel::resetSimulation ( )

Simulates clicking on the Reset Simulation button.

◆ setAllFilters()

void SimulationPanel::setAllFilters ( )

Enables or disables all of the event list filters.

◆ setConstantDelay()

void SimulationPanel::setConstantDelay ( bool  )

Enables or disables constant delay.

Parameters
bSet,trueto enable constant delay, false to disable it.

◆ setDisabled()

void SimulationPanel::setDisabled ( bool  )

Enables or disables input events to this widget.

Parameters
bDisabled,trueto disable input events to this widget, false to enable input events.

◆ setFilter()

void SimulationPanel::setFilter ( QString  ,
bool   
)

Enables or disables the specified event list filter.

Parameters
protocol,thename of the protocol.
bSet,trueto check the event list filter, false to uncheck it.

◆ setVisible()

void SimulationPanel::setVisible ( bool  )

Shows or hides this widget from view.

Parameters
bVisible,trueto show this widget, false to hide it.

◆ setWidgetDisable()

void SimulationPanel::setWidgetDisable ( string  ,
bool   
)

Enables or disables the specified child widget.

Parameters
widgetName,wherewidgetName can be one of the following: ResetSimulationBtn, BackBtn, PlayBtn, ForwardBtn, EditFilterBtn, ShowAllBtn, ConstantDelayBtn.
bDisabled,trueto disable input events to this child widget, false to enable input events.

◆ setWidgetVisible()

void SimulationPanel::setWidgetVisible ( string  ,
bool   
)

Shows or hides the specified child widget.

Parameters
widgetName,wherewidgetName can be one of the following: ResetSimulationBtn, BackBtn, PlayBtn, ForwardBtn, EditFilterBtn, ShowAllBtn, ConstantDelayBtn.
bVisible,trueto show this child widget, false to hide it.

◆ showFiltersDialog()

void SimulationPanel::showFiltersDialog ( )

Simulates clicking on the Edit Filters button.


The documentation for this class was generated from the following file: