DeviceDescriptor Class Reference

Descriptor for a device. More...

Public Member Functions
DeviceType	getType ()
	Return device type. More...
string	getModel ()
	Get device model. More...
void	addSupportedModuleType (ModuleType)
	Add supported module type to device descriptor. More...
void	removeSupportedModuleType (ModuleType)
	Remove supported module type to device descriptor. More...
bool	isModuleTypeSupported (ModuleType)
	Check if module type is supported. More...
int	getSupportedModuleTypeCount ()
	Get the number of module type. More...
ModuleType	getSupportedModuleTypeAt (int)
	Get the supported module type at a specified index. More...
ModuleDescriptor	getRootModule ()
	Get the root module descriptor. More...
bool	isModelSupported ()
	Check if the descriptor is model supported. More...
int	getSpecifiedModelCount ()
	Get specified model count. More...
string	getSpecifiedModelAt (int)
	Get specified model at a specified index. More...
bool	isExistSpecifiedModel (string)
	Check if the model exist. More...
void	addSpecifiedModel (string)
	Add module model to support. More...
void	removeSpecifiedModel (string)
	Remove model model to support. More...
void	setModelSupportedFlag (bool)
	Set supported flag to the device descriptor. More...
void	addRequiredScriptModule (string)
	Add required script module. More...
void	removeRequiredScriptModule (string)
	Removed required script module. More...
int	getRequiredScriptModuleCount ()
	Get the number of required script module. More...
string	getRequiredScriptModuleAt (int)
	Get the name of the required script module at a specified index. More...

Detailed Description

Descriptor for a device.

Member Function Documentation

addRequiredScriptModule()

void DeviceDescriptor::addRequiredScriptModule

(

string

)

Add required script module.

Parameters

smId,script

module id

Returns

none

addSpecifiedModel()

void DeviceDescriptor::addSpecifiedModel

(

string

)

Add module model to support.

Parameters

model,specified

model

addSupportedModuleType()

void DeviceDescriptor::addSupportedModuleType

(

ModuleType

)

Add supported module type to device descriptor.

Parameters

type,module

type enum<ModuleType>, start with 0 and add 1 to subsequent module type eLineCard=0, // Line card eNetworkModule, // Network module eInterfaceCard, // Interface card ePtRouterModule, // Packet Tracer router module ePtSwitchModule, // Packet Tracer switch module ePtCloudModule, // Packet Tracer cloud module ePtRepeaterModule, // Packet Tracer repeater module ePtHostModule, // Packet Tracer host module ePtModemModule, ePtLaptopModule, ePtTVModule, eIpPhonePowerAdapter, ePtTabletPCModule, ePtPdaModule, ePtWirelessEndDeviceModule, ePtWiredEndDeviceModule, eTrs35, eUsb, eNonRemovableModule, // Non-removable module eASAModule, eASAPowerAdapter, ePtCellTowerModule, ePtIoeModule, ePtIoeNetworkModule, ePtIoeAnalogModule, ePtIoeDigitalModule, ePtIoeCustomIOModule, ePtIoePowerAdapter, ePtIoeMcuComponentPowerAdapter, ePtRouterPowerAdapter, eSfpModule, eAccessPointPowerAdaptor, eNonRemovableInterfaceCard, eCustomModuleType = 2000

getModel()

string DeviceDescriptor::getModel

(

)

Get device model.

Returns

string, device model in string format

getRequiredScriptModuleAt()

string DeviceDescriptor::getRequiredScriptModuleAt

(

int

)

Get the name of the required script module at a specified index.

Parameters

index,specified

index

Returns

string, script module name

getRequiredScriptModuleCount()

int DeviceDescriptor::getRequiredScriptModuleCount

(

)

Get the number of required script module.

Returns

int, number of required script module

getRootModule()

ModuleDescriptor DeviceDescriptor::getRootModule

(

)

Get the root module descriptor.

Returns

ModuleDescriptor, root module descriptor

getSpecifiedModelAt()

string DeviceDescriptor::getSpecifiedModelAt

(

int

)

Get specified model at a specified index.

Parameters

index,specified

index

Returns

string, the specified model name in string format

getSpecifiedModelCount()

int DeviceDescriptor::getSpecifiedModelCount

(

)

Get specified model count.

Returns

int, the number of specified model

getSupportedModuleTypeAt()

ModuleType DeviceDescriptor::getSupportedModuleTypeAt

(

int

)

Get the supported module type at a specified index.

Parameters

index,the

specified index

Returns

enum<ModuleType>, see different types documented in addSupportedModuleType() function

getSupportedModuleTypeCount()

int DeviceDescriptor::getSupportedModuleTypeCount

(

)

Get the number of module type.

Returns

int, number of module type

getType()

DeviceType DeviceDescriptor::getType

(

)

Return device type.

Returns

enum<DeviceType> start with 0 and add 1 for subsequent type eRouter = 0, eSwitch, eCloud, eBridge, eHub, eRepeater, eCoAxialSplitter, eAccessPoint, ePc, eServer, ePrinter, eWirelessRouter, eIpPhone, eDslModem, eCableModem, eRemoteNetwork, eMultiLayerSwitch, eLaptop, eTabletPC, ePda, eWirelessEndDevice, eWiredEndDevice, eTV, eHomeVoip, eAnalogPhone, eMultiUser, eASA, eIoE, eHomeGateway, eCellTower, eCentralOfficeServer, eCiscoAccessPoint, eEmbeddedCiscoAccessPoint, eSniffer, eMCU, eSBC, eThing, eMCUComponent, eEmbeddedServer, eWirelessLanController, ePLC, eCluster, eGeoIcon

isExistSpecifiedModel()

bool DeviceDescriptor::isExistSpecifiedModel

(

string

)

Check if the model exist.

Parameters

model,specified

model

Returns

bool, true if the model exist and false if it does not

isModelSupported()

bool DeviceDescriptor::isModelSupported

(

)

Check if the descriptor is model supported.

Returns

bool, true if model supported and false if not

isModuleTypeSupported()

bool DeviceDescriptor::isModuleTypeSupported

(

ModuleType

)

Check if module type is supported.

Parameters

type,enum<ModuleType>

type,module

type enum<ModuleType>, start with 0 and add 1 to subsequent module type eLineCard=0, // Line card eNetworkModule, // Network module eInterfaceCard, // Interface card ePtRouterModule, // Packet Tracer router module ePtSwitchModule, // Packet Tracer switch module ePtCloudModule, // Packet Tracer cloud module ePtRepeaterModule, // Packet Tracer repeater module ePtHostModule, // Packet Tracer host module ePtModemModule, ePtLaptopModule, ePtTVModule, eIpPhonePowerAdapter, ePtTabletPCModule, ePtPdaModule, ePtWirelessEndDeviceModule, ePtWiredEndDeviceModule, eTrs35, eUsb, eNonRemovableModule, // Non-removable module eASAModule, eASAPowerAdapter, ePtCellTowerModule, ePtIoeModule, ePtIoeNetworkModule, ePtIoeAnalogModule, ePtIoeDigitalModule, ePtIoeCustomIOModule, ePtIoePowerAdapter, ePtIoeMcuComponentPowerAdapter, ePtRouterPowerAdapter, eSfpModule, eAccessPointPowerAdaptor, eNonRemovableInterfaceCard, eCustomModuleType = 2000

Returns

bool, true if the module type is supported and false if not

removeRequiredScriptModule()

void DeviceDescriptor::removeRequiredScriptModule

(

string

)

Removed required script module.

Parameters

smId,script

module id

Returns

none

removeSpecifiedModel()

void DeviceDescriptor::removeSpecifiedModel

(

string

)

Remove model model to support.

Parameters

model,specified

model

removeSupportedModuleType()

void DeviceDescriptor::removeSupportedModuleType

(

ModuleType

)

Remove supported module type to device descriptor.

Parameters

type,module

type enum<ModuleType>, same type as param for addSupportedModuleType().

setModelSupportedFlag()

void DeviceDescriptor::setModelSupportedFlag

(

bool

)

Set supported flag to the device descriptor.

Parameters

isSupported,true

if supported and false if not

Returns

none

---

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

• CDeviceDescriptor.pki