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

Synopsis

Declared in <bdlt_dayofweek.h>

struct DayOfWeek;

Description

This struct: * supports a complete set of enumeration operations For terminology see bsldoc_glossary.

Type Aliases

Name

Description

Day

Deprecated alias for Enum.

Enums

Name

Description

Enum

Enumerated day‐of‐week values.

Static Member Functions

Name

Description

bdexStreamIn

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

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

maxSupportedBdexVersion overloads

print

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

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.

Created with MrDocs