iokit/IOKit/pwr_mgt/IOPMPowerSourceList.h

   1 /*
   2  * Copyright (c) 1998-2005 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License.  The rights granted to you under the
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 #include <libkern/c++/OSObject.h>
  31 #include <IOKit/IOReturn.h>
  32
  33 class IOPMPowerSource;
  34
  35 class IOPMPowerSourceList : public OSObject
  36 {
  37     OSDeclareDefaultStructors(IOPMPowerSourceList)
  38  private:
  39     // pointer to first power source in list
  40     IOPMPowerSource         *firstItem;
  41
  42     // how many power sources are in the list
  43     unsigned long           length;
  44
  45   public:
  46     void initialize(void);
  47     void free(void);
  48
  49     unsigned long numberOfItems(void);
  50     IOReturn addToList(IOPMPowerSource *newPowerSource);
  51     IOReturn removeFromList(IOPMPowerSource *theItem);
  52
  53     IOPMPowerSource *firstInList(void);
  54     IOPMPowerSource *nextInList(IOPMPowerSource *currentItem);
  55 };
  56