---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > PBS / V2-10-5

Constituent: pbs     Tag: rad750

---

         

---

WCT_pvtdefs.ih File Reference

Package private interface and typedefs for the WCT (Wall Clock Time) facility. More...

#include "PBI/Inline.h"
#include "PBI/Attribute.h"
#include "PBS/WCT.h"
#include "WCT_pvtdefs.h"

Include dependency graph for WCT_pvtdefs.ih:

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

Defines
#define	WCT__EXP_PROTO   INLINE_USR_EXP_PROTO
	Inline declaration for an exportable proto-type declaration.
#define	WCT__EXP_FNC   INLINE_USR_EXP_FNC
	Inline declaration for an exportable function declaration.
#define	WCT__LCL_PROTO   INLINE_USR_LCL_PROTO
	Inline declaration for a static/local proto-type declaration.
#define	WCT__LCL_FNC   INLINE_USR_LCL_FNC
	Inline declaration for an static/local function declaration.
Functions
WCT__EXP_PROTO WCT_time	WCT__utb_get (void) ATTR_UNUSED_OK
	Fetches the current absolute time, using the UNIX epoch as a base/.
WCT__EXP_PROTO WCT_time	WCT__to_utb (WCT_time lat_epoch_time) ATTR_UNUSED_OK
	Converts a wall clock time specified with a base of the LAT epoch to a wall clock time specified with a base of the tradional UNIX epoch.
WCT__EXP_PROTO WCT_time	WCT__from_utb (WCT_time unix_epoch_time) ATTR_UNUSED_OK
	Converts a wall clock time specified with a base of the LAT epoch to a wall clock time specified with a base of the tradional UNIX epoch.
WCT__EXP_PROTO WCT_time_sat	WCT__sat_get (void) ATTR_UNUSED_OK
	Retrieves the current time in absolute time units. The format is in Spectrum-Astro Standard Time format.
WCT__EXP_PROTO WCT_time_sat	WCT__to_sat (WCT_time lat_epoch_time) ATTR_UNUSED_OK
	Converts a wall clock time specified with Spectrum-Astro Standard Format.
WCT__EXP_PROTO WCT_time	WCT__from_sat (WCT_time_sat sat_time) ATTR_UNUSED_OK
	Converts a Spectrum Astro Time Format to LAT format.

---

Detailed Description

Package private interface and typedefs for the WCT (Wall Clock Time) facility.

Author:

JJRussell - russell@slac.stanford.edu

    CVS $Id: WCT_pvtdefs.ih,v 1.3 2005/01/31 23:53:29 russell Exp $
   

This file just vectors to the correct implementation

---

Define Documentation

#define WCT__EXP_FNC   INLINE_USR_EXP_FNC

Inline declaration for an exportable function declaration. The exact declaration of this symbol is dependent on both the compiler and whether the symbol WCT__EXPORT_FILE is defined.

#define WCT__EXP_PROTO   INLINE_USR_EXP_PROTO

Inline declaration for an exportable proto-type declaration. The exact declaration of this symbol is dependent on both the compiler and whether the symbol WCT__EXPORT_FILE is defined.

#define WCT__LCL_FNC   INLINE_USR_LCL_FNC

Inline declaration for an static/local function declaration. The exact declaration of this symbol is dependent on both the compiler and whether the symbol WCT__EXPORT_FILE is defined.

#define WCT__LCL_PROTO   INLINE_USR_LCL_PROTO

Inline declaration for a static/local proto-type declaration. The exact declaration of this symbol is dependent on both the compiler and whether the symbol WCT__EXPORT_FILE is defined.

---

Function Documentation

WCT__EXP_FNC WCT_time WCT__from_sat (  WCT_time_sat  sat_time  )

Converts a Spectrum Astro Time Format to LAT format. Parameters: sat_time  The wall clock time in Spectrum-Astro Format Returns: The wall clock time in LAT format

WCT__EXP_FNC WCT_time WCT__from_utb (  WCT_time  unix_epoch_time  )

Converts a wall clock time specified with a base of the LAT epoch to a wall clock time specified with a base of the tradional UNIX epoch. Parameters: unix_epoch_time  The wall clock time using the LAT epoch as a base Returns: The wall clock time using the UNIX epoch as a base

WCT__EXP_FNC WCT_time_sat WCT__to_sat (  WCT_time  lat_epoch_time  )

Converts a wall clock time specified with Spectrum-Astro Standard Format. Parameters: lat_epoch_time  The wall clock time using the LAT epoch as a base Returns: The wall clock time using in Spectrum-Astro Standard Format.

WCT__EXP_FNC WCT_time WCT__to_utb (  WCT_time  lat_epoch_time  )

Converts a wall clock time specified with a base of the LAT epoch to a wall clock time specified with a base of the tradional UNIX epoch. Parameters: lat_epoch_time  The wall clock time using the LAT epoch as a base Returns: The wall clock time using the UNIX epoch as a base

WCT_time WCT__utb_get (  void   )

Fetches the current absolute time, using the UNIX epoch as a base/. Returns: The current absolute time

Here is the call graph for this function:

---