jausTime.c

/*****************************************************************************
 *  Copyright (c) 2008, University of Florida
 *  All rights reserved.
 *  
 *  This file is part of OpenJAUS.  OpenJAUS is distributed under the BSD 
 *  license.  See the LICENSE file for details.
 * 
 *  Redistribution and use in source and binary forms, with or without 
 *  modification, are permitted provided that the following conditions 
 *  are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 *       copyright notice, this list of conditions and the following
 *       disclaimer in the documentation and/or other materials provided
 *       with the distribution.
 *     * Neither the name of the University of Florida nor the names of its 
 *       contributors may be used to endorse or promote products derived from 
 *       this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 ****************************************************************************/
// File Name: jausTime.c
//
// Written By: Danny Kent (jaus AT dannykent DOT com)
//
// Version: 3.3.0a
//
// Date: 08/07/08
//
// Description: This file defines the functionality of a JausTime object

#include <stdio.h>
#include <stdlib.h>
#include <time.h>
#include "jaus.h"

// Private Function Prototypes
JausBoolean calculateTimeStamp(JausTime time);
JausBoolean calculateDateStamp(JausTime time);

JausTime jausTimeCreate(void)
{
	JausTime time = (JausTime)malloc(sizeof(JausTimeStruct));
	
	time->timeStamp = newJausUnsignedInteger(0);
	time->dateStamp = newJausUnsignedShort(0);

	time->millisec = newJausUnsignedShort(0);
	time->second = newJausUnsignedShort(0);
	time->minute = newJausUnsignedShort(0);
	time->hour = newJausUnsignedShort(0);
	time->day = newJausUnsignedShort(0);
	time->month = newJausUnsignedShort(0);
	time->year = newJausUnsignedShort(0);

	return time;
}

void jausTimeDestroy(JausTime time)
{
	free(time);
}

JausTime jausTimeClone(JausTime time)
{
	JausTime newTime = (JausTime)malloc(sizeof(JausTimeStruct));
	
	if (newTime)
	{
		newTime->timeStamp = time->timeStamp;
		newTime->dateStamp = time->dateStamp;
	
		newTime->millisec = time->millisec;
		newTime->second = time->second;
		newTime->minute = time->minute;
		newTime->hour = time->hour;
		newTime->day = time->day;
		newTime->month = time->month;
		newTime->year = time->year;
	}
	
	return newTime;
}


JausBoolean jausTimeCopy(JausTime dstTime, JausTime srcTime)
{
	if (!dstTime || !srcTime)
	{
		return JAUS_FALSE;
	}
	
	dstTime->timeStamp = srcTime->timeStamp;
	dstTime->dateStamp = srcTime->dateStamp;

	dstTime->millisec = srcTime->millisec;
	dstTime->second = srcTime->second;
	dstTime->minute = srcTime->minute;
	dstTime->hour = srcTime->hour;
	dstTime->day = srcTime->day;
	dstTime->month = srcTime->month;
	dstTime->year = srcTime->year;
	
	return JAUS_TRUE;
}


JausBoolean jausTimeSetCurrentTime(JausTime jausTime)
{
	struct tm *gmTime;
	time_t timeVal;
	
	// Get SystemTime
	time(&timeVal);
	
	gmTime = gmtime(&timeVal);

	// Populate members
	jausTime->millisec =	(unsigned short) 0;
	jausTime->second = 		(unsigned short) gmTime->tm_sec;
	jausTime->minute = 		(unsigned short) gmTime->tm_min;
	jausTime->hour = 		(unsigned short) gmTime->tm_hour;
	jausTime->day = 		(unsigned short) gmTime->tm_mday;
	jausTime->month = 		(unsigned short) gmTime->tm_mon;
	jausTime->year = 		(unsigned short) gmTime->tm_year + 1900;

	// Calculate TimeStamp & DataStamp
	calculateTimeStamp(jausTime);
	calculateDateStamp(jausTime);

	return JAUS_TRUE;
}

JausBoolean jausTimeToString(JausTime time, char *buffer, size_t buffSize)
{
	const char *months[] = {"January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"};

	if(time)
	{		
		sprintf(buffer, "%s %02d, %04d  %02d:%02d:%02d.%d\n", months[time->month], time->day, time->year, time->hour, time->minute, time->second, time->millisec);
		return JAUS_TRUE;
	}
	else
		return JAUS_FALSE;
}

JausBoolean jausTimeStampFromBuffer(JausTime input, unsigned char *buffer, unsigned int bufferSizeBytes)
{
	// Unpack TimeStamp
	if(!jausUnsignedIntegerFromBuffer(&input->timeStamp, buffer, bufferSizeBytes)) return JAUS_FALSE;
		
	// Calculate Members from TimeStamp
	input->millisec = (input->timeStamp >> JAUS_TIME_STAMP_MILLISEC_SHIFT) & JAUS_TIME_STAMP_MILLISEC_MASK;
	input->second = (input->timeStamp >> JAUS_TIME_STAMP_SECOND_SHIFT) & JAUS_TIME_STAMP_SECOND_MASK;
	input->minute = (input->timeStamp >> JAUS_TIME_STAMP_MINUTE_SHIFT) & JAUS_TIME_STAMP_MINUTE_MASK;
	input->hour = (input->timeStamp >> JAUS_TIME_STAMP_HOUR_SHIFT) & JAUS_TIME_STAMP_HOUR_MASK;
	input->day = (input->timeStamp >> JAUS_TIME_STAMP_DAY_SHIFT) & JAUS_TIME_STAMP_DAY_MASK;
	
	return JAUS_TRUE;
}

JausBoolean jausDateStampFromBuffer(JausTime input, unsigned char *buffer, unsigned int bufferSizeBytes)
{
	// Unpack DateStamp
	if(!jausUnsignedShortFromBuffer(&input->dateStamp, buffer, bufferSizeBytes)) return JAUS_FALSE;
		
	// Calculate Members from DateStamp
	input->day = (input->dateStamp >> JAUS_DATE_STAMP_DAY_SHIFT) & JAUS_DATE_STAMP_DAY_MASK;
	input->month = (input->dateStamp >> JAUS_DATE_STAMP_MONTH_SHIFT) & JAUS_DATE_STAMP_MONTH_MASK;
	input->year = (input->dateStamp >> JAUS_DATE_STAMP_YEAR_SHIFT) & JAUS_DATE_STAMP_YEAR_MASK;

	return JAUS_TRUE;
}

JausBoolean jausTimeStampToBuffer(JausTime input, unsigned char *buffer, unsigned int bufferSizeBytes)
{
	// Calculate TimeStamp
	calculateTimeStamp(input);
	
	// Pack TimeStamp
	if(!jausUnsignedIntegerToBuffer(input->timeStamp, buffer, bufferSizeBytes)) return JAUS_FALSE;
	
	return JAUS_TRUE;
}

JausBoolean jausDateStampToBuffer(JausTime input, unsigned char *buffer, unsigned int bufferSizeBytes)
{
	// Calculate DateStamp
	calculateDateStamp(input);
	
	// Pack TimeStamp
	if(!jausUnsignedShortToBuffer(input->dateStamp, buffer, bufferSizeBytes)) return JAUS_FALSE;
	
	return JAUS_TRUE;
}

JausUnsignedInteger jausTimeGetTimeStamp(JausTime time)
{
	// Calculate TimeStamp
	calculateTimeStamp(time);
	
	return time->timeStamp;	
}

JausUnsignedShort jausTimeGetDateStamp(JausTime time)
{
	// Calculate DateStamp
	calculateDateStamp(time);
	
	return time->dateStamp;
}

// Private Functions
JausBoolean calculateTimeStamp(JausTime time)
{
	time->timeStamp = 0;
	time->timeStamp |= (time->millisec & JAUS_TIME_STAMP_MILLISEC_MASK) << JAUS_TIME_STAMP_MILLISEC_SHIFT;
	time->timeStamp |= (time->second & JAUS_TIME_STAMP_SECOND_MASK) << JAUS_TIME_STAMP_SECOND_SHIFT;
	time->timeStamp |= (time->minute & JAUS_TIME_STAMP_MINUTE_MASK) << JAUS_TIME_STAMP_MINUTE_SHIFT;
	time->timeStamp |= (time->hour & JAUS_TIME_STAMP_HOUR_MASK) << JAUS_TIME_STAMP_HOUR_SHIFT;
	time->timeStamp |= (time->day & JAUS_TIME_STAMP_DAY_MASK) << JAUS_TIME_STAMP_DAY_SHIFT;

	return JAUS_TRUE;
}

JausBoolean calculateDateStamp(JausTime time)
{
	time->dateStamp = 0;
	time->dateStamp |= (time->day & JAUS_DATE_STAMP_DAY_MASK) << JAUS_DATE_STAMP_DAY_SHIFT;
	time->dateStamp |= (time->month & JAUS_DATE_STAMP_MONTH_MASK) << JAUS_DATE_STAMP_MONTH_SHIFT;
	time->dateStamp |= (time->year & JAUS_DATE_STAMP_YEAR_MASK) << JAUS_DATE_STAMP_YEAR_SHIFT;
	
	return JAUS_TRUE;
}