das1.h File Reference

Das 1 Compatability Utilities. More...

#include <stdio.h>
#include <das2/time.h>
#include <das2/defs.h>

Include dependency graph for das1.h:

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

Go to the source code of this file.

Functions
DAS_API void	_swapBufInPlace (void *pMem, size_t szEach, size_t numItems)
	Swap whole buffers in place.
DAS_API float	swapFloat (float rIn)
	Swap single floats, returns new float.
DAS_API void	swapU4 (uint32_t *pIn)
	Swap uint4 in place.
DAS_API int	parsetime (const char *string, int *year, int *month, int *mday, int *yday, int *hour, int *minute, double *second)
	Convert most human-parseable time strings to numeric components returns 0 on success and non-zero on failure.
DAS_API double	ttime (int *year, int *month, int *mday, int *yday, int *hour, int *minute, double *second)
	Convert time components to double seconds since epoch. More...
DAS_API void	emitt (double tt, int *year, int *month, int *mday, int *yday, int *hour, int *minute, double *second)
	convert double seconds since epoch to time components. More...
DAS_API void	tnorm (int *year, int *month, int *mday, int *yday, int *hour, int *minute, double *second)
	normalize date and time components NOTE: yday is OUTPUT only. More...
void	yrdy1958 (int *pYear, int *pDoy, int days_since_1958)
	Return a year and day of year given the number of days past 1958. More...
int	past_1958 (int year, int day)
	Get the number of days since 1958-01-01 given a year and day of year.
void	ms2hms (int *pHour, int *pMin, float *pSec, double ms_of_day)
	Return the hours, minutes and seconds of a day given then number of milliseconds since the start of the day. More...
int	getpkt (char *ph, ubyte *data, int max)
	Read a Tagged Das 1 packet from stdin. More...
int	fgetpkt (FILE *fin, char *ph, ubyte *data, int max)
	Read a Tagged Das 1 packet from a file object. More...
int	putpkt (const char *ph, const ubyte *data, const int bytes)
	Write das packet to stdout. More...

Detailed Description

Das 1 Compatability Utilities.

Function Documentation

ttime()

DAS_API double ttime	(	int *	year,
		int *	month,
		int *	mday,
		int *	yday,
		int *	hour,
		int *	minute,
		double *	second
	)

Convert time components to double seconds since epoch.

Converts time components to a double precision floating point value (seconds since the beginning of 1958, ignoring leap seconds) and normalize inputs. Note that this floating point value should only be used for "internal" purposes. (There's no need to propagate yet another time system, plus I want to be able to change/fix these values.)

There is no accommodation for calendar adjustments, for example the transition from Julian to Gregorian calendar, so I wouldn't recommend using these routines for times prior to the 1800's. Sun IEEE 64-bit floating point preserves millisecond accuracy past the year 3000. For various applications, it may be wise to round to nearest millisecond (or microsecond, etc.) after the value is returned.

Note

that day-of-year (yday) is an output-only parameter for all of these functions. To use day-of-year as input, set month to 1 and pass day-of-year in mday instead.

Warning

This function can change it's input values! The time will be normalized this could change the input time.

emitt()

DAS_API void emitt	(	double	tt,
		int *	year,
		int *	month,
		int *	mday,
		int *	yday,
		int *	hour,
		int *	minute,
		double *	second
	)

convert double seconds since epoch to time components.

emitt (ttime backwards) converts double precision seconds (since the beginning of 1958, ignoring leap seconds) to date and time components.

tnorm()

DAS_API void tnorm	(	int *	year,
		int *	month,
		int *	mday,
		int *	yday,
		int *	hour,
		int *	minute,
		double *	second
	)

normalize date and time components NOTE: yday is OUTPUT only.

To add a day to a time, increment mday as much as needed and then call tnorm.

yrdy1958()

void yrdy1958	(	int *	pYear,
		int *	pDoy,
		int	days_since_1958
	)

Return a year and day of year given the number of days past 1958.

This function is useful for years 1958 to 2096, for years greater than 2096 it runs off the end of an internal buffer.

Parameters

[out]	pYear	a pointer to an integer to receive the 4 digit year number
[out]	pDoy	a pointer to an integer to recieve the day of year number (1 = Jan. 1st)
[in]	days_since_1958	The number of days since Jan. 1st, 1958

ms2hms()

void ms2hms	(	int *	pHour,
		int *	pMin,
		float *	pSec,
		double	ms_of_day
	)

Return the hours, minutes and seconds of a day given then number of milliseconds since the start of the day.

Parameters

[out]	pHour	a pointer to an integer to receive the hour of the day (midnight = 0)
[out]	pMin	a pointer to an integer to receive the minute of the hour.
[out]	pSec	a pointer to a float to receive the seconds of the minute. Result is (of course) accurate to milliseconds.
[in]	ms_of_day	the milliseconds of day value.

getpkt()

int getpkt	(	char *	ph,
		ubyte *	data,
		int	max
	)

Read a Tagged Das 1 packet from stdin.

Parameters

ph	8-byte packet header
data	buffer,
max	number of bytes to read

Returns

number of bytes read

fgetpkt()

int fgetpkt	(	FILE *	fin,
		char *	ph,
		ubyte *	data,
		int	max
	)

Read a Tagged Das 1 packet from a file object.

Parameters

[in]	fin	input file pointer
[out]	ph	pointer to buffer to receive the 8-byte packet header
[out]	data	buffer,
[in]	max	number of bytes to read

Returns

number of bytes read

putpkt()

int putpkt	(	const char *	ph,
		const ubyte *	data,
		const int	bytes
	)

Write das packet to stdout.

Parameters

ph	8-byte packet header, ex: ":b0:78F2"
data	buffer
bytes	number of bytes to write (why this isn't taken from the packet header I don't know)

Returns

1 on success and 0 on failure