bdlt::DayOfWeek Struct Reference

#include <bdlt_dayofweek.h>

Public Types
enum	Enum {   e_SUN = 1 , e_SUNDAY = e_SUN , e_MON , e_MONDAY = e_MON ,   e_TUE , e_TUESDAY = e_TUE , e_WED , e_WEDNESDAY = e_WED ,   e_THU , e_THURSDAY = e_THU , e_FRI , e_FRIDAY = e_FRI ,   e_SAT , e_SATURDAY = e_SAT , SUN = e_SUN , MON = e_MON ,   TUE = e_TUE , WED = e_WED , THU = e_THU , FRI = e_FRI ,   SAT = e_SAT , SUNDAY = e_SUNDAY , MONDAY = e_MONDAY , TUESDAY = e_TUESDAY ,   WEDNESDAY = e_WEDNESDAY , THURSDAY = e_THURSDAY , FRIDAY = e_FRIDAY , SATURDAY = e_SATURDAY ,   BDET_SUN = e_SUN , BDET_SUNDAY = e_SUN , BDET_MON = e_MON , BDET_MONDAY = e_MON ,   BDET_TUE = e_TUE , BDET_TUESDAY = e_TUE , BDET_WED = e_WED , BDET_WEDNESDAY = e_WED ,   BDET_THU = e_THU , BDET_THURSDAY = e_THU , BDET_FRI = e_FRI , BDET_FRIDAY = e_FRI ,   BDET_SAT = e_SAT , BDET_SATURDAY = e_SAT }
	Enumerated day-of-week values. More...
typedef Enum	Day

Static Public Member Functions
template<class STREAM >
static STREAM &	bdexStreamIn (STREAM &stream, DayOfWeek::Enum &variable, int version)
template<class STREAM >
static STREAM &	bdexStreamOut (STREAM &stream, DayOfWeek::Enum value, int version)
static int	maxSupportedBdexVersion (int versionSelector)
static bsl::ostream &	print (bsl::ostream &stream, DayOfWeek::Enum value, int level=0, int spacesPerLevel=4)
static const char *	toAscii (Enum dayOfWeek)
static int	maxSupportedBdexVersion ()

Detailed Description

This struct provides a namespace for enumerating day-of-week values. See Enum in the TYPES sub-section for details.

This struct:

• supports a complete set of enumeration operations For terminology see bsldoc_glossary .

Member Typedef Documentation

Day

typedef Enum bdlt::DayOfWeek::Day

Member Enumeration Documentation

Enum

enum bdlt::DayOfWeek::Enum

Enumerator
e_SUN
e_SUNDAY
e_MON
e_MONDAY
e_TUE
e_TUESDAY
e_WED
e_WEDNESDAY
e_THU
e_THURSDAY
e_FRI
e_FRIDAY
e_SAT
e_SATURDAY
SUN
MON
TUE
WED
THU
FRI
SAT
SUNDAY
MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
SATURDAY
BDET_SUN
BDET_SUNDAY
BDET_MON
BDET_MONDAY
BDET_TUE
BDET_TUESDAY
BDET_WED
BDET_WEDNESDAY
BDET_THU
BDET_THURSDAY
BDET_FRI
BDET_FRIDAY
BDET_SAT
BDET_SATURDAY

Member Function Documentation

bdexStreamIn()

template<class STREAM >

STREAM & bdlt::DayOfWeek::bdexStreamIn ( STREAM &  stream, DayOfWeek::Enum &  variable, int  version  )

static

Assign to the specified variable the value read from the specified input stream using the specified version format, and return a reference to stream. If stream is initially invalid, this operation has no effect. If version is not supported, variable is unaltered and stream is invalidated, but otherwise unmodified. If version is supported but stream becomes invalid during this operation, variable has an undefined, but valid, state. Note that no version is read from stream. See the bslx package-level documentation for more information on BDEX streaming of value-semantic types and containers.

bdexStreamOut()

template<class STREAM >

STREAM & bdlt::DayOfWeek::bdexStreamOut ( STREAM &  stream, DayOfWeek::Enum  value, int  version  )

static

Write the value of the specified value, using the specified version format, to the specified output stream, and return a reference to stream. If stream is initially invalid, this operation has no effect. If version is not supported, stream is invalidated, but otherwise unmodified. Note that version is not written to stream. See the bslx package-level documentation for more information on BDEX streaming of value-semantic types and containers.

maxSupportedBdexVersion() [1/2]

int bdlt::DayOfWeek::maxSupportedBdexVersion ( )

inlinestatic

Deprecated:

Use maxSupportedBdexVersion(int) instead.

Return the most current BDEX streaming version number supported by this struct.

maxSupportedBdexVersion() [2/2]

int bdlt::DayOfWeek::maxSupportedBdexVersion ( int  versionSelector )

inlinestatic

Return the maximum valid BDEX format version, as indicated by the specified versionSelector, to be passed to the bdexStreamOut method. Note that it is highly recommended that versionSelector be formatted as "YYYYMMDD", a date representation. Also note that versionSelector should be a compile-time-chosen value that selects a format version supported by both externalizer and unexternalizer. See the bslx package-level documentation for more information on BDEX streaming of value-semantic types and containers.

print()

static bsl::ostream & bdlt::DayOfWeek::print ( bsl::ostream &  stream, DayOfWeek::Enum  value, int  level = 0, int  spacesPerLevel = 4  )

static

Write the string representation of the specified enumeration value to the specified output stream, and return a reference to stream. Optionally specify an initial indentation level, whose absolute value is incremented recursively for nested objects. If level is specified, optionally specify spacesPerLevel, whose absolute value indicates the number of spaces per indentation level for this and all of its nested objects. If level is negative, suppress indentation of the first line. If spacesPerLevel is negative, format the entire output on one line, suppressing all but the initial indentation (as governed by level). The behavior is undefined unless dayOfWeek is in the range [ e_SUN .. e_SAT ]. See toAscii for what constitutes the string representation of a bdlt::DayOfWeek::Enum value.

toAscii()

static const char * bdlt::DayOfWeek::toAscii ( Enum  dayOfWeek )

static

Return the abbreviated character-string representation of the enumerator corresponding to the specified dayOfWeek. This representation matches the enumerator's three-character name (e.g., e_SUN) with the "e_" prefix elided. For example:

bsl::cout << bdlt::DayOfWeek::toAscii(bdlt::DayOfWeek::e_SUN);

prints the following on standard output:

SUN

Note that specifying a dayOfWeek that does not match any of the enumerators will result in an unspecified string representation being returned that is distinct from the values returned for any valid enumeration.

---

The documentation for this struct was generated from the following file:

• bdlt_dayofweek.h