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

Physical view for module. More...

Public Member Functions

void setIsPower (bool)
 Sets if the power is on or off. More...
 
bool isPower ()
 Gets if the power is on or off. More...
 
void setSlotNum (int)
 Sets the slot number used by the view. More...
 
int getSlotNum ()
 Gets the slot number used by the view. More...
 
void setModuleAdded (bool)
 Sets weither a module is in the view. More...
 
bool getModuleAdded ()
 Gets weither a module is in the view. More...
 
void setIsNonRemovable (bool)
 Sets weither it is non-removable. More...
 
bool isNonRemovable ()
 Gets weither it is non-removable. More...
 
void setHorizontal (bool)
 Used for power buttons, sets if it is a horzontal button or a vertical button. More...
 
bool isHorizontal ()
 Used for power buttons, Gets if it is a horzontal button or a vertical button. More...
 
void setX1 (int)
 Sets leftmost x coordintate. More...
 
int getX1 ()
 Gets leftmost x coordintate. More...
 
void setX2 (int)
 Sets rightmost x coordintate. More...
 
int getX2 ()
 Gets rightmost x coordintate. More...
 
void setY1 (int)
 Sets top y coordintate. More...
 
int getY1 ()
 Gets top y coordintate. More...
 
void setY2 (int)
 Sets bottom y coordintate. More...
 
int getY2 ()
 Gets bottom y coordintate. More...
 

Detailed Description

Physical view for module.

Member Function Documentation

◆ getModuleAdded()

bool ModulePhysicalView::getModuleAdded ( )

Gets weither a module is in the view.

Returns
bool, true if a module is in the view, false if not.

◆ getSlotNum()

int ModulePhysicalView::getSlotNum ( )

Gets the slot number used by the view.

Returns
int, slot number to use.

◆ getX1()

int ModulePhysicalView::getX1 ( )

Gets leftmost x coordintate.

Returns
int, the leftmost x coordintate.

◆ getX2()

int ModulePhysicalView::getX2 ( )

Gets rightmost x coordintate.

Returns
int, the rightmost x coordintate.

◆ getY1()

int ModulePhysicalView::getY1 ( )

Gets top y coordintate.

Returns
int, the top y coordintate.

◆ getY2()

int ModulePhysicalView::getY2 ( )

Gets bottom y coordintate.

Returns
int, the bottom y coordintate.

◆ isHorizontal()

bool ModulePhysicalView::isHorizontal ( )

Used for power buttons, Gets if it is a horzontal button or a vertical button.

Returns
bool, true if it is a horizontal button, false if it is vertical.

◆ isNonRemovable()

bool ModulePhysicalView::isNonRemovable ( )

Gets weither it is non-removable.

Returns
bool, true if it can't be removed, false if it can.

◆ isPower()

bool ModulePhysicalView::isPower ( )

Gets if the power is on or off.

Returns
bool, true if power on, false for off.

◆ setHorizontal()

void ModulePhysicalView::setHorizontal ( bool  )

Used for power buttons, sets if it is a horzontal button or a vertical button.

Parameters
bHor,trueif it is a horizontal button, false if it is vertical.

◆ setIsNonRemovable()

void ModulePhysicalView::setIsNonRemovable ( bool  )

Sets weither it is non-removable.

Parameters
bNonRemovable,trueif it can't be removed, false if it can.

◆ setIsPower()

void ModulePhysicalView::setIsPower ( bool  )

Sets if the power is on or off.

Parameters
bPower,trueto set power on, false for off.

◆ setModuleAdded()

void ModulePhysicalView::setModuleAdded ( bool  )

Sets weither a module is in the view.

Parameters
bAdded,trueif a module is in the view, false if not.

◆ setSlotNum()

void ModulePhysicalView::setSlotNum ( int  )

Sets the slot number used by the view.

Parameters
slotNum,slotnumber to use.

◆ setX1()

void ModulePhysicalView::setX1 ( int  )

Sets leftmost x coordintate.

Parameters
X1,theleftmost x coordintate.

◆ setX2()

void ModulePhysicalView::setX2 ( int  )

Sets rightmost x coordintate.

Parameters
X2,therightmost x coordintate.

◆ setY1()

void ModulePhysicalView::setY1 ( int  )

Sets top y coordintate.

Parameters
Y1,thetop y coordintate.

◆ setY2()

void ModulePhysicalView::setY2 ( int  )

Sets bottom y coordintate.

Parameters
Y2,thebottom y coordintate.

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