iokit/IOKit/pwr_mgt/IOPMPowerSourceList.h

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