#include <ball_userfields.h>
List of all members.
Detailed Description
This class implements a value-semantic type for representing a sequence of (randomly accessible) user field values.
See Component ball_userfields
Member Typedef Documentation
Constructor & Destructor Documentation
| ball::UserFields::UserFields |
( |
bslma::Allocator * |
basicAllocator = 0 |
) |
[explicit] |
Create an empty UserFields object. Optionally specify a basicAllocator used to supply memory. If basicAllocator is 0, the currently installed default allocator is used.
Create a UserFields object having the same value as the specified original object. Optionally specify a basicAllocator used to supply memory. If basicAllocator is 0, the currently installed default allocator is used.
| ball::UserFields::~UserFields |
( |
|
) |
|
Member Function Documentation
Assign to this object the value of the specified rhs object, and return a reference providing modifiable access to this object.
| void ball::UserFields::removeAll |
( |
|
) |
|
Remove all of the user field values from this object. After this method is called length is 0.
Append the specified value to this object.
| void ball::UserFields::appendNull |
( |
|
) |
|
Append an element having the unset value to this object.
| void ball::UserFields::appendDouble |
( |
double |
value |
) |
|
| void ball::UserFields::appendString |
( |
const bsl::string_view & |
value |
) |
|
| void ball::UserFields::appendCharArray |
( |
const bsl::vector< char > & |
value |
) |
|
Append the specified value to this object.
Return a reference providing modifiable access to the value at the specified index. The behavior is undefined unless 0 <= index && index < length().
| void ball::UserFields::swap |
( |
UserFields & |
other |
) |
|
Efficiently exchange the value of this object with the value of the specified other object. This method provides the no-throw exception-safety guarantee. The behavior is undefined unless this object was created with the same allocator as other.
Return an iterator providing non-modifiable access to the first element in the sequence of user field values maintained by this object, or the end iterator if this object is empty.
Return an iterator providing non-modifiable access to the past-the-end element in the sequence of user field values maintained by this object.
| int ball::UserFields::length |
( |
|
) |
const |
Return the number of user field values in this object.
Return a reference providing non-modifiable access to the value at the specified index. The behavior is undefined unless 0 <= index && index < length().
Return the allocator used by this object to supply memory. Note that if no allocator was supplied at construction the currently installed default allocator is used.
| bsl::ostream& ball::UserFields::print |
( |
bsl::ostream & |
stream, |
|
|
int |
level = 0, |
|
|
int |
spacesPerLevel = 4 | |
|
) |
| | const |
Write the value of this object to the specified output stream in a human-readable format, and return a reference to stream. Optionally specify an initial indentation level, whose absolute value is incremented recursively for nested objects. If level is specified, optionally specify spacesPerLevel, whose absolute value indicates the number of spaces per indentation level for this and all of its nested objects. If level is negative, suppress indentation of the first line. If spacesPerLevel is negative, format the entire output on one line, suppressing all but the initial indentation (as governed by level). If stream is not valid on entry, this operation has no effect. Note that the format is not fully specified, and can change without notice.
Friends And Related Function Documentation
Return true if the specified lhs and rhs objects have the same value, and false otherwise. Two ball::UserFields objects have the same value if they have the same number of elements, and each element in lhs has the same value as corresponding element at the same index in rhs.
Swap the value of the specified a object with the value of the specified b object. If a and b were created with the same allocator, then this method provides the no-throw exception-safety guarantee; otherwise, it provides the basic guarantee.
The documentation for this class was generated from the following file:
