ROSE  0.9.10.95
Public Types | Static Public Member Functions | Protected Member Functions | List of all members
Sawyer::CommandLine::RealNumberParser< T > Class Template Reference

Description

template<typename T>
class Sawyer::CommandLine::RealNumberParser< T >

Parses a real number and converts it to numeric type T.

Matches a real number in the mathematical sense in C++ floating-point representation, and attempts to convert it to the type T. If the real number cannot be converted to type T then an std::range_error is thrown, which is most likely caught by higher layers of the library and converted to an std::runtime_error with additional information about the failure. The syntax is that which is recognized by the strtod function, plus trailing white space.

See also
realNumberParser factory, and Command line parser factories.

Definition at line 1083 of file util/Sawyer/CommandLine.h.

#include <CommandLine.h>

Inheritance diagram for Sawyer::CommandLine::RealNumberParser< T >:
Inheritance graph
[legend]
Collaboration diagram for Sawyer::CommandLine::RealNumberParser< T >:
Collaboration graph
[legend]

Public Types

typedef SharedPointer< RealNumberParserPtr
 Reference counting pointer for this class. More...
 
- Public Types inherited from Sawyer::CommandLine::ValueParser
typedef SharedPointer< ValueParserPtr
 Reference counting pointer for this class. More...
 

Static Public Member Functions

static Ptr instance ()
 Allocating constructor. More...
 
static Ptr instance (const ValueSaver::Ptr &valueSaver)
 Allocating constructor. More...
 

Protected Member Functions

 RealNumberParser ()
 Constructor for derived classes. More...
 
 RealNumberParser (const ValueSaver::Ptr &valueSaver)
 Constructor for derived classes. More...
 
- Protected Member Functions inherited from Sawyer::CommandLine::ValueParser
 ValueParser ()
 Constructor for derived classes. More...
 
 ValueParser (const ValueSaver::Ptr &valueSaver)
 Constructor for derived classes. More...
 

Additional Inherited Members

- Public Member Functions inherited from Sawyer::CommandLine::ValueParser
ParsedValue matchString (const std::string &)
 Parse the entire string and return a value. More...
 
ParsedValue match (Cursor &)
 Parse a value from the beginning of the specified string. More...
 
Ptr valueSaver (const ValueSaver::Ptr &f)
 Property: functor responsible for saving a parsed value in user storage. More...
 
const ValueSaver::Ptr valueSaver () const
 Property: functor responsible for saving a parsed value in user storage. More...
 
- Public Member Functions inherited from Sawyer::SharedObject
 SharedObject ()
 Default constructor. More...
 
 SharedObject (const SharedObject &)
 Copy constructor. More...
 
virtual ~SharedObject ()
 Virtual destructor. More...
 
SharedObjectoperator= (const SharedObject &)
 Assignment. More...
 
- Public Member Functions inherited from Sawyer::SharedFromThis< ValueParser >
SharedPointer< ValueParser > sharedFromThis ()
 Create a shared pointer from this. More...
 
SharedPointer< const ValueParser > sharedFromThis () const
 Create a shared pointer from this. More...
 

Member Typedef Documentation

Reference counting pointer for this class.

Definition at line 1092 of file util/Sawyer/CommandLine.h.

Constructor & Destructor Documentation

template<typename T >
Sawyer::CommandLine::RealNumberParser< T >::RealNumberParser ( )
inlineprotected

Constructor for derived classes.

Non-subclass users should use instance instead.

Definition at line 1086 of file util/Sawyer/CommandLine.h.

Referenced by Sawyer::CommandLine::RealNumberParser< T >::instance().

template<typename T >
Sawyer::CommandLine::RealNumberParser< T >::RealNumberParser ( const ValueSaver::Ptr valueSaver)
inlineprotected

Constructor for derived classes.

Non-subclass users should use instance instead.

Definition at line 1089 of file util/Sawyer/CommandLine.h.

Member Function Documentation

template<typename T >
static Ptr Sawyer::CommandLine::RealNumberParser< T >::instance ( )
inlinestatic

Allocating constructor.

Returns a pointer to a new RealNumberParser object. Uses will most likely want to use the realNumberParser factory instead, which requires less typing.

See also
Command line parser factories

Definition at line 1097 of file util/Sawyer/CommandLine.h.

Referenced by Sawyer::CommandLine::realNumberParser().

template<typename T >
static Ptr Sawyer::CommandLine::RealNumberParser< T >::instance ( const ValueSaver::Ptr valueSaver)
inlinestatic

Allocating constructor.

Returns a pointer to a new RealNumberParser object. Uses will most likely want to use the realNumberParser factory instead, which takes the same arguments, but requires less typing.

See also
Command line parser factories

Definition at line 1102 of file util/Sawyer/CommandLine.h.

References Sawyer::CommandLine::RealNumberParser< T >::RealNumberParser().


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