/usr/include/dcmtk/ofstd/oftime.h is in libdcmtk2-dev 3.6.0-15.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 | /*
*
* Copyright (C) 2002-2010, OFFIS e.V.
* All rights reserved. See COPYRIGHT file for details.
*
* This software and supporting documentation were developed by
*
* OFFIS e.V.
* R&D Division Health
* Escherweg 2
* D-26121 Oldenburg, Germany
*
*
* Module: ofstd
*
* Author: Joerg Riesmeier
*
* Purpose: Class for time functions
*
* Last Update: $Author: joergr $
* Update Date: $Date: 2010-10-14 13:15:50 $
* CVS/RCS Revision: $Revision: 1.11 $
* Status: $State: Exp $
*
* CVS/RCS Log at end of file
*
*/
#ifndef OFTIME_H
#define OFTIME_H
#include "dcmtk/config/osconfig.h"
#define INCLUDE_CTIME
#include "dcmtk/ofstd/ofstdinc.h"
BEGIN_EXTERN_C
#ifdef HAVE_SYS_TYPES_H
# include <sys/types.h> /* for struct time_t */
#endif
END_EXTERN_C
#include "dcmtk/ofstd/ofstring.h" /* for class OFString */
/*---------------------*
* class declaration *
*---------------------*/
/** This class provides a collection of time functions
*/
class OFTime
{
// allow class OFDateTime to access protected class members
friend class OFDateTime;
public:
/** default constructor.
* Initializes Hour, Minute, Second and TimeZone to 0.
*/
OFTime();
/** copy constructor
* @param timeVal time object to be copied
*/
OFTime(const OFTime &timeVal);
/** constructor with init values
* @param hour hour value to be set
* @param minute minute value to be set
* @param second second value to be set (incl. fraction of seconds)
* @param timeZone optional offset to Coordinated Universal Time (UTC) in hours
*/
OFTime(const unsigned int hour,
const unsigned int minute,
const double second,
const double timeZone = 0);
/** destructor
*/
virtual ~OFTime();
/** assignment operator
* @param timeVal time value to be set
* @return reference to this object (with new value)
*/
virtual OFTime &operator=(const OFTime &timeVal);
/** comparison operator (equal).
* Please note that the time values are first transformed to the Coordinated Universal
* Time (UTC) before they are compared.
* @param timeVal time value compared with the current value
* @return OFTrue if given time is equal, OFFalse otherwise
*/
virtual OFBool operator==(const OFTime &timeVal) const;
/** comparison operator (unequal)
* Please note that the time values are first transformed to the Coordinated Universal
* Time (UTC) before they are compared.
* @param timeVal time value compared with the current value
* @return OFTrue if given time is unequal, OFFalse otherwise
*/
virtual OFBool operator!=(const OFTime &timeVal) const;
/** comparison operator (less than)
* Please note that the time values are first transformed to the Coordinated Universal
* Time (UTC) before they are compared.
* @param timeVal time value compared with the current value
* @return OFTrue if current time is earlier than the given value, OFFalse otherwise
*/
virtual OFBool operator<(const OFTime &timeVal) const;
/** comparison operator (less than or equal)
* Please note that the time values are first transformed to the Coordinated Universal
* Time (UTC) before they are compared.
* @param timeVal time value compared with the current value
* @return OFTrue if current time is earlier than or identical to the given value,
* OFFalse otherwise
*/
virtual OFBool operator<=(const OFTime &timeVal) const;
/** comparison operator (greater than or equal)
* Please note that the time values are first transformed to the Coordinated Universal
* Time (UTC) before they are compared.
* @param timeVal time value compared with the current value
* @return OFTrue if current time is later than or identical to the given value,
* OFFalse otherwise
*/
virtual OFBool operator>=(const OFTime &timeVal) const;
/** comparison operator (greater than)
* Please note that the time values are first transformed to the Coordinated Universal
* Time (UTC) before they are compared.
* @param timeVal time value compared with the current value
* @return OFTrue if current time is later than the given value, OFFalse otherwise
*/
virtual OFBool operator>(const OFTime &timeVal) const;
/** reset the time value.
* Sets the hour, minute, second and time zone to "0".
*/
virtual void clear();
/** check whether the currently stored time value is valid.
* Valid ranges: [0,24[ for 'hour', [0,60[ for 'minute', [0.0,60.0[ for 'second'
* and [-12.0,+12.0] for 'timeZone'
* @return OFTrue if the current value is valid, OFFalse otherwise
*/
virtual OFBool isValid() const;
/** set the time value to the specified time.
* Before the new value is set it is checked using the "isValid()" routine.
* @param hour new hour value to be set
* @param minute new minute value to be set
* @param second new second value to be set (incl. fraction of seconds)
* @param timeZone optional offset to Coordinated Universal Time (UTC) in hours
* @return OFTrue if the new value is valid and has been set, OFFalse otherwise
*/
OFBool setTime(const unsigned int hour,
const unsigned int minute,
const double second,
const double timeZone = 0);
/** set the time value to the specified hour.
* Before the new value is set it is checked using the "isValid()" routine.
* @param hour new hour value to be set
* @return OFTrue if the new value is valid and has been set, OFFalse otherwise
*/
OFBool setHour(const unsigned int hour);
/** set the time value to the specified minute.
* Before the new value is set it is checked using the "isValid()" routine.
* @param minute new minute value to be set
* @return OFTrue if the new value is valid and has been set, OFFalse otherwise
*/
OFBool setMinute(const unsigned int minute);
/** set the time value to the specified second.
* Before the new value is set it is checked using the "isValid()" routine.
* @param second new second value to be set (incl. fraction of seconds)
* @return OFTrue if the new value is valid and has been set, OFFalse otherwise
*/
OFBool setSecond(const double second);
/** set the time zone to the specified value.
* The time zone is given as the offset (in hours) to the Coordinated Universal
* Time (UTC). Valid values are for instance "+1.0" (plus one hour) and "-2.5"
* (minus two and a half hour, i.e. 2 hours and 30 minutes). Before the new value
* is set it is checked using the "isValid()" routine.
* @param timeZone new timeZone value to be set
* @return OFTrue if the new value is valid and has been set, OFFalse otherwise
*/
OFBool setTimeZone(const double timeZone);
/** set the time zone to the specified value.
* The time zone is given as the offset (in hours and minutes) to the Coordinated
* Universal Time (UTC). Before the new value is set it is checked using the
* "isValid()" routine.
* @param hour new hour value to be set for the time zone
* @param minute new minute value to be set for the time zone
* @return OFTrue if the new value is valid and has been set, OFFalse otherwise
*/
OFBool setTimeZone(const signed int hour,
const unsigned int minute);
/** set the time to the specified number of seconds
* @param seconds number of seconds since "00:00:00" specifying time to set
* @param timeZone optional offset to Coordinated Universal Time (UTC) in hours
* @param normalize if OFTrue the 'seconds' value is normalized to the valid range
* [0.0,86400.0[ otherwise the value is checked as is
* @return OFTrue if the new value is valid and has been set, OFFalse otherwise
*/
OFBool setTimeInSeconds(const double seconds,
const double timeZone = 0,
const OFBool normalize = OFTrue);
/** set the time to the specified number of hours
* @param hours number of hours since "00:00:00" specifying time to set
* @param timeZone optional offset to Coordinated Universal Time (UTC) in hours
* @param normalize if OFTrue the 'hours' value is normalized to the valid range
* [0.0,24.0[ otherwise the value is checked as is
* @return OFTrue if the new value is valid and has been set, OFFalse otherwise
*/
OFBool setTimeInHours(const double hours,
const double timeZone = 0,
const OFBool normalize = OFTrue);
/** set the time value to the current system time.
* This function uses operating system dependent routines. If they are unavailable
* for some reason the current value is not modified.
* @return OFTrue if the current system time has been set, OFFalse otherwise
*/
OFBool setCurrentTime();
/** set the time value to the given ISO formatted time string.
* The two ISO time formats supported by this function are "HH:MM[:SS]" (with arbitrary
* delimiters) and "HHMM[SS]" (without delimiters) where the brackets enclose optional
* parts. The optional fractional part of a second and the time zone (see getISO...)
* are not yet supported.
* @param formattedTime ISO formatted time value to be set
* @return OFTrue if input is valid and result variable has been set, OFFalse otherwise
*/
OFBool setISOFormattedTime(const OFString &formattedTime);
/** get the currently stored hour value
* @return hour value (might be invalid, i.e. out of range)
*/
unsigned int getHour() const;
/** get the currently stored minute value
* @return minute value (might be invalid, i.e. out of range)
*/
unsigned int getMinute() const;
/** get the currently stored second value
* @return second value (might be invalid, i.e. out of range)
*/
double getSecond() const;
/** get the integral part of the currently stored second value
* @return second value (might be invalid, i.e. out of range)
*/
unsigned int getIntSecond() const;
/** get the milli second part of the currently stored second value
* @return milli second part (0..999)
*/
unsigned int getMilliSecond() const;
/** get the micro second part of the currently stored second value
* @return micro second part (0..999999)
*/
unsigned int getMicroSecond() const;
/** get the currently stored time zone value.
* The time zone is given as the offset (in hours) to the Coordinated Universal
* Time (UTC). Valid values are for instance "+1.0" (plus one hour) and "-2.5"
* (minus two and a half hour, i.e. 2 hours and 30 minutes).
* @return time zone value (might be invalid, i.e. out of range)
*/
double getTimeZone() const;
/** get the currently stored time in seconds
* @param useTimeZone use the currently set time zone to correct the result
* @param normalize if OFTrue results larger than or equal 86400.0 (seconds)
* are normalized to a valid range
* @return number of seconds since "00:00:00"
*/
double getTimeInSeconds(const OFBool useTimeZone = OFFalse,
const OFBool normalize = OFTrue) const;
/** get the currently stored time in hours.
* @param useTimeZone use the currently set time zone to correct the result
* @param normalize if OFTrue results larger than or equal 24.0 (hours)
* are normalized to a valid range
* @return number of hours since "00:00:00" (incl. fraction of hours)
*/
double getTimeInHours(const OFBool useTimeZone = OFFalse,
const OFBool normalize = OFTrue) const;
/** get the currently stored time as Coordinated Universal Time.
* The resulting time object always has a time zone of "+00:00" since the time is
* corrected regarding the Coordinated Universal Time (UTC).
* @return time object with the UTC corrected time set
*/
OFTime getCoordinatedUniversalTime() const;
/** get the currently stored time in local time.
* The resulting time object always has the local time zone.
* @return time object with the corrected time set
*/
OFTime getLocalTime() const;
/** get the current time value in ISO format.
* The two ISO time formats supported by this function are "HH:MM[:SS[.FFFFFF]][&ZZ:ZZ]"
* (with delimiters) and "HHMM[SS[.FFFFFF]][&ZZZZ]" (without delimiters, useful for DICOM
* time type) where the brackets enclose optional parts.
* @param formattedTime reference to string variable where the result is stored
* @param showSeconds add optional seconds (":SS" or "SS") to the resulting string if OFTrue
* @param showFraction add optional fractional part of a second (".FFFFFF") if OFTrue.
* Requires parameter 'seconds' to be also OFTrue.
* @param showTimeZone add optional time zone ("&ZZ:ZZ" or "&ZZZZ") to the resulting string
* if OFTrue. The time zone indicates the offset from the Coordinated Universal Time (UTC)
* in hours and minutes. The "&" is a placeholder for the sign symbol ("+" or "-").
* @param showDelimiter flag, indicating whether to use delimiters (":") or not
* @return OFTrue if result variable has been set, OFFalse otherwise
*/
OFBool getISOFormattedTime(OFString &formattedTime,
const OFBool showSeconds = OFTrue,
const OFBool showFraction = OFFalse,
const OFBool showTimeZone = OFFalse,
const OFBool showDelimiter = OFTrue) const;
/* --- static helper functions --- */
/** get the current system time
* @return time object with the current system time set
*/
static OFTime getCurrentTime();
/** get the local time zone.
* This function uses operating system dependent routines. If they are unavailable
* for some reason the Coordinated Universal Time is assumed (time zone offset = 0).
* @return local time zone if available, 0 otherwise
*/
static double getLocalTimeZone();
protected:
/** set the time value to the current system time.
* This function uses operating system dependent routines. If they are unavailable
* for some reason the current value is not modified.
* @param tt current system time (as returned by the time() function )
* @return OFTrue if the current system time has been set, OFFalse otherwise
*/
OFBool setCurrentTime(const time_t &tt);
/* --- static helper functions --- */
/** check whether the given time is valid.
* Valid ranges: [0,24[ for 'hour', [0,60[ for 'minute', [0.0,60.0[ for 'second'
* and [-12.0,+12.0] for 'timeZone'
* @param hour hour value to be checked
* @param minute minute value to be checked
* @param second second value to be checked
* @param timeZone offset to Coordinated Universal Time (UTC) in hours
* @return OFTrue if the current value is valid, OFFalse otherwise
*/
static OFBool isTimeValid(const unsigned int hour,
const unsigned int minute,
const double second,
const double timeZone);
/** get the given time in seconds.
* @param hour hour value of the given time
* @param minute minute value of the given time
* @param second second value of the given time
* @param timeZone offset to Coordinated Universal Time (UTC) in hours
* @param normalize if OFTrue results larger than or equal 86400.0 (seconds)
* are normalized to a valid range
* @return number of seconds since "00:00:00"
*/
static double getTimeInSeconds(const unsigned int hour,
const unsigned int minute,
const double second,
const double timeZone = 0,
const OFBool normalize = OFTrue);
/** get the given time in hours.
* @param hour hour value of the given time
* @param minute minute value of the given time
* @param second second value of the given time
* @param timeZone offset to Coordinated Universal Time (UTC) in hours
* @param normalize if OFTrue results larger than or equal 24.0 (hours)
* are normalized to a valid range
* @return number of hours since "00:00:00" (incl. fraction of hours)
*/
static double getTimeInHours(const unsigned int hour,
const unsigned int minute,
const double second,
const double timeZone = 0,
const OFBool normalize = OFTrue);
private:
/// currently stored hour value
unsigned int Hour;
/// currently stored minute value
unsigned int Minute;
/// currently stored second value (incl. fraction of seconds)
double Second;
/// currently stored time zone value
double TimeZone;
};
/** put the given time in ISO format on the output stream.
* If an error occurs nothing is printed.
* @param stream output stream
* @param timeVal OFTime object to print
* @return reference to the output stream
*/
STD_NAMESPACE ostream& operator<<(STD_NAMESPACE ostream& stream, const OFTime &timeVal);
#endif
/*
*
* CVS/RCS Log:
* $Log: oftime.h,v $
* Revision 1.11 2010-10-14 13:15:50 joergr
* Updated copyright header. Added reference to COPYRIGHT file.
*
* Revision 1.10 2009-08-19 11:55:45 meichel
* Added additional includes needed for Sun Studio 11 on Solaris.
*
* Revision 1.9 2006-08-14 16:42:26 meichel
* Updated all code in module ofstd to correctly compile if the standard
* namespace has not included into the global one with a "using" directive.
*
* Revision 1.8 2005/12/08 16:06:09 meichel
* Changed include path schema for all DCMTK header files
*
* Revision 1.7 2004/01/16 10:30:39 joergr
* Added setISOFormattedXXX() methods for Date, Time and DateTime.
*
* Revision 1.6 2003/12/17 15:18:48 joergr
* Fixed bug/inconsistency in comparison operators of class OFTime. Now the
* "time overflow" is handled correctly.
*
* Revision 1.5 2003/09/15 12:12:56 joergr
* Fixed incorrect/improper comments of the comparision operators. Enhanced
* comment of the default constructor. Made comparison operators const.
*
* Revision 1.4 2002/05/24 09:43:05 joergr
* Renamed some parameters/variables to avoid ambiguities.
*
* Revision 1.3 2002/04/19 10:42:51 joergr
* Added new helper routines to get the milli and micro seconds part as well as
* the integral value of seconds.
*
* Revision 1.2 2002/04/15 09:38:59 joergr
* Added "include <sys/types.h>" for struct time_t (required for MSVC).
*
* Revision 1.1 2002/04/11 12:12:24 joergr
* Introduced new standard classes providing date and time functions.
*
*
*/
|