cvs commit: logging-log4cxx/include/log4cxx/helpers timezone.h

[mc...@apache.org]

mcatan      2004/04/02 00:30:03

  Added:       include/log4cxx/helpers timezone.h
  Log:
  added class TimeZone
  
  Revision  Changes    Path
  1.1                  logging-log4cxx/include/log4cxx/helpers/timezone.h
  
  Index: timezone.h
  ===================================================================
  /***************************************************************************
   * Copyright (C) The Apache Software Foundation. All rights reserved.      *
   *                                                                         *
   * This software is published under the terms of the Apache Software       *
   * License version 1.1, a copy of which has been included with this        *
   * distribution in the license.apl file.                                   *
   ***************************************************************************/
  
  #ifndef _LOG4CXX_HELPERS_TIMEZONE_H
  #define _LOG4CXX_HELPERS_TIMEZONE_H
  
  #include <log4cxx/config.h>
  #include <log4cxx/helpers/tchar.h>
  #include <log4cxx/helpers/objectimpl.h>
  #include <log4cxx/helpers/objectptr.h>
  #include <map>
  
  namespace log4cxx
  {
  	namespace helpers
  	{
  		class TimeZone;
  		typedef helpers::ObjectPtrT<TimeZone> TimeZonePtr;
  
  		class LOG4CXX_EXPORT TimeZone : public helpers::ObjectImpl
  		{
  		public:
  			DECLARE_ABSTRACT_LOG4CXX_OBJECT(TimeZone)
  			BEGIN_LOG4CXX_CAST_MAP()
  				LOG4CXX_CAST_ENTRY(TimeZone)
  			END_LOG4CXX_CAST_MAP()
  
  			TimeZone(const String& ID);
  			~TimeZone();
  
  			/**
  			Returns the offset of this time zone from UTC at the specified
  			date. If Daylight Saving Time is in effect at the specified date,
  			the offset value is adjusted with the amount of daylight saving.
  
  			@param date the date represented in milliseconds since January 1, 
  			1970 00:00:00 GMT 
  			@return the amount of time in milliseconds to add to UTC to get
  			local time.
  			*/
  			int getOffset(int64_t date) const;
  
  			static TimeZonePtr getDefault();
  			static TimeZonePtr getTimeZone(const String& ID);
  
  			/** 
  			Queries if the given date is in daylight savings time in this time
  			zone.
  			@param date the given Date. 
  			@return true if the given date is in daylight savings time, false,
  			otherwise.
  			*/
  			bool inDaylightTime(int64_t date) const;
  
  			/**
  			Returns the amount of time to be added to local standard time to
  			get	local wall clock time.
  
  			@return the amount of saving time in milliseconds
  			*/
  			inline int getDSTSavings() const
  				{ return DSTSavings; }
  
  			/**
  			Returns the amount of time in milliseconds to add to UTC to get
  			standard time in this time zone. 
  			
  			Because this value is not affected by daylight saving time, it is
  			called raw offset.
  
  			@return the amount of raw offset time in milliseconds to add to
  			UTC.
  			*/
  			inline int getRawOffset() const
  				{ return rawOffset; }
  				
  			/**
  			Queries if this time zone uses daylight savings time.
  			@return true if this time zone uses daylight savings time, false,
  			otherwise.
  			*/
  			inline bool useDaylightTime() const
  				{ return DSTSavings != 0; }
  
  		protected:
  			String ID;
  			int rawOffset;
  			int DSTSavings;
  
  			class Rule
  			{
  			public:
  				Rule(int year);
  				int year;
  				int64_t startDate;
  				int64_t endDate;
  			};
  
  			typedef std::map<long, Rule *> RuleMap;
  			mutable RuleMap rules;
  			
  			static TimeZonePtr defaultTimeZone;
  		};
  	};
  };
  
  #endif //_LOG4CXX_HELPERS_TIMEZONE_H