ActiveLib
Loading...
Searching...
No Matches
Public Member Functions | List of all members
active::setting::NullValue Class Reference

#include <NullValue.h>

Inheritance diagram for active::setting::NullValue:
Inheritance graph
[legend]
Collaboration diagram for active::setting::NullValue:
Collaboration graph
[legend]

Public Member Functions

 NullValue ()
 
virtual ValueclonePtr () const override
 
virtual bool operator== (const Value &ref) const override
 
virtual bool operator< (const Value &ref) const override
 
virtual Valueoperator= (const Value &val) override
 
virtual Valueoperator= (bool val) override
 
virtual Valueoperator= (int32_t val) override
 
virtual Valueoperator= (uint32_t val) override
 
virtual Valueoperator= (int64_t val) override
 
virtual Valueoperator= (double val) override
 
virtual Valueoperator= (const active::utility::String &val) override
 
virtual Valueoperator= (const active::utility::Guid &val) override
 
virtual Valueoperator= (const active::utility::Time &val) override
 
virtual operator bool () const override
 
virtual operator int32_t () const override
 
virtual operator uint32_t () const override
 
virtual operator int64_t () const override
 
virtual operator double () const override
 
virtual operator active::utility::String () const override
 
virtual operator active::utility::Guid () const override
 
virtual operator active::utility::Time () const override
 
virtual bool isNull () const override
 
virtual Type getType () const override
 
virtual void setDefault () override
 
- Public Member Functions inherited from active::setting::Value
 Value (Status stat=good)
 
virtual ~Value ()=default
 
bool operator!= (const Value &ref) const
 
virtual Valueoperator= (const char *val)
 
virtual bool isGood () const
 
- Public Member Functions inherited from active::utility::Cloner
virtual ~Cloner ()=default
 

Additional Inherited Members

- Public Types inherited from active::setting::Value
enum class  Status { undefined = 0 , bad , good }
 The value status (defines whether a value has been explicitly set and (if so) if it's meaningful.
 
enum class  Type {
  null = 0 , boolType , idType , intType ,
  floatType , stringType , timeType
}
 Supported value types (broad groups, e.g. int32_t and int64_t are both intType)
 
using Unique = std::unique_ptr<Value>
 Unique pointer.
 
using Shared = std::shared_ptr<Value>
 Shared pointer.
 
using Option = std::optional<Value>
 Optional.
 
- Static Public Member Functions inherited from active::setting::Value
static std::optional< TypetypeFromName (const utility::String &text)
 
static utility::String nameForType (Type type)
 
- Public Attributes inherited from active::setting::Value
Status status
 The value status.
 

Detailed Description

A class to represent a setting for a void (non-existant) value

This can be used in cases like JSON parsing where a value can be explicity assigned a 'null' (for example). The object will discard all assigned values without signalling an error, and returns null/empty responses for every value request

Constructor & Destructor Documentation

◆ NullValue()

active::setting::NullValue::NullValue ( )
inline

Default constructor

Here is the caller graph for this function:

Member Function Documentation

◆ clonePtr()

virtual Value * active::setting::NullValue::clonePtr ( ) const
inlineoverridevirtual

Clone method

Returns
A clone of this object

Implements active::setting::Value.

Here is the call graph for this function:

◆ getType()

virtual Type active::setting::NullValue::getType ( ) const
inlineoverridevirtual

Get the value type

Returns
The value type

Implements active::setting::Value.

◆ isNull()

virtual bool active::setting::NullValue::isNull ( ) const
inlineoverridevirtual

Determine if the value is null, e.g. zero, empty, undefined

Returns
True if the value is null

Implements active::setting::Value.

◆ operator active::utility::Guid()

virtual active::setting::NullValue::operator active::utility::Guid ( ) const
inlineoverridevirtual

Get a guid value

Returns
A guid value

Implements active::setting::Value.

◆ operator active::utility::String()

virtual active::setting::NullValue::operator active::utility::String ( ) const
inlineoverridevirtual

Get a string value

Returns
A string value

Implements active::setting::Value.

◆ operator active::utility::Time()

virtual active::setting::NullValue::operator active::utility::Time ( ) const
inlineoverridevirtual

Get a time value

Returns
A time value

Implements active::setting::Value.

◆ operator bool()

virtual active::setting::NullValue::operator bool ( ) const
inlineoverridevirtual

Get a boolean value

Returns
A boolean value

Implements active::setting::Value.

◆ operator double()

virtual active::setting::NullValue::operator double ( ) const
inlineoverridevirtual

Get a double precision value

Returns
A double precision value

Implements active::setting::Value.

◆ operator int32_t()

virtual active::setting::NullValue::operator int32_t ( ) const
inlineoverridevirtual

Get a 32-bit integer value

Returns
A 32-bit integer value

Implements active::setting::Value.

◆ operator int64_t()

virtual active::setting::NullValue::operator int64_t ( ) const
inlineoverridevirtual

Get a 64-bit integer value

Returns
A 64-bit integer value

Implements active::setting::Value.

◆ operator uint32_t()

virtual active::setting::NullValue::operator uint32_t ( ) const
inlineoverridevirtual

Get an unsigned 32-bit integer value

Returns
An unsigned 32-bit integer value

Implements active::setting::Value.

◆ operator<()

virtual bool active::setting::NullValue::operator< ( const Value & ref) const
inlineoverridevirtual

Less-than operator

Parameters
refA value to compare with this
Returns
True if this is less than ref

Implements active::setting::Value.

Here is the call graph for this function:

◆ operator=() [1/9]

virtual Value & active::setting::NullValue::operator= ( bool val)
inlineoverridevirtual

Assignment operator

Parameters
valA boolean value to assign
Returns
A reference to this

Implements active::setting::Value.

◆ operator=() [2/9]

virtual Value & active::setting::NullValue::operator= ( const active::utility::Guid & val)
inlineoverridevirtual

Assignment operator

Parameters
valA guid value to assign
Returns
A reference to this

Implements active::setting::Value.

◆ operator=() [3/9]

virtual Value & active::setting::NullValue::operator= ( const active::utility::String & val)
inlineoverridevirtual

Assignment operator

Parameters
valA string value to assign
Returns
A reference to this

Implements active::setting::Value.

◆ operator=() [4/9]

virtual Value & active::setting::NullValue::operator= ( const active::utility::Time & val)
inlineoverridevirtual

Assignment operator

Parameters
valA time value to assign
Returns
A reference to this

Implements active::setting::Value.

◆ operator=() [5/9]

virtual Value & active::setting::NullValue::operator= ( const Value & val)
inlineoverridevirtual

Assignment operator

Parameters
valA value to assign
Returns
A reference to this

Implements active::setting::Value.

◆ operator=() [6/9]

virtual Value & active::setting::NullValue::operator= ( double val)
inlineoverridevirtual

Assignment operator

Parameters
valA double precision value to assign
Returns
A reference to this

Implements active::setting::Value.

◆ operator=() [7/9]

virtual Value & active::setting::NullValue::operator= ( int32_t val)
inlineoverridevirtual

Assignment operator

Parameters
valA 32-bit integer value to assign
Returns
A reference to this

Implements active::setting::Value.

◆ operator=() [8/9]

virtual Value & active::setting::NullValue::operator= ( int64_t val)
inlineoverridevirtual

Assignment operator

Parameters
valA 64-bit integer value to assign
Returns
A reference to this

Implements active::setting::Value.

◆ operator=() [9/9]

virtual Value & active::setting::NullValue::operator= ( uint32_t val)
inlineoverridevirtual

Assignment operator

Parameters
valAn unsigned 32-bit integer value to assign
Returns
A reference to this

Implements active::setting::Value.

◆ operator==()

virtual bool active::setting::NullValue::operator== ( const Value & ref) const
inlineoverridevirtual

Equality operator

Parameters
refA value to compare with this
Returns
True if this is identical to ref

Implements active::setting::Value.

Here is the call graph for this function:

◆ setDefault()

virtual void active::setting::NullValue::setDefault ( )
inlineoverridevirtual

Set a default value

Implements active::setting::Value.


The documentation for this class was generated from the following file: