the restriction of number class More...

#include <NumberRestriction.h>

Public Member Functions
	NumberRestriction ()
	constructor

virtual	~NumberRestriction ()
	destructor

void	reset ()
	resets restriction

void	setInclusiveMinValue (const double value)
	sets inclusive min value More...

bool	hasInclusiveMinValue ()
	judges whether this argument inclusive min value. More...

double	getInclusiveMinValue (const double dfValue=0.0)
	gets min inclusive value More...

void	setInclusiveMaxValue (const double value)
	sets inclusive max value More...

bool	hasInclusiveMaxValue ()
	judges whether this argument inclusive max value. More...

double	getInclusiveMaxValue (const double dfValue=0.0)
	gets max inclusive value More...

void	setExclusiveMinValue (const double value)
	sets exclusive min value More...

bool	hasExclusiveMinValue ()
	judges whether this argument exclusive min value. More...

double	getExclusiveMinValue (const double dfValue=0.0)
	gets min exclusive value More...

void	setExclusiveMaxValue (const double value)
	sets exclusive max value More...

bool	hasExclusiveMaxValue ()
	judges whether this argument exclusive max value. More...

double	getExclusiveMaxValue (const double dfValue=0.0)
	gets max exclusive value More...

double	getLowerBound (const double dfValue=0.0)
	gets lower bound value More...

double	getUpperBound (const double dfValue=0.0)
	gets upper bound value More...

bool	checkDoubleValue (const double value)
	checks real number value is in the specified range More...

bool	checkIntValue (const int value)
	checks integer value is in the specified range More...

std::string	getRangeStr (const char *name)
	gets character string that means value range More...

Protected Attributes
boost::optional< double >	m_minInclusive

boost::optional< double >	m_maxInclusive

boost::optional< double >	m_minExclusive

boost::optional< double >	m_maxExclusive

Detailed Description

the restriction of number class

Definition at line 26 of file NumberRestriction.h.

Member Function Documentation

bool kome::core::NumberRestriction::checkDoubleValue ( const double value )

checks real number value is in the specified range

Parameters

[in] value value to be checked

Returns: If value is in the specified range, this method returns true.

Definition at line 169 of file NumberRestriction.cpp.

                                                              {
     // min inclusive
     if( m_minInclusive ) {
         if( value < m_minInclusive.get() ) {
             return false;
         }
     }
 
     // max inclusive
     if( m_maxInclusive ) {
         if( value > m_maxInclusive.get() ) {
             return false;
         }
     }
 
     // min exclusive
     if( m_minExclusive ) {
         if( value <= m_minExclusive.get() ) {
             return false;
         }
     }
 
     // max exclusive
     if( m_maxExclusive ) {
         if( value >= m_maxExclusive.get() ) {
             return false;
         }
     }
 
     return true;
 }

bool kome::core::NumberRestriction::checkIntValue ( const int value )

checks integer value is in the specified range

Parameters

[in] value value to be checked

Returns: If value is in the specified range, this method returns true.

Definition at line 202 of file NumberRestriction.cpp.

                                                        {
     // min inclusive
     if( m_minInclusive ) {
         if( value < roundnum( m_minInclusive.get() ) ) {
             return false;
         }
     }
 
     // max inclusive
     if( m_maxInclusive ) {
         if( value > roundnum( m_maxInclusive.get() ) ) {
             return false;
         }
     }
 
     // min exclusive
     if( m_minExclusive ) {
         if( value <= roundnum( m_minExclusive.get() ) ) {
             return false;
         }
     }
 
     // max exclusive
     if( m_maxExclusive ) {
         if( value >= roundnum( m_maxExclusive.get() ) ) {
             return false;
         }
     }
 
     return true;
 }

Here is the call graph for this function:

double kome::core::NumberRestriction::getExclusiveMaxValue ( const double dfValue = 0.0 )

gets max exclusive value

Parameters

[in] dfValue default value

Returns: If this argument has exclusive max value, this method returns it, otherwise returns default value.

Definition at line 119 of file NumberRestriction.cpp.

                                                                      {
     if( m_maxExclusive ) {
         return m_maxExclusive.get();
     }
     return dfValue;
 }

double kome::core::NumberRestriction::getExclusiveMinValue ( const double dfValue = 0.0 )

gets min exclusive value

Parameters

[in] dfValue default value

Returns: If this argument has exclusive min value, this method returns it, otherwise returns default value.

Definition at line 98 of file NumberRestriction.cpp.

                                                                      {
     if( m_minExclusive ) {
         return m_minExclusive.get();
     }
     return dfValue;
 }

double kome::core::NumberRestriction::getInclusiveMaxValue ( const double dfValue = 0.0 )

gets max inclusive value

Parameters

[in] dfValue default value

Returns: If this argument has inclusive max value, this method returns it, otherwise returns default value.

Definition at line 77 of file NumberRestriction.cpp.

                                                                      {
     if( m_maxInclusive ) {
         return m_maxInclusive.get();
     }
     return dfValue;
 }

double kome::core::NumberRestriction::getInclusiveMinValue ( const double dfValue = 0.0 )

gets min inclusive value

Parameters

[in] dfValue default value

Returns: If this argument has inclusive min value, this method returns it, otherwise returns default value.

Definition at line 56 of file NumberRestriction.cpp.

                                                                      {
     if( m_minInclusive ) {
         return m_minInclusive.get();
     }
     return dfValue;
 }

double kome::core::NumberRestriction::getLowerBound ( const double dfValue = 0.0 )

gets lower bound value

Parameters

[in] dfValue default value

Returns: If this argument has lower bound value, this method returns it, otherwise returns default value.

Definition at line 127 of file NumberRestriction.cpp.

                                                               {
     if( m_minInclusive ) {
         double v0 = m_minInclusive.get();
         if( m_minExclusive ) {
             double v1 = m_minExclusive.get();
 
             // compare
             return MAX( v0, v1 );
          }
         return v0;
     }
     else if( m_minExclusive ) {
         double v1 = m_minExclusive.get();
         return v1;
     }
 
     // default value
     return dfValue;
 }

std::string kome::core::NumberRestriction::getRangeStr ( const char * name )

gets character string that means value range

Parameters

[in] name number value name

Returns: character string that means value range

Definition at line 235 of file NumberRestriction.cpp.

                                                            {
     // string
     std::string range;
 
     // variables
     boost::optional< double > v;
     bool inclusive = false;
 
     // get min value
     if( m_minExclusive ) {
         v = m_minExclusive.get();
     }
     if( m_minInclusive ) {
         if( !v || m_minInclusive.get() > v.get() ) {
             v = m_minInclusive.get();
             inclusive = true;
         }
     }
 
     // min value
     if( v ) {
 
         if (m_maxExclusive || m_maxInclusive)
         {
             range = FMT( "%g <", v.get() );
             if( inclusive ) {
                 range.append( "=" );
             }
             range.append( " " );
             range.append( NVL( name, "" ) );
         }
         else
         {
             // In the case where no maximum value is going to be expressed
             // in the range string, it is better to put the name first.
             range.append( NVL( name, "" ) );
             range.append( " " );
             if( inclusive ) {
                 range += FMT( ">= %g", v.get() );
             }
             else
             {
                 range += FMT( "> %g", v.get() );
             }
         }
     }
 
     // get max value
     v.reset();
     inclusive = false;
 
     if( m_maxExclusive ) {
         v = m_maxExclusive.get();
     }
     if( m_maxInclusive ) {
         if( !v || m_maxInclusive.get() < v.get() ) {
             v = m_maxInclusive.get();
             inclusive = true;
         }
     }
 
     // print maxvalue
     if( v ) {
         if( range.empty() ) {
             range = NVL( name, "" );
         }
         range.append( " <" );
         if( inclusive ) {
             range.append( "=" );
         }
         range.append( FMT( " %g", v.get() ) );
     }
 
     return range;
 }

double kome::core::NumberRestriction::getUpperBound ( const double dfValue = 0.0 )

gets upper bound value

Parameters

[in] dfValue default value

Returns: If this argument has upper bound value, this method returns it, otherwise returns default value.

Definition at line 148 of file NumberRestriction.cpp.

                                                               {
     if( m_maxInclusive ) {
         double v0 = m_maxInclusive.get();
         if( m_maxExclusive ) {
             double v1 = m_maxExclusive.get();
 
             // compare
             return MIN( v0, v1 );
          }
         return v0;
     }
     else if( m_maxExclusive ) {
         double v1 = m_maxExclusive.get();
         return v1;
     }
 
     // default value
     return dfValue; 
 }

bool kome::core::NumberRestriction::hasExclusiveMaxValue ( )

judges whether this argument exclusive max value.

Returns: If this argument has exclusive max value, this method returns true.

Definition at line 111 of file NumberRestriction.cpp.

                                              {
     if( m_maxExclusive ) {
         return true;
     }
     return false;
 }

bool kome::core::NumberRestriction::hasExclusiveMinValue ( )

judges whether this argument exclusive min value.

Returns: If this argument has exclusive min value, this method returns true.

Definition at line 90 of file NumberRestriction.cpp.

                                              {
     if( m_minExclusive ) {
         return true;
     }
     return false;
 }

bool kome::core::NumberRestriction::hasInclusiveMaxValue ( )

judges whether this argument inclusive max value.

Returns: If this argument has inclusive max value, this method returns true.

Definition at line 69 of file NumberRestriction.cpp.

                                              {
     if( m_maxInclusive ) {
         return true;
     }
     return false;
 }

bool kome::core::NumberRestriction::hasInclusiveMinValue ( )

judges whether this argument inclusive min value.

Returns: If this argument has inclusive min value, this method returns true.

Definition at line 48 of file NumberRestriction.cpp.

                                              {
     if( m_minInclusive ) {
         return true;
     }
     return false;
 }

void kome::core::NumberRestriction::setExclusiveMaxValue ( const double value )

sets exclusive max value

Parameters

[in] value exclusive max value

Definition at line 106 of file NumberRestriction.cpp.

                                                                  {
     m_maxExclusive = value;
 }

void kome::core::NumberRestriction::setExclusiveMinValue ( const double value )

sets exclusive min value

Parameters

[in] value exclusive min value

Definition at line 85 of file NumberRestriction.cpp.

                                                                  {
     m_minExclusive = value;
 }

void kome::core::NumberRestriction::setInclusiveMaxValue ( const double value )

sets inclusive max value

Parameters

[in] value inclusive max value

Definition at line 64 of file NumberRestriction.cpp.

                                                                  {
     m_maxInclusive = value;
 }

void kome::core::NumberRestriction::setInclusiveMinValue ( const double value )

sets inclusive min value

Parameters

[in] value inclusive min value

Definition at line 43 of file NumberRestriction.cpp.

                                                                  {
     m_minInclusive = value;
 }

Member Data Documentation

boost::optional< double > kome::core::NumberRestriction::m_maxExclusive

protected

exclusive maximum value

Definition at line 48 of file NumberRestriction.h.

boost::optional< double > kome::core::NumberRestriction::m_maxInclusive

protected

inclusive maximum value

Definition at line 44 of file NumberRestriction.h.

boost::optional< double > kome::core::NumberRestriction::m_minExclusive

protected

exclusive minimum value

Definition at line 46 of file NumberRestriction.h.

boost::optional< double > kome::core::NumberRestriction::m_minInclusive

protected

inclusive minimum value

Definition at line 42 of file NumberRestriction.h.

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

CoreToolkits/NumberRestriction.h
CoreToolkits/NumberRestriction.cpp

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation