CascadePowerLED Class Reference

represents the power led, if present More...

#include <cascade/app/CascadePowerLED.h>

Inheritance diagram for CascadePowerLED:

List of all members.

Public Member Functions
	CascadePowerLED ()
virtual	~CascadePowerLED ()
bool	IsPresent ()
bool	IsOn ()
bool	IsOff ()
bool	TurnOn ()
bool	TurnOff ()

---

Detailed Description

represents the power led, if present

Skip the description

CascadePowerLED represents the power led and can be used to get and set the power led state in a simple and convenient manner.

---

class CascadePowerLED

---

Constructor & Destructor Documentation

CascadePowerLED::CascadePowerLED (   )

the power led constructor construct a CascadePowerLED to control the power led if present

virtual CascadePowerLED::~CascadePowerLED (   )  [virtual]

the power led destructor The power led destructor.

---

Member Function Documentation

bool CascadePowerLED::IsOff (   )

determines whether or not the power led is off IsOff() determines whether or not the power led is currently off. Returns: whether or not the power led is off See also: IsPresent(), IsOn()

bool CascadePowerLED::IsOn (   )

determines whether or not the power led is on IsOn() determines whether or not the power led is currently on. Returns: whether or not the power led is on See also: IsPresent(), IsOff()

bool CascadePowerLED::IsPresent (   )

determines whether or not the power led is present IsPresent() determines whether or not the system contains a controllable power led. If IsPresent() returns false, then IsOff() will always return true, and IsOn(), TurnOn(), and TurnOff() will always return false. Returns: whether or not a controllable power led is present See also: IsOn(), IsOff(), TurnOn(), TurnOff()

bool CascadePowerLED::TurnOff (   )

turns the power led off TurnOff() turns off the power led. Returns: whether or not the power led was turned off successfully See also: IsPresent(), TurnOn()

bool CascadePowerLED::TurnOn (   )

turns the power led on TurnOn() turns on the power led. Returns: whether or not the power led was turned on successfully See also: IsPresent(), TurnOff()

---

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

• CascadePowerLED.h

---