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

PolicyMapQosClass handles and manipulates QoS classes. More...

Public Member Functions

void resetBandwidth ()
 Resets the bandwidth. More...
 
void setBandwidth (int)
 Sets the bandwidth value. More...
 
int getBandwidth ()
 Returns the bandwidth value. More...
 
void setBandwidthPercent (int)
 Sets the bandwidth percentage value. More...
 
int getBandwidthPercent ()
 Returns the bandwidth percentage value. More...
 
void setBandwidthRemainingPercent (int)
 Sets the bandwidth remaining percentage value. More...
 
int getBandwidthRemainingPercent ()
 Returns the bandwidth remaining percentage value. More...
 
bool isBandwidthConfigured ()
 Returns true if the bandwidth is configured, otherwise false. More...
 
void resetQueueLimit ()
 Resets the queue-limit. More...
 
int getQueueLimit ()
 Returns the queue-limit value. More...
 
void setQueueLimit (int)
 Sets the queue-limit value. More...
 
int getDefaultQueueLimit ()
 Returns the default queue-limit value. More...
 
void resetPriority ()
 Resets the priority. More...
 
void setPriority (int, int)
 Sets the priority. More...
 
int getPriority ()
 Returns the priority value. More...
 
void setPriorityPercent (int, int)
 Sets the priority percentage. More...
 
int getPriorityPercent ()
 Returns the priority percentage value. More...
 
int getPriorityBurst ()
 Returns the priority burst value. More...
 
int getPriorityBurstDefault ()
 Returns the default priority burst value. More...
 
bool isPriorityConfigured ()
 Returns true if the priority is configured, otherwise false. More...
 
void addSetDscpPrec (QoS::EWredType, bool, int)
 Adds DSCP or IP Precedence. More...
 
void removeSetDscpPrec ()
 Removes DSCP or IP Precedence. More...
 
PolicyClassSetDscp getSetDscpPrec ()
 Returns the DSCP or IP precedence. More...
 
void resetShapeAvgCir ()
 Resets the shaper average CIR. More...
 
void setShapeAvgCir (int)
 Sets shaper average CIR value. More...
 
bool isShapeConfigured ()
 Returns true if traffic shaping is configured, otherwise false. More...
 
int getFairQueueSize ()
 Returns the fair queue size value. More...
 
bool isFairQueueConfigured ()
 Returns true if fair queueing is configured, otherwise false. More...
 
int getDefaultFairQueueSize ()
 Returns the default fair queue size. More...
 
bool isClassDefault ()
 Returns true if class default, otherwise false. More...
 

Detailed Description

PolicyMapQosClass handles and manipulates QoS classes.

Member Function Documentation

◆ addSetDscpPrec()

void PolicyMapQosClass::addSetDscpPrec ( QoS::EWredType  ,
bool  ,
int   
)

Adds DSCP or IP Precedence.

Parameters
wredType,theQoS policy type. QoS policy types: eWredDscp = 0, eWredPrec = 1
ipv4Only,truefor IPv4 only, false for both IPv4 and IPv6.
value,thevalue for the QoS policy type.

◆ getBandwidth()

int PolicyMapQosClass::getBandwidth ( )

Returns the bandwidth value.

Returns
int, the bandwidth value.

◆ getBandwidthPercent()

int PolicyMapQosClass::getBandwidthPercent ( )

Returns the bandwidth percentage value.

Returns
int, the bandwidth percentage value.

◆ getBandwidthRemainingPercent()

int PolicyMapQosClass::getBandwidthRemainingPercent ( )

Returns the bandwidth remaining percentage value.

Returns
int, the bandwidth remaining percentage value.

◆ getDefaultFairQueueSize()

int PolicyMapQosClass::getDefaultFairQueueSize ( )

Returns the default fair queue size.

Returns
int, the default fair queue size.

◆ getDefaultQueueLimit()

int PolicyMapQosClass::getDefaultQueueLimit ( )

Returns the default queue-limit value.

Returns
int, the default queue-limit value.

◆ getFairQueueSize()

int PolicyMapQosClass::getFairQueueSize ( )

Returns the fair queue size value.

Returns
int, the fair queue size value.

◆ getPriority()

int PolicyMapQosClass::getPriority ( )

Returns the priority value.

Returns
int, the priority value.

◆ getPriorityBurst()

int PolicyMapQosClass::getPriorityBurst ( )

Returns the priority burst value.

Returns
int, the priority burst value.

◆ getPriorityBurstDefault()

int PolicyMapQosClass::getPriorityBurstDefault ( )

Returns the default priority burst value.

Returns
int, the default priority burst value.

◆ getPriorityPercent()

int PolicyMapQosClass::getPriorityPercent ( )

Returns the priority percentage value.

Returns
int, the priority percentage value.

◆ getQueueLimit()

int PolicyMapQosClass::getQueueLimit ( )

Returns the queue-limit value.

Returns
int, the queue-limit value.

◆ getSetDscpPrec()

PolicyClassSetDscp PolicyMapQosClass::getSetDscpPrec ( )

Returns the DSCP or IP precedence.

Returns
PolicyClassSetDscp, the PolicyClassSetDscp object.

◆ isBandwidthConfigured()

bool PolicyMapQosClass::isBandwidthConfigured ( )

Returns true if the bandwidth is configured, otherwise false.

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

◆ isClassDefault()

bool PolicyMapQosClass::isClassDefault ( )

Returns true if class default, otherwise false.

Returns
bool, true if class default, otherwise false.

◆ isFairQueueConfigured()

bool PolicyMapQosClass::isFairQueueConfigured ( )

Returns true if fair queueing is configured, otherwise false.

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

◆ isPriorityConfigured()

bool PolicyMapQosClass::isPriorityConfigured ( )

Returns true if the priority is configured, otherwise false.

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

◆ isShapeConfigured()

bool PolicyMapQosClass::isShapeConfigured ( )

Returns true if traffic shaping is configured, otherwise false.

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

◆ removeSetDscpPrec()

void PolicyMapQosClass::removeSetDscpPrec ( )

Removes DSCP or IP Precedence.

◆ resetBandwidth()

void PolicyMapQosClass::resetBandwidth ( )

Resets the bandwidth.

◆ resetPriority()

void PolicyMapQosClass::resetPriority ( )

Resets the priority.

◆ resetQueueLimit()

void PolicyMapQosClass::resetQueueLimit ( )

Resets the queue-limit.

◆ resetShapeAvgCir()

void PolicyMapQosClass::resetShapeAvgCir ( )

Resets the shaper average CIR.

◆ setBandwidth()

void PolicyMapQosClass::setBandwidth ( int  )

Sets the bandwidth value.

Parameters
bandwidth,thebandwidth value.

◆ setBandwidthPercent()

void PolicyMapQosClass::setBandwidthPercent ( int  )

Sets the bandwidth percentage value.

Parameters
percent,thebandwidth percentage value.

◆ setBandwidthRemainingPercent()

void PolicyMapQosClass::setBandwidthRemainingPercent ( int  )

Sets the bandwidth remaining percentage value.

Parameters
percent,thebandwidth remaining percentage value.

◆ setPriority()

void PolicyMapQosClass::setPriority ( int  ,
int   
)

Sets the priority.

Parameters
bandwidth,thepriority value.
burst,theburst value.

◆ setPriorityPercent()

void PolicyMapQosClass::setPriorityPercent ( int  ,
int   
)

Sets the priority percentage.

Parameters
percent,thepercentage value.
burst,theburst value.

◆ setQueueLimit()

void PolicyMapQosClass::setQueueLimit ( int  )

Sets the queue-limit value.

Parameters
limit,thequeue-limit value.

◆ setShapeAvgCir()

void PolicyMapQosClass::setShapeAvgCir ( int  )

Sets shaper average CIR value.

Parameters
cir,shaperaverage CIR value.

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