[#BloombergLP-balb-Request] = xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balb.adoc[balb]::Request :relfileprefix: ../../ :mrdocs: == Synopsis Declared in `<balb_testmessages.h>` [source,cpp,subs="verbatim,replacements,macros,-callouts"] ---- class Request; ---- == Enums [cols="1,4"] |=== | Name| Description | xref:BloombergLP/balb/Request/_04enum-08.adoc[`Unnamed enum`] | Selection identifier constants. | xref:BloombergLP/balb/Request/_04enum-09.adoc[`Unnamed enum`] | Selection count constant. | xref:BloombergLP/balb/Request/_04enum-0e.adoc[`Unnamed enum`] | Selection index constants. |=== == Member Functions [cols="1,4"] |=== | Name| Description | xref:BloombergLP/balb/Request/2constructor-04.adoc[`Request`] [.small]#[constructor]# | Constructors | xref:BloombergLP/balb/Request/2destructor.adoc[`~Request`] [.small]#[destructor]# | Destroy this object. | xref:BloombergLP/balb/Request/operator_assign.adoc[`operator=`] | Assign to this object the value of the specified `rhs` object. | xref:BloombergLP/balb/Request/accessSelection.adoc[`accessSelection`] | Invoke the specified `accessor` on the non‐modifiable selection, supplying `accessor` with the corresponding selection information structure. Return the value returned from the invocation of `accessor` if this object has a defined selection, and ‐1 otherwise. | xref:BloombergLP/balb/Request/bdexStreamIn.adoc[`bdexStreamIn`] | Assign to this object the value read from the specified input `stream` using the specified `version` format and return a reference to the modifiable `stream`. If `stream` is initially invalid, this operation has no effect. If `stream` becomes invalid during this operation, this object is valid, but its value is undefined. If `version` is not supported, `stream` is marked invalid and this object is unaltered. 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. | xref:BloombergLP/balb/Request/bdexStreamOut.adoc[`bdexStreamOut`] | Write the value of this object to the specified output `stream` using the specified `version` format and return a reference to the modifiable `stream`. If `version` is not supported, `stream` is 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. | xref:BloombergLP/balb/Request/featureRequest-02.adoc[`featureRequest`] | `featureRequest` overloads | xref:BloombergLP/balb/Request/isFeatureRequestValue.adoc[`isFeatureRequestValue`] | Return `true` if the value of this object is a "FeatureRequest" value, and return `false` otherwise. | xref:BloombergLP/balb/Request/isSimpleRequestValue.adoc[`isSimpleRequestValue`] | Return `true` if the value of this object is a "SimpleRequest" value, and return `false` otherwise. | xref:BloombergLP/balb/Request/isUndefinedValue.adoc[`isUndefinedValue`] | Return `true` if the value of this object is undefined, and `false` otherwise. | xref:BloombergLP/balb/Request/makeFeatureRequest-02.adoc[`makeFeatureRequest`] | `makeFeatureRequest` overloads | xref:BloombergLP/balb/Request/makeSelection-06.adoc[`makeSelection`] | `makeSelection` overloads | xref:BloombergLP/balb/Request/makeSimpleRequest-05.adoc[`makeSimpleRequest`] | `makeSimpleRequest` overloads | xref:BloombergLP/balb/Request/manipulateSelection.adoc[`manipulateSelection`] | Invoke the specified `manipulator` on the address of the modifiable selection, supplying `manipulator` with the corresponding selection information structure. Return the value returned from the invocation of `manipulator` if this object has a defined selection, and ‐1 otherwise. | xref:BloombergLP/balb/Request/print.adoc[`print`] | Format this object to the specified output `stream` at the optionally specified indentation `level` and return a reference to the modifiable `stream`. If `level` is specified, optionally specify `spacesPerLevel`, the number of spaces per indentation level for this and all of its nested objects. Each line is indented by the absolute value of `level * spacesPerLevel`. If `level` is negative, suppress indentation of the first line. If `spacesPerLevel` is negative, suppress line breaks and format the entire output on one line. If `stream` is initially invalid, this operation has no effect. Note that a trailing newline is provided in multiline mode only. | xref:BloombergLP/balb/Request/reset.adoc[`reset`] | Reset this object to the default value (i.e., its value upon default construction). | xref:BloombergLP/balb/Request/selectionId.adoc[`selectionId`] | Return the id of the current selection if the selection is defined, and ‐1 otherwise. | xref:BloombergLP/balb/Request/selectionName.adoc[`selectionName`] | Return the symbolic name of the current selection of this object. | xref:BloombergLP/balb/Request/simpleRequest-06f.adoc[`simpleRequest`] | `simpleRequest` overloads |=== == Static Member Functions [cols="1,4"] |=== | Name| Description | xref:BloombergLP/balb/Request/lookupSelectionInfo-00.adoc[`lookupSelectionInfo`] | `lookupSelectionInfo` overloads | xref:BloombergLP/balb/Request/maxSupportedBdexVersion.adoc[`maxSupportedBdexVersion`] | Return the most current `bdex` streaming version number supported by this class. See the `bslx` package‐level documentation for more information on `bdex` streaming of value‐semantic types and containers. |=== == Data Members [cols="1,4"] |=== | Name| Description | xref:BloombergLP/balb/Request/d_featureRequest.adoc[`d_featureRequest`] [.small]#[variant member]# | Storage for the "FeatureRequest" selection. | xref:BloombergLP/balb/Request/d_simpleRequest.adoc[`d_simpleRequest`] [.small]#[variant member]# | Storage for the "SimpleRequest" selection. |=== == Static Data Members [cols="1,4"] |=== | Name| Description | xref:BloombergLP/balb/Request/CLASS_NAME.adoc[`CLASS_NAME`] | Name of this class. | xref:BloombergLP/balb/Request/SELECTION_INFO_ARRAY.adoc[`SELECTION_INFO_ARRAY`] | Selection information array for this choice. |=== == Non-Member Functions [cols="1,4"] |=== | Name| Description | xref:BloombergLP/balb/operator_not_eq-029.adoc[`operator!=`] | Return `true` if the specified `lhs` and `rhs` objects do not have the same values, as determined by `operator==`, and `false` otherwise. | xref:BloombergLP/balb/operator_eq-042.adoc[`operator==`] | Return `true` if the specified `lhs` and `rhs` objects have the same value, and `false` otherwise. Two `Request` objects have the same value if either the selections in both objects have the same ids and the same values, or both selections are undefined. |=== [.small]#Created with https://www.mrdocs.com[MrDocs]#