GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > PBC / V4-9-0

Constituent: pbc     Tag: mv2304


Interface   Data Structures   File List   Data Fields   Globals  

PBC_pubdefs.h File Reference

Public interface to the PBC package functions. More...

#include "ITC/ITC_pubdefs.h"

Include dependency graph for PBC_pubdefs.h:

This graph shows which files directly or indirectly include this file:


Functions

unsigned int PBC_initialize (ITC_Task *task, ITC_TaskID tid)
 Initialize the PBC application-level functions.
unsigned int PBC_init (void)
 Initialize the PBC application-level functions using CDM.
unsigned int PBC_shutdown (void)
 Shut down the PBC application-level functions.

Detailed Description

Public interface to the PBC package functions.

  CVS $Id: PBC_pubdefs.h,v 1.6 2005/08/12 16:45:59 dmay Exp $
  

Function Documentation

unsigned int PBC_init void   ) 
 

Initialize the PBC application-level functions using CDM.

This function is a wrapper for PBC_initialize() that uses CDM to determine its parameters.

Returns:
Zero if successful.

A MSG code if an error occurs.

unsigned int PBC_initialize ITC_Task *  task_p,
ITC_TaskID  tid
 

Initialize the PBC application-level functions.

This function initializes the application-level portion of the PBC package. At the application level, there is no PBC task. Instead, the handlers for the PBC telecommands are attached to another task. If a valid value is provided for either the task_p or the tid parameter, then this function will attach the PBC command handlers to the corresponding task. If neither parameter is specified (by setting task_p to NULL and tid to -1), then it is assumed that the controlling task is responsible for attaching the PBC command handlers.

Parameters:
task_p Pointer to controlling task's description block.
tid ID of the controlling task.
Returns:
MSG code.

unsigned int PBC_shutdown void   ) 
 

Shut down the PBC application-level functions.

Returns:
MSG code.


Generated on Fri Oct 7 21:47:03 2005 by  doxygen 1.4.4