Date :: assign - Set date value

The function provides different ways for setting a date value.

Return value: Date ( odaba::Date & )

The date contains day, month and year, but not the time.

Implementation overview

Set ODABA date value from unix timestamp
Date :: assign ( iUnixTime )
Set current date value
Date :: assign ( )
Copy date value
Date :: assign ( cDate )
Set date from days
Date :: assign ( iDayNum )
Set date value by day, month and year
Date :: assign ( iDay, iMonth, iYear )
Set local date value from unix timestamp
Date :: assign ( iUnixTime, bLocalTime )
Set date value from string
Date :: assign ( sDate )

Implementation details

Set ODABA date value from unix timestamp
odaba::Date & Date :: assign ( int64 iUnixTime )

The Unix timestamp, which is passed in iUnixTime, contains the number of seconds since 1.1.1970 0:00:00.

The timestamp is supposed to contain a standard time value (UTC) and will be adjusted to local time before being converted into an ODABA date value. Depending on winter and summer time and region the function may return different values.
- iUnixTime - Unix time stamp
  The unix timestamp contains the number of seconds since 1.1.1970 0:00:00 (UTC), which is an absolute timestamp that might be converted into local time.

Set current date value
odaba::Date & Date :: assign ( )

The function initializes date to the current date.

Copy date value
odaba::Date & Date :: assign ( odaba::Date &cDate )

The function copies the date value passed in cDate.
- cDate - Date
  The date contains day, month and year, but not the time.

Set date from days
odaba::Date & Date :: assign ( int32 iDayNum )

The function calculates the date from the number of days passed in iDayNum. The value must be greater than 0.
- iDayNum - Day number
  The day number of a date is the number of days since 1.1.1870.

Set date value by day, month and year
odaba::Date & Date :: assign ( int32 iDay, int32 iMonth, int32 iYear )

The function changes the date value to day, month and year passed in iDay, iMonth and iYear. When the day or month value exceeds the number of days in the defined month or 12, the month and year value will increase automatically.

When iDay, iMonth are less than 1 or iYear is less than 1870, the function throws an exception.
- iDay - Day
  Day of the month. The value should range between 1 and 31.
- iMonth - Month
  Month of the year. The value should range between 1 and 12.
- iYear - Year
  Number of the year. The value should no be negative.

Set local date value from unix timestamp
odaba::Date & Date :: assign ( int64 iUnixTime, bool bLocalTime )

The Unix timestamp, which is passed in iUnixTime, contains the number of seconds since 1.1.1970 0:00:00 (UTC). The Unix timestamp is supposed to contain a standard time value (UTC).

When true has been passed in bLocalTime, the timestamp is supposed to contain a standard time value (UTC) and will be adjusted to local time before being converted into an ODABA date value. Depending on winter and summer time and region the function may return different values.

When false has been passed in bLocalTime, the timestamp is supposed to contain local time value or the application is responsible for proper interpretation.
- iUnixTime - Unix time stamp
  The unix timestamp contains the number of seconds since 1.1.1970 0:00:00 (UTC), which is an absolute timestamp that might be converted into local time.
- bLocalTime - Local or standard time
  The option indicates, that a time value or timestamp contains local time (true) or Greenwich standard time (false).

Set date value from string
odaba::Date & Date :: assign ( odaba::String &sDate )
The function sets the date value from the string date passed in sDate. When no date format has been set, the date format is detected automatically from string value as follows:
- contains '.' - DD.MM.YYYY or DD.MM.YY
- contains '/' - MM/DD/YYYY or MM/DD/YY
- contains '-' - YYYY-MM-DD or YY-MM-DD
- else - YYYYMMDD or YYMMDD
- sDate - Date value in string format
  Date values can be passed in different ways as string value:
  
          Standard: yyyy-mm-dd or yyyymmdd
  
          English:     mm/dd/yyyy
  
          German:     dd.mm.yyyy
  
  The type of date is determined from the separator used.