This struct provides a namespace for enumerating month-of-year values. See Enum in the TYPES sub-section for details.
Declared in <bdlt_monthofyear.h>
struct MonthOfYear;This struct: * supports a complete set of enumeration operations For terminology see bsldoc_glossary.
| Name | Description |
|---|---|
Month | Define an alias, Month, to the enum type, Enum defined by this component. |
| Name | Description |
|---|---|
Unnamed enum | Define k_NUM_MONTHS to be the number of consecutively valued enumerators in the range [ e_JAN .. e_DEC ]. |
Enum | Define the list of month-of-year values. |
| 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). See toAscii for what constitutes the string representation of a MonthOfYear::Enum value. |
toAscii | Return the non-modifiable string representation corresponding to the specified enumeration value, if it exists, and a unique (error) string otherwise. The string representation of value matches the first 3 characters of its corresponding enumerator name with the "e_" prefix elided. For example: ` bsl::cout << bdlt::MonthOfYear::toAscii( bdlt::MonthOfYear::e_JANUARY); ` will print the following on standard output: ` JAN ` Note that specifying a value that does not match any of the enumerators will result in a string representation that is distinct from any of those corresponding to the enumerators, but is otherwise unspecified. |