esmc_tod.h

CCSM Research Tools: Community Atmosphere Model (CAM)

/* $Id: ESMC_TOD.h,v 1.1.6.1 2002/04/24 03:25:21 erik Exp $ */

#ifndef ESMC_TOD_H
#define ESMC_TOD_H

#include "ESMC_BasicUtil.h"

/* 
!BOP
! !ROUTINE: Time of Day (TOD) Class
\begin{verbatim}
*/

enum TODType{ ESMC_TOD_TYPE_UNDEFINED,   /* Abbreviations */
	      ESMC_TOD_INT_SEC,          /* IS = integer seconds */
	      ESMC_TOD_INT_MSEC};        /* MS = integer milliseconds */

typedef enum TODType ESMC_TODType;

struct TODClass{
  ESMC_TODType type;
  int sec;
  int msec;
};

/* 
\end{verbatim}
!EOP
*/

typedef struct TODClass *ESMC_TOD;

typedef struct TODClass ESMC_TODClass;

/*============================================================================*
 * Public methods
 *============================================================================*/

extern int ESMC_TODConstructIS(ESMC_TOD this, int seconds);

extern int ESMC_TODConstructUndefined(ESMC_TOD this);

extern int ESMC_TODIncrement(ESMC_TOD this, ESMC_TOD inc, ESMC_TOD resultTOD, 
			    int *resultDays);

extern int ESMC_TODDecrement(ESMC_TOD this, ESMC_TOD dec, ESMC_TOD resultTOD, 
			    int *resultDays);

extern int ESMC_TODIsLater(ESMC_TOD earlyTOD, ESMC_TOD lateTOD, ESMC_Bool *isLater);

extern int ESMC_TODPrint(ESMC_TOD this);

#endif