[#BloombergLP-balb-CustomInt]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balb.adoc[balb]::CustomInt
:relfileprefix: ../../
:mrdocs:

This class provides a customized integer type used by test messages.

== Synopsis

Declared in `<balb_testmessages.h>`

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

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balb/CustomInt/BaseType.adoc[`BaseType`] 
| Base integer type for this customized type.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balb/CustomInt/2constructor-01.adoc[`CustomInt`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/balb/CustomInt/2destructor.adoc[`~CustomInt`] [.small]#[destructor]#
| Destroy this object.
| xref:BloombergLP/balb/CustomInt/operator_assign.adoc[`operator=`] 
| Assign to this object the value of the specified `rhs` object.
| xref:BloombergLP/balb/CustomInt/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/CustomInt/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/CustomInt/fromInt.adoc[`fromInt`] 
| Convert from the specified `value` to this type. Return 0 if successful and non‐zero otherwise.
| xref:BloombergLP/balb/CustomInt/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.
| xref:BloombergLP/balb/CustomInt/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/CustomInt/reset.adoc[`reset`] 
| Reset this object to the default value (i.e., its value upon default construction).
| xref:BloombergLP/balb/CustomInt/toInt.adoc[`toInt`] 
| Convert this value to `int`.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balb/CustomInt/checkRestrictions.adoc[`checkRestrictions`] 
| Check if the specified `value` satisfies the restrictions of this class (i.e., "CustomInt"). Return 0 if successful (i.e., the restrictions are satisfied) and non‐zero otherwise.
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balb/CustomInt/CLASS_NAME.adoc[`CLASS_NAME`] 
| Name of this class.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/balb/operator_not_eq-037.adoc[BloombergLP::balb::operator!=]`
| Return `true` if the specified `lhs` and `rhs` attribute objects do not have the same value, and `false` otherwise. Two attribute objects do not have the same value if one or more respective attributes differ in values.
| `xref:BloombergLP/balb/operator_eq-0d.adoc[BloombergLP::balb::operator==]`
| Return `true` if the specified `lhs` and `rhs` attribute objects have the same value, and `false` otherwise. Two attribute objects have the same value if each respective attribute has the same value.
|===


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