logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

hdate::Hdate - Hdate class.

Author

       Generated automatically by Doxygen for libhdate C++ language from the source code.

Version 1.4                                        6 Jan 2008                                    hdate::Hdate(3)

Constructor & Destructor Documentation

hdate::Hdate::Hdate()[inline]Hdate constructor.

   hdate::Hdate::~Hdate()[inline]Hdate destructor.

Detailed Description

Hdate class.

       class for Hebrew/Gregorian date conversions

Member Function Documentation

voidhdate::Hdate::set_gdate(intd,intm,inty)[inline]
       compute date structure from the Gregorian date

       Parameters:d Day of month 1..31
           m Month 1..12 , if m or d is 0 return current date.
           y Year in 4 digits e.g. 2001

   voidhdate::Hdate::set_hdate(intd,intm,inty)[inline]
       compute date structure from the Hebrew date

       Parameters:d Day of month 1..31
           m Month 1..14 , if m or d is 0 return current date.
           y Year in 4 digits e.g. 5731

   voidhdate::Hdate::set_jd(intjd)[inline]
       compute date structure from the Julian day

       Parameters:jd the julian day number.

   char*hdate::Hdate::get_format_date(ints)[inline]
       get formatted hebrew date.

       return the short ( e.g. '1 Tishrey' ) or long (e.g. 'Tuesday 18 Tishrey 5763 Hol hamoed Sukot' )
       formatted date.

       Parameters:s short flag.

       Returns:
           a static string of foramted date

   char*hdate::Hdate::get_day_of_week_string(ints)[inline]
       get name of week day.

       Parameters:s short flag true - returns a short string: sun, false returns: sunday.

       Returns:
           a static string of the day of the week

   char*hdate::Hdate::get_month_string(ints)[inline]
       get name month.

       Parameters:s short flag true - returns a short string: Mar, false returns: March.

       Returns:
           a static string of month name

   char*hdate::Hdate::get_hebrew_month_string(ints)[inline]
       get name hebrew month.

       Parameters:s short flag true - returns a short string.

       Returns:
           a static string of hebrew month name

   char*hdate::Hdate::get_holyday_string(ints)[inline]
       get name hebrew holiday.

       Parameters:s short flag true - returns a short string.

       Returns:
           a static string of hebrew holiday name

   inthdate::Hdate::get_holyday_type()[inline]
       get the hebrew holiday type.

       Returns:
           the holiday type (1- regular holyday, 2- three regels, 3- tzom, 0- no holiday)

   char*hdate::Hdate::get_parasha_string(ints)[inline]
       get name hebrew parasha.

       Parameters:s short flag true - returns a short string.

       Returns:
           a static string of hebrew parash name

   char*hdate::Hdate::get_hebrew_year_string()[inline]
       get name hebrew year.

       Returns:
           a static string of hebrew year

   char*hdate::Hdate::get_hebrew_day_string()[inline]
       get name hebrew hebrew day of the month

       Returns:
           a static string of hebrew day of the month

   inthdate::Hdate::get_parasha()[inline]
       get parash number

       Returns:
           the hebrew parasha number

   inthdate::Hdate::get_holyday()[inline]
       get holiday number

       Returns:
           the hebrew holiday number

   inthdate::Hdate::get_gday()[inline]
       get Gregorian day of the month

       Returns:
           the Gregorian day of the month

   inthdate::Hdate::get_gmonth()[inline]
       get Gregorian month

       Returns:
           the Gregorian month

   inthdate::Hdate::get_gyear()[inline]
       get Gregorian year

       Returns:
           the Gregorian year

   inthdate::Hdate::get_hday()[inline]
       get Hebrew day of the month

       Returns:
           the Hebrew day of the month

   inthdate::Hdate::get_hmonth()[inline]
       get Hebrew month

       Returns:
           the Hebrew month

   inthdate::Hdate::get_hyear()[inline]
       get Hebrew year

       Returns:
           the Hebrew year

   inthdate::Hdate::get_day_of_the_week()[inline]
       get the day of the week

       Returns:
           the day of the week

   inthdate::Hdate::get_size_of_year()[inline]
       get the size of the Hebrew year in days

       Returns:
           the size of the Hebrew year in days

   inthdate::Hdate::get_new_year_day_of_the_week()[inline]
       get the day of the week of hebrew new years

       Returns:
           the day of the week of hebrew new years

   inthdate::Hdate::get_julian()[inline]
       get the Julian day number

       Returns:
           the Julian day number

   inthdate::Hdate::get_days()[inline]
       get the number of days sice Tishrey I

       Returns:
           the the number of days sice Tishrey I

   inthdate::Hdate::get_weeks()[inline]
       get the number of weeks sice Tishrey I

       Returns:
           the the number of weeks sice Tishrey I

   voidhdate::Hdate::set_location(doublein_latitude,doublein_longitude,intin_tz)[inline]
       set location

       Parameters:in_longitude longitude to use in calculations degrees, negative values are east
           in_latitude latitude to use in calculations degrees, negative values are south
           in_tz time zone

   inthdate::Hdate::get_sunrise()[inline]
       sunrise time

       Returns:
           sunrise in minutes after midnight (00:00)

   inthdate::Hdate::get_sunset()[inline]
       sunset time

       Returns:
           sunset in minutes after midnight (00:00)

   inthdate::Hdate::get_first_light()[inline]
       first light time

       Returns:
           first light in minutes after midnight (00:00)

   inthdate::Hdate::get_talit()[inline]
       talit time

       Returns:
           talit time in minutes after midnight (00:00)

   inthdate::Hdate::get_first_stars()[inline]
       first stars time

       Returns:
           first stars in minutes after midnight (00:00)

   inthdate::Hdate::get_three_stars()[inline]
       three stars time

       Returns:
           three stars in minutes after midnight (00:00)

   inthdate::Hdate::get_sun_hour()[inline]
       sun light hour time

       Returns:
           sun light hour in minutes

   inthdate::Hdate::get_midday()[inline]
       midday hour time

       Returns:
           midday hour in minutes

   char*hdate::Hdate::get_translator_string()[inline]
       name of translator

       Returns:
           a static string with name of translator, or NULL if none

   voidhdate::Hdate::set_diaspora()[inline]
       set this hdate object to use diaspora holidays and dates

   voidhdate::Hdate::set_israel()[inline]
       set this hdate object to use israel holidays and dates

Name

       hdate::Hdate - Hdate class.

Synopsis

       #include <hdatepp.h>

   PublicMemberFunctionsHdate ()
           Hdateconstructor.~Hdate ()
           Hdatedestructor.
       void set_gdate (int d, int m, int y)
           computedatestructurefromtheGregoriandate
       void set_hdate (int d, int m, int y)
           computedatestructurefromtheHebrewdate
       void set_jd (int jd)
           computedatestructurefromtheJulianday
       char * get_format_date (int s)
           getformattedhebrewdate.
       char * get_day_of_week_string (int s)
           getnameofweekday.
       char * get_month_string (int s)
           getnamemonth.
       char * get_hebrew_month_string (int s)
           getnamehebrewmonth.
       char * get_holyday_string (int s)
           getnamehebrewholiday.
       int get_holyday_type ()
           getthehebrewholidaytype.
       char * get_parasha_string (int s)
           getnamehebrewparasha.
       char * get_hebrew_year_string ()
           getnamehebrewyear.
       char * get_hebrew_day_string ()
           getnamehebrewhebrewdayofthemonth
       int get_parasha ()
           getparashnumber
       int get_holyday ()
           getholidaynumber
       int get_gday ()
           getGregoriandayofthemonth
       int get_gmonth ()
           getGregorianmonth
       int get_gyear ()
           getGregorianyear
       int get_hday ()
           getHebrewdayofthemonth
       int get_hmonth ()
           getHebrewmonth
       int get_hyear ()
           getHebrewyear
       int get_day_of_the_week ()
           getthedayoftheweek
       int get_size_of_year ()
           getthesizeoftheHebrewyearindays
       int get_new_year_day_of_the_week ()
           getthedayoftheweekofhebrewnewyears
       int get_julian ()
           gettheJuliandaynumber
       int get_days ()
           getthenumberofdayssiceTishreyI
       int get_weeks ()
           getthenumberofweekssiceTishreyI
       void set_location (double in_latitude, double in_longitude, int in_tz)
           setlocation
       int get_sunrise ()
           sunrisetime
       int get_sunset ()
           sunsettime
       int get_first_light ()
           firstlighttime
       int get_talit ()
           talittime
       int get_first_stars ()
           firststarstime
       int get_three_stars ()
           threestarstime
       int get_sun_hour ()
           sunlighthourtime
       int get_midday ()
           middayhourtime
       char * get_translator_string ()
           nameoftranslator
       void set_diaspora ()
           setthishdateobjecttousediasporaholidaysanddates
       void set_israel ()
           setthishdateobjecttouseisraelholidaysanddates

See Also