Public Member Functions

vislab::yarp::util::Option::Type Class Reference

The basic type an Option may be of. More...

#include <Option.h>

Inheritance diagram for vislab::yarp::util::Option::Type:
vislab::yarp::util::Option::Boolean vislab::yarp::util::Option::List vislab::yarp::util::Option::Number vislab::yarp::util::Option::Vector vislab::yarp::util::Option::OnOff

Public Member Functions

 Type ()
 The default constructor.
virtual ~Type ()
 The destructor.
virtual bool validate (const ::yarp::os::Value &v, std::ostream *const output=NULL) const
 Validates the given ::yarp::os::Value.
virtual ::yarp::os::ConstString toString () const
 Returns a human readable string that describes this object.

Detailed Description

The basic type an Option may be of.

This type accepts any value and is supposed to be extended to create more complex types.

Author:
Christian Wressnegger
Date:
2009

Definition at line 50 of file Option.h.


Member Function Documentation

virtual ::yarp::os::ConstString vislab::yarp::util::Option::Type::toString (  )  const [inline]

Returns a human readable string that describes this object.

Returns:
A human readable string that describes this object.

Reimplemented in vislab::yarp::util::Option::List, vislab::yarp::util::Option::Boolean, vislab::yarp::util::Option::Number, and vislab::yarp::util::Option::Vector.

Definition at line 78 of file Option.h.

Referenced by vislab::yarp::util::Option::toString().

                                                           {
                        return "<any value>";
                }

virtual bool vislab::yarp::util::Option::Type::validate ( const ::yarp::os::Value &  v,
std::ostream *const   output = NULL 
) const [inline, virtual]

Validates the given ::yarp::os::Value.

Parameters:
v The ::yarp::os::Value to be validated.
output The stream to write possible error message to.
Returns:
An indicator wheter the given ::yarp::os::Value is valid or not.

Reimplemented in vislab::yarp::util::Option::List, vislab::yarp::util::Option::Boolean, vislab::yarp::util::Option::Number, and vislab::yarp::util::Option::Vector.

Definition at line 70 of file Option.h.

                                                                                                   {
                        return true;
                }


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Friends Defines