Bpp/Calendar
Gregorian
C++
 
 
DESCRIPTION
 

This module provides facilities to manipulate date and time information in the Gregorian calendar.

 
SOURCE FILES
 

This section allows you to access the C++ source files of the module.

 
PARENT MODULE
 

This module is part of Bpp/Calendar.

 
INCLUDED FILES
 

The files listed below are included in the interface part of the module. So any module dependent of this module is also dependent of the files listed here.

  • <bpp/standard.hpp>

 
NEEDED FILES
 

The files listed below are needed by the implementation part of the module. But a module dependent of this module is not necessary dependent of the files listed here.

  • <bpp/modules.hpp>

 
TYPES
 

Here are listed the types defined in the module. To use one of them, you have to specify the namespace of the module.

  • enumeration { january=1, february=2, march=3, april=4, may=5, june=6, july=7, august=8, september=9, october=10, november=11, december=12 } tyMonth
    Symbolic constants for the months.

  • enumeration { sunday=1, monday=2, tuesday=3, wednesday=4, thursday=5, friday=6, saturday=7 } tyWeekDay
    Symbolic constants for the week days.

  • enumeration { normalYear=false, leapYear=true } tyYearKind
    Symbolic constants for the kind of year.

  • enumeration { dayFirstLongDate, dayFirstShortDate, monthFirstLongDate, monthFirstShortDate } tyDateFormat
    Symbolic constants for the string format of the date.

  • enumeration { americanLongTime, americanShortTime, militaryLongTime, militaryShortTime } tyTimeFormat
    Symbolic constants for the string format of the time.

 
ERRORS
 

Here are listed the errors that are supported or generated by the module. To use one of them, you do not have to specify the namespace of the module.

  • erInvalidAbsoluteDay
    Invalid absolute day number.

  • erInvalidDateString
    Invalid date string.

  • erInvalidHour
    Invalid hour number.

  • erInvalidHundredth
    Invalid hundredth number.

  • erInvalidMinute
    Invalid minute number.

  • erInvalidMonth
    Invalid month number.

  • erInvalidMonthDay
    Invalid month day number.

  • erInvalidSecond
    Invalid second number.

  • erInvalidTimeString
    Invalid time string.

  • erInvalidWeekDay
    Invalid week day number.

  • erInvalidYear
    Invalid year number.

  • erTimeZoneParameterMissing
    The time_zone parameter is missing in the initialization file.

 
CONSTANTS
 

Here are listed the constants provided by the module. To use one of them, you have to specify the namespace of the module.

  • tyWeekDay firstWeekDay()
    Week day of the 1/1/1.

  • tyInteger timeZone()
    Current time zone.

  • tyString timeZoneString()
    String indicating the current time zone.

  • tyInteger hourPerDay()
    Number of hours per day.

  • tyInteger minutePerDay()
    Number of minutes per day.

  • tyInteger secondPerDay()
    Number of seconds per day.

  • tyInteger hundredthPerSecond()
    Number of hundredths per second.

  • tyInteger hundredthPerMinute()
    Number of hundredths per minute.

  • tyInteger hundredthPerHour()
    Number of hundredths per hour.

  • tyInteger hundredthPerDay()
    Number of hundredths per day.

 
FUNCTIONS
 

Here are listed the functions provided by the module. To use one of them, you have to specify the namespace of the module.

 
CLASSES
 

Here are listed the classes provided by the module. To use one of them, you have to specify the namespace of the module.

 
clGregorian
 
 
Declaration

class clGregorian

 
Description

Represents a date-and-time in the Gregorian calendar.

 
Attributes
  • tyInteger absoluteDay()
    Absolute day number (from 1 to +oo). Reading access only.

  • tyInteger absoluteHundredth()
    Absolute hundreth number in the day (from 0 to 8,639,999). Reading access only.

  • tyInteger year()
    Year number (from 1 to +oo). Reading access only.

  • tyMonth month()
    Month of the year (from 1 to 12). Reading access only.

  • tyInteger monthDay()
    Day of the month (from 1 to 31). Reading access only.

  • tyInteger hour()
    Hour of the day (from 0 to 23). Reading access only.

  • tyInteger minute()
    Minute of the hour (from 0 to 59). Reading access only.

  • tyInteger second()
    Second of the minute (from 0 to 59). Reading access only.

  • tyInteger hundredth()
    Hundredth of the second (from 0 to 99). Reading access only.

 
Methods
 
 
Copyright (c) 1999-2016 - Bruno Bachelet - bruno@nawouak.net - http://www.nawouak.net
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation. See this license for more details (http://www.gnu.org).