CRDSS_Task1_05-12_OnlineDocumentationSystem

• Title: CRDSS Task 1.05-12 - System Integration Issues Documentation - On-line Documentation System
• Description: This memorandum discusses methods of delivering an on-line documentation system for the CRDSS.
• Decision Support - Doc Type: Task Memorandum
• Date: 6/29/1994
• DSS Category: DMI Utilities
• DSS: Colorado River
• Basin: Colorado Mainstem
• Contract/PO #: C153658, C153727, C153752
• Grant Type: Non-Reimbursable
• Bill Number: SB92-87, HB93-1273, SB94-029, HB95-1155, SB96-153, HB97-008
• Prepared By: Riverside Technology inc.

.\" history:
.\"
.\" 1.0 (1-17-94)Steven A. Malers, RTi
.TH DBReadTS 3CRDSS "Read TS"
.SH NAME
DBReadTS - read a TS file and store in TS data structure
.SH SYNOPSIS
#include "DB.h"
int DBReadTS ( char *tsid, int *m1, int *y1, int *m2, int *y2, TimeSeries *ts )
.SH DESCRIPTION
Given the identifier for a time series (TS), the
.I DBReadTS
function initializes a TS and fills its data structure with values read from
the database. Other TS data are also initialized at this time. The conventions
used to define the TS identifier are discussed in
.I TimeSeries(3).
All months and years are calendar values and not water year values (1=January,
12=December).
The following table summarizes function arguments:
.nf
.ta 1.0i 1.75i 3.5i
Input/
VariableOutputTypeDescription
tsidIchar *TS identifier.
m1I/Oint *Pointer to first month to be read.
If zero, the returned value is
the first available month.
y1I/Oint *Pointer to first year to be read.
If zero, the returned value is
the first available year.
m2I/Oint *Pointer to last month to be read.
If zero, the returned value is
the last available month.
y2I/Oint *Pointer to last year to be read.
If zero, the returned value is
the last available year.
tsOTimeSeries *Pointer to TS data structure.
.ta
.fi
.SH LIMITATIONS
The only TS that the routine knows how to retrieve are streamflows,
temperatures, precipitations, and demands.
.SH DIAGNOSTICS
This routine returns STATUS_SUCCESS if successful, STATUS_BAD_ID
if the TS identifier cannot be resolved,
and STATUS_FAILURE if there are other errors.
.SH SEE ALSO
TimeSeries(3CRDSS)
.SH AUTHOR
Steven A. Malers, Riverside Technology, inc., Fort Collins, CO.
Figure 5. Typical library routine man page (source file)
17
A275 06.29.94 1.05-12 Malers