JPARSER::JOption< T > Class Template Reference

Auxiliary class to handle optional I/O. More...

#include <JParser.hh>

Public Member Functions
	JOption ()
	Default constructor. More...
	JOption (const T &value)
	Constructor. More...
bool	getStatus () const
	Get status. More...
	operator const T & () const
	Type conversion operator. More...
const JOption< T > &	operator= (const T &value)
	Assignment to a value. More...
T *	clone () const
	Get clone of this object. More...

Protected Attributes
bool	__status
T	__value

Friends
std::istream &	operator>> (std::istream &in, JOption &object)
	Read option from input. More...
std::ostream &	operator<< (std::ostream &out, const JOption &object)
	Write options to output. More...

Detailed Description

template<class T>
class JPARSER::JOption< T >

Auxiliary class to handle optional I/O.

Definition at line 123 of file JParser.hh.

Constructor & Destructor Documentation

template<class T >

JPARSER::JOption< T >::JOption ( )

inline

Default constructor.

Definition at line 128 of file JParser.hh.

              :
      __status(false),
      __value()
    {}

template<class T >

JPARSER::JOption< T >::JOption ( const T &  value )

inline

Constructor.

Definition at line 137 of file JParser.hh.

                            :
      __status(false),
      __value(value)
    {}

Member Function Documentation

template<class T >

bool JPARSER::JOption< T >::getStatus ( ) const

inline

Get status.

Returns

status

Definition at line 148 of file JParser.hh.

    {
      return __status;
    }

template<class T >

JPARSER::JOption< T >::operator const T & ( ) const

inline

Type conversion operator.

Returns

object

Definition at line 159 of file JParser.hh.

    {
      return __value;
    }

template<class T >

const JOption<T>& JPARSER::JOption< T >::operator= ( const T &  value )

inline

Assignment to a value.

Parameters

value

value

Returns

this object

Definition at line 171 of file JParser.hh.

    {
      __status = true;
      __value  = value;
        
      return *this;
    }

template<class T >

T* JPARSER::JOption< T >::clone ( ) const

inline

Get clone of this object.

Returns

pointer to newly created object if status is okay; else NULL

Definition at line 185 of file JParser.hh.

    {
      if (__status)
        return new T(__value);
      else
        return NULL;
    }

Friends And Related Function Documentation

template<class T >

std::istream& operator>> ( std::istream &  in, JOption< T > &  object  )

friend

Read option from input.

Parameters

in	input stream
object	option

Returns

input stream

Definition at line 201 of file JParser.hh.

    {
      object.__status = true;

      if (!(in >> object.__value)) {
        in.clear();
      }

      return in;
    }

template<class T >

std::ostream& operator<< ( std::ostream &  out, const JOption< T > &  object  )

friend

Write options to output.

Parameters

out	output stream
object	option

Returns

output stream

Definition at line 220 of file JParser.hh.

    {
      if (object.__status) {
        out << object.__value;
      }

      return out;
    }

Member Data Documentation

template<class T >

bool JPARSER::JOption< T >::__status

protected

Definition at line 230 of file JParser.hh.

template<class T >

T JPARSER::JOption< T >::__value

protected

Definition at line 231 of file JParser.hh.

---

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

• JParser.hh