[#BloombergLP-bdld-DatumError]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdld.adoc[bdld]::DatumError
:relfileprefix: ../../
:mrdocs:

Value‐semantic type for an error code with an optional error message.

== Synopsis

Declared in `<bdld_datumerror.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class DatumError;
----

== Description

This component `class` provides a _complex constrained_ attribute type, `bdld::DatumError`, that represents an error code with an optional descriptive error message. Note that this class holds a reference to the error message and does not make a copy of it.

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdld/DatumError/2constructor-0b.adoc[`DatumError`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdld/DatumError/code.adoc[`code`] 
| Return the error code.
| xref:BloombergLP/bdld/DatumError/message.adoc[`message`] 
| Return a reference to the non‐modifyable error message.
| xref:BloombergLP/bdld/DatumError/print.adoc[`print`] 
| Write the value of this object to the specified output `stream` in a human‐readable format, and return a reference to the modifyable `stream`.
| xref:BloombergLP/bdld/DatumError/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration<DatumError, HasPrintMethod>`] 
| `DatumError` is trivially copyable.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdld/operator_not_eq-0f.adoc[`operator!=`]
| Return `true` if the specified `lhs` and `rhs` have different values and `false` otherwise.
| xref:BloombergLP/bdld/operator_lt-03.adoc[`operator<`]
| Return `true` if value of the specified `lhs` is less than value of the specified `rhs` and `false` otherwise.
| xref:BloombergLP/bdld/operator_le-06.adoc[`operator<=`]
| Return `true` if value of the specified `lhs` is less than or equal to value of the specified `rhs` and `false` otherwise.
| xref:BloombergLP/bdld/operator_eq-0b.adoc[`operator==`]
| Return `true` if the specified `lhs` and `rhs` have the same value and `false` otherwise.
| xref:BloombergLP/bdld/operator_gt-05.adoc[`operator>`]
| Return `true` if value of the specified `lhs` is greater than value of the specified `rhs` and `false` otherwise.
| xref:BloombergLP/bdld/operator_ge-07.adoc[`operator>=`]
| Return `true` if value of the specified `lhs` is greater than or equal to value of the specified `rhs` and `false` otherwise.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#