PBC_control.h File Reference

Interface to the PBC_control.c functions. More...

#include <ITC/ITC_pubdefs.h>
#include <PBS/FPA.h>
#include <PBS/MTX.ih>

Classes
struct	_PBC_Control
	PBC control block. More...
Typedefs
typedef enum _PBC_ControlState	PBC_ControlState
	Typedef for _PBC_ControlState.
typedef struct _PBC_Control	PBC_Control
	Typedef for _PBC_Control.
Enumerations
enum	_PBC_ControlState {   PBC_CTL_UNKNOWN = 0,   PBC_CTL_UNINITIALIZED = 1,   PBC_CTL_INITIALIZING = 2,   PBC_CTL_INITIALIZED = 3,   PBC_CTL_SHUTDOWN = 4 }
	Valid control block states. More...
Variables
PBC_Control *	PBC_pbc
	Control block for PBC.

---

Detailed Description

Interface to the PBC_control.c functions.

    CVS $Id: PBC_control.h,v 1.8 2011/03/29 23:14:58 apw Exp $
    

Defines the interface to the functions found in PBC_control.c.

---

Enumeration Type Documentation

enum _PBC_ControlState

Valid control block states.

Enumerator:

PBC_CTL_UNKNOWN	Unknown state (guard value).
PBC_CTL_UNINITIALIZED	The PBC functions have not been initialized or they failed to initialize. Use PBC_initialize() to initialize them.
PBC_CTL_INITIALIZING	The PBC functions are in the process of being initialized by PBC_initialize().
PBC_CTL_INITIALIZED	The PBC functions have been initialized and are ready to be used or shutdown by PBC_shutdown().
PBC_CTL_SHUTDOWN	The PBC functions are in the process of being shutdown by PBC_shutdown().

---

Variable Documentation

PBC_Control* PBC_pbc

Control block for PBC.

Pointer to the control block (state) for the PBC application-level functions. The actual control block buffer is allocated during PBC_initialize().

Pointer to the control block (state) for the PBC application-level functions.