Public Member Functions | Static Public Attributes | List of all members
Pool Class Reference

Public Member Functions

def __init__ (self, free=None)
def __repr__ (self)
def add (self, item)
def checkin (self, item)
def checkout (self)
def cleanup (self, cleanupFunc=None)
def getNumItems (self)
def hasFree (self)
def isFree (self, item)
def isUsed (self, item)
def remove (self, item)
def reset (self)

Static Public Attributes

 notify = DirectNotifyGlobal.directNotify.newCategory("Pool")

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  free = None 

Member Function Documentation

◆ __repr__()

def __repr__ (   self)

◆ add()

def add (   self,
Add an item to the free list.

◆ checkin()

def checkin (   self,
Put back a checked out item.
Error if the item is not checked out.

◆ checkout()

def checkout (   self)
Get an arbitrary item from the pool.

◆ cleanup()

def cleanup (   self,
  cleanupFunc = None 
Completely cleanup the pool and all of its objects.
cleanupFunc will be called on every free and used item.

◆ getNumItems()

def getNumItems (   self)
Returns the number of free items and the number of used items.

◆ hasFree()

def hasFree (   self)
Returns true if there is at least one free item.

◆ isFree()

def isFree (   self,
Returns true if this item is free for check out.

◆ isUsed()

def isUsed (   self,
Returns true if this item has already been checked out.

◆ remove()

def remove (   self,
Remove an item. Error is flagged if the item is not in the pool.

◆ reset()

def reset (   self)
Resets the pool so all items are free.

Member Data Documentation

◆ notify

notify = DirectNotifyGlobal.directNotify.newCategory("Pool")