Parsnip::RangeSchema< NumericType > Class Template Reference

Schema component for numeric data, either Integer or Real. More...

#include <parsnip_schema.h>

Inheritance diagram for Parsnip::RangeSchema< NumericType >:

Collaboration diagram for Parsnip::RangeSchema< NumericType >:

Public Types
using	value_type = NumericType

Public Member Functions
	RangeSchema (const NumericType min=std::numeric_limits< NumericType >::lowest(), const NumericType max=std::numeric_limits< NumericType >::max())
	Construct a numeric schema from a schema definition. More...
	RangeSchema ()=default
	RangeSchema (const RangeSchema &)=default
	RangeSchema (RangeSchema &&)=default
RangeSchema &	operator= (const RangeSchema &)=default
RangeSchema &	operator= (RangeSchema &&)=default
	RangeSchema (const Parsnip::Data &schema_spec)
	Construct a numeric schema from a schema definition. More...
virtual RangeSchema *	createCopy () const override
	Create an identical, deep copy of the schema. More...
virtual void	validate (const Parsnip::Data &entry) const override
	Validate item range: ensure the datatype falls within the allowed range. More...
virtual bool	operator== (const SchemaBase &other) const override
	Check if two schemas perform the same validation. More...
virtual void	mergeSchemas (const SchemaBase &from) override
	Merge elements into the current schema. More...
virtual std::ostream &	dump (std::ostream &target, int indent, bool suppress_ident=false) const override
	Render the schema in human-friendly text. More...
Public Member Functions inherited from Parsnip::SchemaBase
virtual	~SchemaBase ()=default
bool	operator!= (const SchemaBase &other) const

Private Attributes
bool	minimumIsInclusive = true
NumericType	minimum
bool	maximumIsInclusive = true
NumericType	maximum

Additional Inherited Members
Protected Types inherited from Parsnip::SchemaBase
using	StringType = Data::StringType
using	SchemaRegex = std::basic_regex< StringType::value_type >
Protected Member Functions inherited from Parsnip::SchemaBase
	SchemaBase ()=default
	SchemaBase (const SchemaBase &)=default
	SchemaBase (SchemaBase &&)=default
SchemaBase &	operator= (const SchemaBase &)=default
SchemaBase &	operator= (SchemaBase &&)=default
	SchemaBase (const Parsnip::Data &schema_spec)
	Construct a schema from a JSON specification. More...
void	checkType (Data::Type expected, const Parsnip::Data &entry) const
	Check that Data item is an allowed type. More...
bool	isValidlyNull (const Parsnip::Data &entry) const
	Determine if the data is Null and if that is allowed. More...
bool	isType (Data::Type expected, const Parsnip::Data &entry) const
	Check if a data object is a particular type. More...
Protected Attributes inherited from Parsnip::SchemaBase
bool	nullable = false
	If true, element may be null. More...

Detailed Description

template<typename NumericType>
class Parsnip::RangeSchema< NumericType >

Schema component for numeric data, either Integer or Real.

Member Typedef Documentation

value_type

template<typename NumericType >

using Parsnip::RangeSchema< NumericType >::value_type = NumericType

Constructor & Destructor Documentation

RangeSchema() [1/5]

template<typename NumericType >

Parsnip::RangeSchema< NumericType >::RangeSchema	(	const NumericType	min = std::numeric_limits<NumericType>::lowest(),
		const NumericType	max = std::numeric_limits<NumericType>::max()
	)

Construct a numeric schema from a schema definition.

Template Parameters

NumericType

Either double for number or long for integer.

Parameters

min	The minimum acceptable value.
max	The maximum allowed value.

RangeSchema() [2/5]

template<typename NumericType >

Parsnip::RangeSchema< NumericType >::RangeSchema ( )

default

RangeSchema() [3/5]

template<typename NumericType >

Parsnip::RangeSchema< NumericType >::RangeSchema ( const RangeSchema< NumericType > &  )

default

RangeSchema() [4/5]

template<typename NumericType >

Parsnip::RangeSchema< NumericType >::RangeSchema ( RangeSchema< NumericType > &&  )

default

RangeSchema() [5/5]

template<typename NumericType >

Parsnip::RangeSchema< NumericType >::RangeSchema

(

const Parsnip::Data &

schema_spec

)

Construct a numeric schema from a schema definition.

Template Parameters

NumericType

Either double for number or long for integer.

Parameters

schema_spec

The schema specification.

Here is the call graph for this function:

Member Function Documentation

createCopy()

template<typename NumericType >

RangeSchema< NumericType > * Parsnip::RangeSchema< NumericType >::createCopy ( ) const

overridevirtual

Create an identical, deep copy of the schema.

Caller is responsible for deleting it.

Implements Parsnip::SchemaBase.

Reimplemented in Parsnip::IntegerSchema.

dump()

template<typename NumericType >

std::ostream & Parsnip::RangeSchema< NumericType >::dump ( std::ostream &  target, int  indent, bool  suppress_indent = false  ) const

overridevirtual

Render the schema in human-friendly text.

Parameters

target	Where to write the schema.
indent	Amount of indent to use.
suppress_indent	Flag indicating indent was already performed.

Implements Parsnip::SchemaBase.

mergeSchemas()

template<typename NumericType >

void Parsnip::RangeSchema< NumericType >::mergeSchemas ( const SchemaBase &  from )

overridevirtual

Merge elements into the current schema.

Merge elements managed by this class.

• Elements seen every time are mandatory.
• Elements seen only sometime are optional.
• Elements always seen together are codependent.
• Elements must always expect similar types, except they may vary as element and list-of-same-element.

  Parameters

  from	A schema for a valid command command line.

  Exceptions

  Various

  exceptions.

Reimplemented from Parsnip::SchemaBase.

Here is the call graph for this function:

operator=() [1/2]

template<typename NumericType >

RangeSchema& Parsnip::RangeSchema< NumericType >::operator= ( const RangeSchema< NumericType > &  )

default

operator=() [2/2]

template<typename NumericType >

RangeSchema& Parsnip::RangeSchema< NumericType >::operator= ( RangeSchema< NumericType > &&  )

default

operator==()

template<typename NumericType >

bool Parsnip::RangeSchema< NumericType >::operator== ( const SchemaBase &  other ) const

overridevirtual

Check if two schemas perform the same validation.

Compare two schemas to see if they determine validity in the same manner.

Parameters

other

The schema to compare to.

Returns

True if the schemas match, false otherwise.

Reimplemented from Parsnip::SchemaBase.

Reimplemented in Parsnip::IntegerSchema.

Here is the call graph for this function:

validate()

template<typename NumericType >

void Parsnip::RangeSchema< NumericType >::validate ( const Parsnip::Data &  entry ) const

overridevirtual

Validate item range: ensure the datatype falls within the allowed range.

Implements Parsnip::SchemaBase.

Reimplemented in Parsnip::IntegerSchema.

Here is the call graph for this function:

Member Data Documentation

maximum

template<typename NumericType >

NumericType Parsnip::RangeSchema< NumericType >::maximum

private

maximumIsInclusive

template<typename NumericType >

bool Parsnip::RangeSchema< NumericType >::maximumIsInclusive = true

private

minimum

template<typename NumericType >

NumericType Parsnip::RangeSchema< NumericType >::minimum

private

minimumIsInclusive

template<typename NumericType >

bool Parsnip::RangeSchema< NumericType >::minimumIsInclusive = true

private

---

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

• parsnip/parsnip_schema.h
• parsnip/parsnip_schema.cpp