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

Variable is the base class for variables in the VariableManager. More...

Public Member Functions

QString name ()
 Returns the name of the variable. More...
 
QString valueToString ()
 Returns the value of the variable. More...
 
QString valueOfIndex (int)
 Returns the value of the variable at the specified index. More...
 
Pool getPool ()
 Returns the pool that this variable is associated with. More...
 
bool isInPool (QString)
 Returns true if the specified value is in the pool, otherwise false. More...
 
VARIABLETYPE getType ()
 Returns the type of the variable. More...
 

Detailed Description

Variable is the base class for variables in the VariableManager.

Member Function Documentation

◆ getPool()

Pool Variable::getPool ( )

Returns the pool that this variable is associated with.

Returns
Pool, the Pool object that this variable is associated with.

◆ getType()

VARIABLETYPE Variable::getType ( )

Returns the type of the variable.

Returns
enum<VARIABLETYPE>, the type of the variable. Variable types: ENTIRE_RANGE = 0, RANDOM = 1, STATIC = 2, SEED = 3

◆ isInPool()

bool Variable::isInPool ( QString  )

Returns true if the specified value is in the pool, otherwise false.

Parameters
value,thevalue of interest.
Returns
bool, true if the specified value is in the pool, otherwise false.

◆ name()

QString Variable::name ( )

Returns the name of the variable.

Returns
QString, the name of the variable.

◆ valueOfIndex()

QString Variable::valueOfIndex ( int  )

Returns the value of the variable at the specified index.

Parameters
index,theindex of the variable of interest.
Returns
QString, the value of the variable.

◆ valueToString()

QString Variable::valueToString ( )

Returns the value of the variable.

Returns
QString, the value of the variable.

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