utl::Bool Class Reference
Boolean value. More...
#include <Bool.h>
Inheritance diagram for utl::Bool:
Public Member Functions | |
| Bool (bool b) | |
| Constructor. More... | |
| Bool (const String &str) | |
| Constructor. More... | |
| virtual int | compare (const Object &rhs) const |
| Compare with another object. More... | |
| virtual void | copy (const Object &rhs) |
| Copy another instance. More... | |
| virtual void | serialize (Stream &stream, uint_t io, uint_t mode=ser_default) |
| Serialize to or from a stream. More... | |
| virtual String | toString () const |
| Get a string representation ("true" or "false"). More... | |
| bool | get () const |
| Get the value. More... | |
| void | set (const String &str) |
| Set the value from a string representation. More... | |
| void | set (bool b) |
| Set the value. More... | |
| operator bool () const | |
| Conversion to bool. More... | |
| operator bool () | |
| Conversion to bool. More... | |
 Public Member Functions inherited from utl::Object | |
| void | clear () |
| Revert to initial state. More... | |
| virtual void | vclone (const Object &rhs) |
| Make an exact copy of another instance. More... | |
| virtual void | steal (Object &rhs) |
| "Steal" the internal representation from another instance. More... | |
| virtual void | dump (Stream &os, uint_t level=uint_t_max) const |
| Dump a human-readable representation of self to the given output stream. More... | |
| void | dumpWithClassName (Stream &os, uint_t indent=4, uint_t level=uint_t_max) const |
| Front-end for dump() that prints the object's class name. More... | |
| virtual const Object & | getKey () const |
| Get the key for this object. More... | |
| bool | hasKey () const |
| Determine whether or not the object has a key. More... | |
| virtual const Object & | getProxiedObject () const |
| Get the proxied object (= self if none). More... | |
| virtual Object & | getProxiedObject () |
| Get the proxied object (= self if none). More... | |
| virtual size_t | hash (size_t size) const |
| Get the hash code for the object. More... | |
| bool | _isA (const RunTimeClass *runTimeClass) const |
| Determine whether self's class is a descendent of the given class. More... | |
| operator String () const | |
| Conversion to String. More... | |
| size_t | allocatedSize () const |
| Get the total allocated size of this object. More... | |
| virtual size_t | innerAllocatedSize () const |
| Get the "inner" allocated size. More... | |
| virtual void | addOwnedIt (const class FwdIt *it) const |
| Notify self that it owns the given iterator. More... | |
| virtual void | removeOwnedIt (const class FwdIt *it) const |
| Notify self that the given owned iterator has been destroyed. More... | |
| bool | operator< (const Object &rhs) const |
| Less-than operator. More... | |
| bool | operator<= (const Object &rhs) const |
| Less-than-or-equal-to operator. More... | |
| bool | operator> (const Object &rhs) const |
| Greater-than operator. More... | |
| bool | operator>= (const Object &rhs) const |
| Greater-than-or-equal-to operator. More... | |
| bool | operator== (const Object &rhs) const |
| Equal-to operator. More... | |
| bool | operator!= (const Object &rhs) const |
| Unequal-to operator. More... | |
| void | serializeIn (Stream &is, uint_t mode=ser_default) |
| Serialize from an input stream. More... | |
| void | serializeOut (Stream &os, uint_t mode=ser_default) const |
| Serialize to an output stream. More... | |
| void | serializeOutBoxed (Stream &os, uint_t mode=ser_default) const |
| Serialize a boxed object to an output stream. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from utl::Object | |
| static Object * | serializeInNullable (Stream &is, uint_t mode=ser_default) |
| Serialize a nullptr-able object from an input stream. More... | |
| static void | serializeOutNullable (const Object *object, Stream &os, uint_t mode=ser_default) |
| Serialize a nullptr-able object to an output stream. More... | |
| static void | serializeNullable (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default) |
| Serialize a nullptr-able object to or from a stream. More... | |
| static Object * | serializeInBoxed (Stream &is, uint_t mode=ser_default) |
| Serialize a boxed object from an input stream. More... | |
| static void | serializeBoxed (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default) |
| Serialize a boxed object to or from a stream. More... | |
Detailed Description
Constructor & Destructor Documentation
◆ Bool() [1/2]
|
inline |
◆ Bool() [2/2]
|
inline |
Constructor.
- Parameters
-
str string representation ("true"/"yes", "false"/"no", "on/off")
Definition at line 40 of file Bool.h.
References utl::compare(), utl::copy(), utl::ser_default, utl::serialize(), and utl::toString().
Member Function Documentation
◆ compare()
|
virtual |
Compare with another object.
If no overridden version succeeds in doing the comparison, then an attempt will be made to re-start the comparison process using one or both of the objects' keys. Usually, an override of compare() should call the superclass's compare() if it doesn't know how to compare itself with the rhs object.
- See also
- getKey
- Returns
- < 0 if self < rhs, 0 if self = rhs, > 0 if self > rhs
- Parameters
-
rhs object to compare with
Reimplemented from utl::Object.
◆ copy()
|
virtual |
Copy another instance.
When you override copy(), you should usually call the superclass's copy().
- Parameters
-
rhs object to copy
Reimplemented from utl::Object.
◆ serialize()
|
virtual |
Serialize to or from a stream.
This is the only virtual method for serialization. You must override this in any class that has data to be serialized, and ensure that the superclass's serialize() gets called.
- Parameters
-
stream stream to serialize from/to io see utl::io_t mode see utl::serialize_t
Reimplemented from utl::Object.
◆ toString()
|
virtual |
Get a string representation ("true" or "false").
Reimplemented from utl::Object.
◆ get()
◆ set() [1/2]
| void utl::Bool::set | ( | const String & | str | ) |
Set the value from a string representation.
- Parameters
-
str string representation ("true"/"yes", "false"/"no", "on/off")
◆ set() [2/2]
◆ operator bool() [1/2]
◆ operator bool() [2/2]
|
inline |
Conversion to bool.
Definition at line 81 of file Bool.h.
References utl::deInit(), and utl::init().
The documentation for this class was generated from the following file:
