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

PolicyMap handles and manipulates policy maps. More...

Public Member Functions

int getClassCnt ()
 Returns the number of policies. More...
 
PolicyMapQosClass getClassAt (int)
 Returns QoS class at the specified index. More...
 
int getTotalBandwidth ()
 Returns the total bandwidth value. More...
 
int getTotalBandwidthPercent ()
 Returns the total bandwidth percentage. More...
 
int getTotalBandwidthRemainPercent ()
 Returns the total bandwidth remaining percentage. More...
 
bool isBandwidthConfigured ()
 Returns true if the bandwidth value is configured, otherwise false. More...
 
bool isPriorityConfigured ()
 Returns true if the priority is configured, otherwise false. More...
 
bool isFairQueueConfigured ()
 Returns true if fair queue is configured, otherwise false. More...
 
bool isShapeConfigured ()
 Returns true if traffic shaping is configured, otherwise false. More...
 
bool hasOutputFeature ()
 Returns true if the policy map has output feature, otherwise false. More...
 
bool hasGtsFeature ()
 Returns true if the policy map has GTS feature, otherwise false. More...
 
void updateOutputPort ()
 Updates the output port. More...
 
string getMapName ()
 Returns the name of the policy map. More...
 
QoS::eMapType getMapType ()
 Returns the type of the policy map. More...
 
void setMapType (QoS::eMapType)
 Sets the type of the policy map. More...
 
string toString (bool)
 Returns the name of the policy map. More...
 

Detailed Description

PolicyMap handles and manipulates policy maps.

Member Function Documentation

◆ getClassAt()

PolicyMapQosClass PolicyMap::getClassAt ( int  )

Returns QoS class at the specified index.

Parameters
index,theindex of the QoS class of interest.
Returns
PolicyMapQosClass, the PolicyMapQosClass object.

◆ getClassCnt()

int PolicyMap::getClassCnt ( )

Returns the number of policies.

Returns
int, the number of policies.

◆ getMapName()

string PolicyMap::getMapName ( )

Returns the name of the policy map.

Returns
string, the name of the policy map.

◆ getMapType()

QoS::eMapType PolicyMap::getMapType ( )

Returns the type of the policy map.

Returns
enum<QoS::eMapType>, the type of the policy map. Map types: type_default = 0, type_control = 1, type_inspect = 2, type_asaInspect = 3, type_logging = 4

◆ getTotalBandwidth()

int PolicyMap::getTotalBandwidth ( )

Returns the total bandwidth value.

Returns
int, the total bandwidth value.

◆ getTotalBandwidthPercent()

int PolicyMap::getTotalBandwidthPercent ( )

Returns the total bandwidth percentage.

Returns
int, the total bandwidth percentage.

◆ getTotalBandwidthRemainPercent()

int PolicyMap::getTotalBandwidthRemainPercent ( )

Returns the total bandwidth remaining percentage.

Returns
int, the total bandwidth remaining percentage.

◆ hasGtsFeature()

bool PolicyMap::hasGtsFeature ( )

Returns true if the policy map has GTS feature, otherwise false.

Returns
bool, true if the policy map has GTS feature, otherwise false.

◆ hasOutputFeature()

bool PolicyMap::hasOutputFeature ( )

Returns true if the policy map has output feature, otherwise false.

Returns
bool, true if the policy map has output feature, otherwise false.

◆ isBandwidthConfigured()

bool PolicyMap::isBandwidthConfigured ( )

Returns true if the bandwidth value is configured, otherwise false.

Returns
bool, true if the bandwidth value is configured, otherwise false.

◆ isFairQueueConfigured()

bool PolicyMap::isFairQueueConfigured ( )

Returns true if fair queue is configured, otherwise false.

Returns
bool, true if fair queue is configured, otherwise false.

◆ isPriorityConfigured()

bool PolicyMap::isPriorityConfigured ( )

Returns true if the priority is configured, otherwise false.

Returns
bool, true if the priority is configured, otherwise false.

◆ isShapeConfigured()

bool PolicyMap::isShapeConfigured ( )

Returns true if traffic shaping is configured, otherwise false.

Returns
bool, true if traffic shaping is configured, otherwise false.

◆ setMapType()

void PolicyMap::setMapType ( QoS::eMapType  )

Sets the type of the policy map.

Parameters
mapType,thetype of the policy map. Map types: type_default = 0, type_control = 1, type_inspect = 2, type_asaInspect = 3 type_logging = 4

◆ toString()

string PolicyMap::toString ( bool  )

Returns the name of the policy map.

Returns
string, the name of the policy map.

◆ updateOutputPort()

void PolicyMap::updateOutputPort ( )

Updates the output port.


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