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

WirelessCommon handles and manipulates common wireless settings. More...

Inheritance diagram for WirelessCommon:
Process WirelessClientProcess WirelessServerProcess

Public Member Functions

WirelessAuthenType getAuthenType ()
 Returns the authentication type. More...
 
void setAuthenType (WirelessAuthenType)
 
void setSsid (string)
 Sets the SSID. More...
 
string getSsid ()
 Returns the SSID. More...
 
WirelessNetworkType getNetworkType ()
 Returns the network type. More...
 
void setNetworkType (WirelessNetworkType)
 
bool setPort (string)
 Sets the wireless port with the specified port. More...
 
Port getPort ()
 Returns the wireless port. More...
 
WEPProcess getWepProcess ()
 Returns the WEP process. More...
 
void resetAllAssociations ()
 Resets all wireless associations. More...
 
WirelessEncryptType getEncryptType ()
 Get encryption type. More...
 
void setEncryptType (WirelessEncryptType)
 Set encryption type \para type, enum<WirelessEncryptType> eEncryptNull = 0, eEncryptWep_64bit = 1, eEncryptWep_128bit = 2, eEncryptTKIP = 3, //Arun wpa eEncryptAES = 4. More...
 
void setStandardChannel (StandardChannel)
 Set standard channel \para type, enum<StandardChannel>
eStandardChannel_1 = 0, // channel: 1 - 2.412GHz eStandardChannel_2 = 1, // channel: 2 - 2.417GHz eStandardChannel_3 = 2, // channel: 3 - 2.422GHz eStandardChannel_4 = 3, // channel: 4 - 2.427GHz eStandardChannel_5 = 4, // channel: 5 - 2.432GHz eStandardChannel_6 = 5, // channel: 6 - 2.437GHz eStandardChannel_7 = 6, // channel: 7 - 2.442GHz eStandardChannel_8 = 7, // channel: 8 - 2.447GHz eStandardChannel_9 = 8, // channel: 9 - 2.452GHz eStandardChannel_10 = 9, // channel: 10 - 2.457GHz eStandardChannel_11 = 10 // channel: 11 - 2.462GHz. More...
 
StandardChannel getStandardChannel ()
 Get standard channel. More...
 
void setWideChannel (WideChannel)
 Set wide channel. More...
 
WideChannel getWideChannel ()
 Get wide channel. More...
 
WirelessRadioBand getRadioBand ()
 Get radio band. More...
 
void setRadioBand (WirelessRadioBand)
 Set radio band. More...
 
WPAProcess getWpaProcess ()
 Get Wpa Process. More...
 
- Public Member Functions inherited from Process
Device getOwnerDevice ()
 Returns the device for this process. More...
 

Detailed Description

WirelessCommon handles and manipulates common wireless settings.

Member Function Documentation

◆ getAuthenType()

WirelessAuthenType WirelessCommon::getAuthenType ( )

Returns the authentication type.

Returns
enum<WirelessAuthenType>, the authentication type. Authentication types: eAuthenNull = 0, eAuthenWep = 1, eAuthenWPA1_PSK = 2, eAuthenWPA1_EAP = 3, eAuthenWPA2_PSK = 4, eAuthenWPA2_EAP = 5, eAuthenOpen = 6

◆ getEncryptType()

WirelessEncryptType WirelessCommon::getEncryptType ( )

Get encryption type.

Returns
enum<WirelessEncryptType>, eEncryptNull = 0, eEncryptWep_64bit = 1, eEncryptWep_128bit = 2, eEncryptTKIP = 3, //Arun wpa eEncryptAES = 4

◆ getNetworkType()

WirelessNetworkType WirelessCommon::getNetworkType ( )

Returns the network type.

Returns
enum<WirelessNetworkType>, the network type. Network types: eWirelessDisabled = 0x0, eWirelessB = 0x1, eWirelessG = 0x2, eWirelessBGMixed = 0x3, eWirelessN = 0x4, eWirelessA = 0x5, eWirelessMixed = 0x7

◆ getPort()

Port WirelessCommon::getPort ( )

Returns the wireless port.

Returns
Port, the Port object.

◆ getRadioBand()

WirelessRadioBand WirelessCommon::getRadioBand ( )

Get radio band.

Returns
enum<WirelessRadioBand>
eRadioAuto = 0, eRadioStandard = 1, // 20 MHz Channel - on linksys eRadioWide = 2 // 40 MHz Channel - on linksys

◆ getSsid()

string WirelessCommon::getSsid ( )

Returns the SSID.

Returns
string, the SSID.

◆ getStandardChannel()

StandardChannel WirelessCommon::getStandardChannel ( )

Get standard channel.

Returns
enum<StandardChannel>
eStandardChannel_1 = 0, // channel: 1 - 2.412GHz eStandardChannel_2 = 1, // channel: 2 - 2.417GHz eStandardChannel_3 = 2, // channel: 3 - 2.422GHz eStandardChannel_4 = 3, // channel: 4 - 2.427GHz eStandardChannel_5 = 4, // channel: 5 - 2.432GHz eStandardChannel_6 = 5, // channel: 6 - 2.437GHz eStandardChannel_7 = 6, // channel: 7 - 2.442GHz eStandardChannel_8 = 7, // channel: 8 - 2.447GHz eStandardChannel_9 = 8, // channel: 9 - 2.452GHz eStandardChannel_10 = 9, // channel: 10 - 2.457GHz eStandardChannel_11 = 10 // channel: 11 - 2.462GHz

◆ getWepProcess()

WEPProcess WirelessCommon::getWepProcess ( )

Returns the WEP process.

Returns
WEPProcess, the WEPProcess object.

◆ getWideChannel()

WideChannel WirelessCommon::getWideChannel ( )

Get wide channel.

Returns
enum<StandardChannel>
eWideChannel_Auto = 0, eWideChannel_3 = 1, eWideChannel_4 = 2, eWideChannel_5 = 3, eWideChannel_6 = 4, eWideChannel_7 = 5, eWideChannel_8 = 6, eWideChannel_9 = 7,

◆ getWpaProcess()

WPAProcess WirelessCommon::getWpaProcess ( )

Get Wpa Process.

Returns
WPAProcess, the process that handles and manipulates the WPA encryption process on wireless clients.

◆ resetAllAssociations()

void WirelessCommon::resetAllAssociations ( )

Resets all wireless associations.

◆ setAuthenType()

void WirelessCommon::setAuthenType ( WirelessAuthenType  )

◆ setEncryptType()

void WirelessCommon::setEncryptType ( WirelessEncryptType  )

Set encryption type \para type, enum<WirelessEncryptType> eEncryptNull = 0, eEncryptWep_64bit = 1, eEncryptWep_128bit = 2, eEncryptTKIP = 3, //Arun wpa eEncryptAES = 4.

Returns
none

◆ setNetworkType()

void WirelessCommon::setNetworkType ( WirelessNetworkType  )

◆ setPort()

bool WirelessCommon::setPort ( string  )

Sets the wireless port with the specified port.

Parameters
portName,portNamecan be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0

◆ setRadioBand()

void WirelessCommon::setRadioBand ( WirelessRadioBand  )

Set radio band.

Parameters
radioBand,enum<WirelessRadioBand>
eRadioAuto = 0, eRadioStandard = 1, // 20 MHz Channel - on linksys eRadioWide = 2 // 40 MHz Channel - on linksys

◆ setSsid()

void WirelessCommon::setSsid ( string  )

Sets the SSID.

Parameters
ssid,theSSID.

◆ setStandardChannel()

void WirelessCommon::setStandardChannel ( StandardChannel  )

Set standard channel \para type, enum<StandardChannel>
eStandardChannel_1 = 0, // channel: 1 - 2.412GHz eStandardChannel_2 = 1, // channel: 2 - 2.417GHz eStandardChannel_3 = 2, // channel: 3 - 2.422GHz eStandardChannel_4 = 3, // channel: 4 - 2.427GHz eStandardChannel_5 = 4, // channel: 5 - 2.432GHz eStandardChannel_6 = 5, // channel: 6 - 2.437GHz eStandardChannel_7 = 6, // channel: 7 - 2.442GHz eStandardChannel_8 = 7, // channel: 8 - 2.447GHz eStandardChannel_9 = 8, // channel: 9 - 2.452GHz eStandardChannel_10 = 9, // channel: 10 - 2.457GHz eStandardChannel_11 = 10 // channel: 11 - 2.462GHz.

Returns
none

◆ setWideChannel()

void WirelessCommon::setWideChannel ( WideChannel  )

Set wide channel.

Parameters
channel,enum<StandardChannel>
eWideChannel_Auto = 0, eWideChannel_3 = 1, eWideChannel_4 = 2, eWideChannel_5 = 3, eWideChannel_6 = 4, eWideChannel_7 = 5, eWideChannel_8 = 6, eWideChannel_9 = 7,
Returns
none

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