GRBP_windowState.h File Reference

Defines the window state (Tier1, Tier2 or GRB) and a set of inline routines to test for a given state. More...

Typedefs
typedef enum _GRBP_windowState	GRBP_windowState
Enumerations
enum	_GRBP_windowState {   GRBP_WINDOWSTATE_K_TIER1 = -1,   GRBP_WINDOWSTATE_K_TIER2 = 0,   GRBP_WINDOWSTATE_K_GRB = 1 }
	The window processing state. More...
Functions
static __inline int	GRBP__windowStateIsTier1 (GRBP_windowState state)
	Tests if the window is a tier 1 window.
static __inline int	GRBP__windowStateIsTier2 (GRBP_windowState state)
	Tests if the window is a tier 2 window.
static __inline int	GRBP__windowStateIsGrb (GRBP_windowState state)
	Tests if the window is a Grb window.

---

Detailed Description

Defines the window state (Tier1, Tier2 or GRB) and a set of inline routines to test for a given state.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: GRBP_windowState.h,v 1.1 2007/07/05 22:22:29 russell Exp $

---

Enumeration Type Documentation

enum GRBP_windowStateFor enum _GRBP_windowState

The window processing state.

Enumerator:

GRBP_WINDOWSTATE_K_TIER1	Tier1 state
GRBP_WINDOWSTATE_K_TIER2	Tier2 state
GRBP_WINDOWSTATE_K_GRB	GRB state

---

Function Documentation

static __inline int GRBP__windowStateIsGrb

(

GRBP_windowState

state

)

[static]

Tests if the window is a Grb window.

Returns:

Non-zero if the window is a GRB window, else 0

Parameters:

state

The window state

Referenced by windowListTier1LatUpdate(), and windowListTier2Update().

static __inline int GRBP__windowStateIsTier1

(

GRBP_windowState

state

)

[static]

Tests if the window is a tier 1 window.

Returns:

Non-zero if the window is a tier 1 window, else 0

Parameters:

state

The window state

Referenced by windowListTier1LatUpdate().

static __inline int GRBP__windowStateIsTier2

(

GRBP_windowState

state

)

[static]

Tests if the window is a tier 2 window.

Returns:

Non-zero if the window is a tier 2 window, else 0

Parameters:

state

The window state

Referenced by windowListTier2Update().