Json::NumberRequirement Class Reference

Requirements on a numeric value. More...

#include <NumberRequirement.h>

Inheritance diagram for Json::NumberRequirement:

Public Member Functions
	NumberRequirement ()
	Constructor.
virtual void	Reset () override
	Reset Requirement.
virtual void	Parse (Value json, const std::string &path) override
	Parse JSON value to set up Requirement. More...
virtual void	Validate (const Value &json, const std::string &path) override
	Validate JSON value. More...
Public Member Functions inherited from Json::Requirement
bool	HasErrors ()
	Check if errors have occured. More...
std::vector< std::string >	GetErrors ()
	Get list of error messages. More...
virtual void	ClearErrors ()
	Clear list of error messages.
virtual bool	HasNotices ()
	Check if notices have been queued. More...
std::vector< std::string >	GetNotices ()
	Get list of notices. More...
virtual void	ClearNotices ()
	Clear list of notice messages.
virtual	~Requirement ()
	Destructor.

Private Attributes
std::string	path_
	JSON path.
double	multipleOf_
	Base value for "multiple of" requirement.
double	min_
	Lower bound for range requirement.
double	max_
	Upper bound for range requirement.
bool	multSet_
	If True, "Multiple of" requirement is active.
bool	minSet_
	If True, Lower bound for range requirement is active.
bool	maxSet_
	If True, Upper bound for range requirement is active.
bool	exclMin_
	If True, lower bound is exclusive.
bool	exclMax_
	If True, upper bound is exclusive.

Additional Inherited Members
Protected Member Functions inherited from Json::Requirement
void	PushError (const std::string &error)
	Add error to list of error messages. More...
void	PushNotice (const std::string &notice)
	Add message to list of notices. More...

Detailed Description

Requirements on a numeric value.

The numbers are stored internally as double.

Definition at line 39 of file NumberRequirement.h.

Member Function Documentation

Parse()

virtual void Json::NumberRequirement::Parse ( Value  json, const std::string &  path  )

inlineoverridevirtual

Parse JSON value to set up Requirement.

Parameters

json	JSON input value.
path	Path for JSON path specification.

Implements Json::Requirement.

Definition at line 77 of file NumberRequirement.h.

        {
            Reset();
            
            path_ = path;
            if(json.isMember("multipleOf") && json["multipleOf"].isNumeric())
            {
                multSet_ = true;
                multipleOf_ = json["multipleOf"].asDouble();
            }
 
            if(json.isMember("minimum") && json["minimum"].isNumeric())
            {
                minSet_ = true;
                min_ = json["minimum"].asDouble();
            }
 
            if(json.isMember("maximum") && json["maximum"].isNumeric())
            {
                maxSet_ = true;
                max_ = json["maximum"].asDouble();
            }
 
            if(json.isMember("exclusiveMinimum") && json["exclusiveMinimum"].isBool())
            {
                exclMin_ = json["exclusiveMinimum"].asBool();
            }
 
            if(json.isMember("exclusiveMaximum") && json["exclusiveMaximum"].isBool())
            {
                exclMax_ = json["exclusiveMaximum"].asBool();
            }
        }

References exclMax_, exclMin_, max_, maxSet_, min_, minSet_, multipleOf_, multSet_, path_, and Reset().

Here is the call graph for this function:

Validate()

virtual void Json::NumberRequirement::Validate ( const Value &  json, const std::string &  path  )

inlineoverridevirtual

Validate JSON value.

Parameters

json	JSON value to validate.
path	Path for JSON path specification.

Test that the JSON value meets the requirements set via NumberRequirement::Parse(). If the validation fails, an error is added to the list of error messages.

Implements Json::Requirement.

Definition at line 120 of file NumberRequirement.h.

        {
            if(!json.isNumeric())
            {
                PushError(path + ": Must be of type \"number\".");
                return;
            }
 
            if(multSet_ && fmod(json.asDouble(), multipleOf_) != 0)
                PushError(path + ": Value must be a multiple of " + std::to_string(multipleOf_));
 
            if(minSet_)
            {
                if(exclMin_ && json.asDouble() <= min_)
                    PushError(path + ": Value must be greater than " + std::to_string(min_));
                else if(json.asDouble() < min_)
                    PushError(path + ": Value cannot be less than " + std::to_string(min_));
            }
 
            if(maxSet_)
            {
                if(exclMax_ && json.asDouble() >= max_)
                    PushError(path + ": Value must be less than " + std::to_string(max_));
                else if(json.asDouble() > max_)
                    PushError(path + ": Value cannot be greater than " + std::to_string(max_));
            }
        }

References exclMax_, exclMin_, max_, maxSet_, min_, minSet_, multipleOf_, multSet_, and Json::Requirement::PushError().

Here is the call graph for this function:

---

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

• /home/michael/development/SSAGES/src/Validator/NumberRequirement.h