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

The factory of devices. More...

Public Member Functions

DeviceDescriptor getDescriptor (DeviceType, string)
 Returns the Descriptor of the device. More...
 
int getAvailableDeviceCount ()
 Returns the number of available device type. More...
 
DeviceDescriptor getAvailableDeviceAt (int)
 Returns the available device descriptorat a specified index. More...
 
int getAvailableDeviceForTypeCount (DeviceType)
 Returns the available device model for a specified type. More...
 
DeviceDescriptor getAvailableDeviceForTypeAt (DeviceType, int)
 Returns the available device descriptor of a specified type at a specified index. More...
 

Detailed Description

The factory of devices.

Member Function Documentation

◆ getAvailableDeviceAt()

DeviceDescriptor DeviceFactory::getAvailableDeviceAt ( int  )

Returns the available device descriptorat a specified index.

Parameters
index,aspecified index
Returns
DeviceDescriptor, DeviceDescriptor object

◆ getAvailableDeviceCount()

int DeviceFactory::getAvailableDeviceCount ( )

Returns the number of available device type.

Returns
int, number of available device type

◆ getAvailableDeviceForTypeAt()

DeviceDescriptor DeviceFactory::getAvailableDeviceForTypeAt ( DeviceType  ,
int   
)

Returns the available device descriptor of a specified type at a specified index.

Parameters
type,enum<DeviceType>- see documentation for function getDescriptor() above
index,aspecified index
Returns
DeviceDescriptor, DeviceDescriptor object

◆ getAvailableDeviceForTypeCount()

int DeviceFactory::getAvailableDeviceForTypeCount ( DeviceType  )

Returns the available device model for a specified type.

Parameters
type,enum<DeviceType>- see documentation for function getDescriptor() above
Returns
int, the available device model for a specified type

◆ getDescriptor()

DeviceDescriptor DeviceFactory::getDescriptor ( DeviceType  ,
string   
)

Returns the Descriptor of the device.

Parameters
type,enum<DeviceType>
Returns
enum<DeviceType>, the type of this device. Device types: eRouter = 0, eSwitch = 1, eCloud = 2, eBridge = 3, eHub = 4, eRepeater = 5, eCoAxialSplitter = 6, eAccessPoint = 7, ePc = 8, eServer = 9, ePrinter = 10, eWirelessRouter = 11, eIpPhone = 12, eDslModem = 13, eCableModem = 14, eRemoteNetwork = 15, eMultiLayerSwitch = 16, eLaptop = 17, eTabletPC = 18, ePda = 19, eWirelessEndDevice = 20, eWiredEndDevice = 21, eTV = 22, eHomeVoip = 23, eAnalogPhone = 24, eMultiUser = 25, eASA = 26, eIoE = 27, eHomeGateway = 28, eCellTower = 29, eCentralOfficeServer = 30, eWirelessLanController = 31,
Parameters
model,thedevice model in string format

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