[#BloombergLP-ball-Log_Stream]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/ball.adoc[ball]::Log_Stream
:relfileprefix: ../../
:mrdocs:

Aggregate of objects used by the C++ stream‐based logging macros.

== Synopsis

Declared in `<ball_log.h>`

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

== Description

This class provides an aggregate of several objects relevant to the logging of a message via the C++ stream‐based macros: `

* record to be logged
* category to which to log the record
* severity at which to log the record
* stream to which the user log message is put ` As a side‐effect of creating an object of this class, the record and stream are also constructed. As a side‐effect of destroying the object, the record is logged.

This class should _not_ be used directly by client code. It is an implementation detail of the macros provided by this component.

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/ball/Log_Stream/2constructor.adoc[`Log_Stream`]         [.small]#[constructor]#
| Create a logging stream for the given category, location, and severity.
| xref:BloombergLP/ball/Log_Stream/2destructor.adoc[`~Log_Stream`] [.small]#[destructor]#
| Destroy this logging stream and log its held record.
| xref:BloombergLP/ball/Log_Stream/category.adoc[`category`] 
| Return the address of the non‐modifiable category held by this logging stream.
| xref:BloombergLP/ball/Log_Stream/record-091.adoc[`record`] 
| `record` overloads
| xref:BloombergLP/ball/Log_Stream/severity.adoc[`severity`] 
| Return the severity held by this logging stream.
| xref:BloombergLP/ball/Log_Stream/stream.adoc[`stream`] 
| Return a reference to the modifiable stream held by this logging stream. The reference remains valid until this logging stream is destroyed.
|===



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