[#BloombergLP-baljsn-EncodeImplUtil_SelectionVisitor]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/baljsn.adoc[baljsn]::EncodeImplUtil_SelectionVisitor
:relfileprefix: ../../
:mrdocs:

This component‐private class provides a function object that closes over the `formatter`, `logStream`, and `options` parameters that are shared between all encoding operations provided in this component. The function‐call operator of this class provides an overload set that accepts a "selection" object that satisfies one of the `bdlat` type‐category concepts, and a "selection info" object that describes various metadata of the selection.

== Synopsis

Declared in `<baljsn_encodeimplutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class FORMATTER>
class EncodeImplUtil_SelectionVisitor;
----

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/baljsn/EncodeImplUtil_SelectionVisitor/FormattingMode.adoc[`FormattingMode`] 
| `FormattingMode` is an alias to the type of an `int`‐valued `bdlat_FormattingMode` bit‐field. A `FormattingMode` value is not valid unless it is equal to an enumerator of `bdlat_FormattingMode` or a valid bitwise‐or of two or more such enumerators. See the component‐level documentation of {`bdlat_formattingmode`} for a description of the set of valid formatting‐mode values.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/baljsn/EncodeImplUtil_SelectionVisitor/2constructor.adoc[`EncodeImplUtil_SelectionVisitor`]         [.small]#[constructor]#
| Construct an `EncodeImplUtil_SelectionVisitor` object having the specified `formatter`, `logStream`, `isNextObjectFirst`, and `options` attributes.
| xref:BloombergLP/baljsn/EncodeImplUtil_SelectionVisitor/isNextObjectFirst.adoc[`isNextObjectFirst`] 
| Return the value of the `isNextObjectFirst` attribute of this object.
| xref:BloombergLP/baljsn/EncodeImplUtil_SelectionVisitor/operator_call.adoc[`operator()`] 
| Encode the JSON representation of the specified `selection`, having the name equal to the `name` attribute of the specified `selectionInfo` to the JSON `formatter` attribute of this object, according to the specified `formattingMode`. If the `isNextObjectFirst` attribute of this object is `true`, then the representation of the selection contains no leading sequence delimiter, and does contain such a delimiter otherwise. The `options` attribute of this object configures aspects of the JSON representation of the `selection`. If this operation is not successful, load an unspecified, human‐readable description of the error condition to the `logStream` attribute of this object. Return 0 on success, and a non‐zero value otherwise. The behavior is undefined unless the `selection` satisfies both the static and dynamic requirements of the `bdlat` type‐category concept corresponding to the specified `category`. See the component‐level documentation of {`baljsn_encoderoptions`} for a description of the effects, if any, of each option in the `options` on the JSON representation of the `selection`. See the package‐level documentation of {`bdlat`} for an introduction to the requirements of `bdlat` type‐category concepts.
|===



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