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
UserTraffic Class Reference

UserTraffic represents the user traffic information (PDU). More...

Public Member Functions

int getTrafficColorCode ()
 Returns the color code of this PDU. More...
 
QString getTrafficTypeString ()
 Returns the traffic type of this PDU. More...
 
Device getSourceDevice ()
 Returns the source device of this PDU. More...
 
Device getDestinationDevice ()
 Returns the destination device of this PDU. More...
 
Pdu getPdu ()
 Returns the PDU object of this PDU. More...
 
Port getSendPort ()
 Returns the sending port of this PDU. More...
 
QString getCanonicalSource ()
 Returns the name of the source of this PDU. More...
 
QString getCanonicalDestination ()
 Returns the name of the destination of this PDU. More...
 
TrafficStatus getStatus ()
 Returns the status of this PDU. More...
 
TrafficStatus getTestCondition ()
 Returns the connectivity test status of this PDU. More...
 
int getPoints ()
 Returns the point value of this PDU. More...
 
int getPduSize ()
 Returns the size of this PDU. More...
 

Detailed Description

UserTraffic represents the user traffic information (PDU).

Member Function Documentation

◆ getCanonicalDestination()

QString UserTraffic::getCanonicalDestination ( )

Returns the name of the destination of this PDU.

Returns
QString, the name of the destination of this PDU.

◆ getCanonicalSource()

QString UserTraffic::getCanonicalSource ( )

Returns the name of the source of this PDU.

Returns
QString, the name of the source of this PDU.

◆ getDestinationDevice()

Device UserTraffic::getDestinationDevice ( )

Returns the destination device of this PDU.

Returns
Device, the Device object of the destination device of this PDU.

◆ getPdu()

Pdu UserTraffic::getPdu ( )

Returns the PDU object of this PDU.

Returns
PDU, the PDU object of this PDU.

◆ getPduSize()

int UserTraffic::getPduSize ( )

Returns the size of this PDU.

Returns
int, the size of this PDU.

◆ getPoints()

int UserTraffic::getPoints ( )

Returns the point value of this PDU.

Returns
int, the point value of this PDU.

◆ getSendPort()

Port UserTraffic::getSendPort ( )

Returns the sending port of this PDU.

Returns
Port, the Port object of the sending port of this PDU.

◆ getSourceDevice()

Device UserTraffic::getSourceDevice ( )

Returns the source device of this PDU.

Returns
Device, the Device object of the source device of this PDU.

◆ getStatus()

TrafficStatus UserTraffic::getStatus ( )

Returns the status of this PDU.

Returns
enum<TrafficStatus>, the status of this PDU. Traffic statuses: eTrafficNotSend = 0, eTrafficInProgress = 1, eTrafficFailed = 2, eTrafficSuccessful = 3

◆ getTestCondition()

TrafficStatus UserTraffic::getTestCondition ( )

Returns the connectivity test status of this PDU.

Returns
enum<TrafficStatus>, the the test condition status of this PDU. Traffic statuses: eTrafficNotSend = 0, eTrafficInProgress = 1, eTrafficFailed = 2, eTrafficSuccessful = 3

◆ getTrafficColorCode()

int UserTraffic::getTrafficColorCode ( )

Returns the color code of this PDU.

Returns
int, the color code of this PDU.

◆ getTrafficTypeString()

QString UserTraffic::getTrafficTypeString ( )

Returns the traffic type of this PDU.

Returns
QString, the traffic type of this PDU.

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