senf::console::SimpleCommandNode Class Reference
[Supported command types]

Most simple CommandNode implementation. More...

#include <senf/Utils/Console/Node.hh>

Inheritance diagram for senf::console::SimpleCommandNode:
Inheritance graph
[legend]

List of all members.

Detailed Description

Most simple CommandNode implementation.

This CommandNode implementation simply forwards the output and arguments arguments to an arbitrary callback. Thus, it allows to add callbacks with the signature

void callback(std::ostream & os, senf::console::ParseCommandInfo const & command)
{ ... }
to the tree.

Definition at line 629 of file Node.hh.


Public Types
typedef boost::shared_ptr
< SimpleCommandNode > 		 ptr
typedef boost::shared_ptr
< SimpleCommandNode const > 		 cptr
typedef boost::weak_ptr
< SimpleCommandNode > 		 weak_ptr
typedef boost::function< void(std::ostream
&, ParseCommandInfo const &)> 		 Function
typedef SimpleCommandNode  node_type
typedef SimpleCommandNode &  return_type

Public Member Functions
ptr  thisptr ()
  Get smart pointer to node.
cptr  thisptr () const
  Get smart pointer to node (const).
SimpleCommandNode &  doc (std::string const &doc)
SimpleCommandNode &  shortdoc (std::string const &doc)

Structors and default members
static ptr  create (Function const &fn)

Protected Member Functions
  SimpleCommandNode (Function const &fn)

Member Typedef Documentation

typedef boost::shared_ptr<SimpleCommandNode const> senf::console::SimpleCommandNode::
cptr

Reimplemented from senf::console::CommandNode.

Definition at line 637 of file Node.hh.

typedef boost::function<void (std::ostream &, ParseCommandInfo const &)> senf::console::SimpleCommandNode::
Function

Definition at line 640 of file Node.hh.

typedef SimpleCommandNode senf::console::SimpleCommandNode::
node_type

Definition at line 642 of file Node.hh.

typedef boost::shared_ptr<SimpleCommandNode> senf::console::SimpleCommandNode::
ptr

Reimplemented from senf::console::CommandNode.

Definition at line 631 of file Node.hh.

typedef SimpleCommandNode& senf::console::SimpleCommandNode::
return_type

Definition at line 643 of file Node.hh.

typedef boost::weak_ptr<SimpleCommandNode> senf::console::SimpleCommandNode::
weak_ptr

Reimplemented from senf::console::CommandNode.

Definition at line 638 of file Node.hh.

Constructor & Destructor Documentation

senf::console::SimpleCommandNode::
SimpleCommandNode ( Function const &  fn )

Definition at line 318 of file Node.cci.

Member Function Documentation

senf::console::SimpleCommandNode::ptr senf::console::SimpleCommandNode::
create ( Function const &  fn )

Definition at line 323 of file Node.cci.

senf::console::SimpleCommandNode & senf::console::SimpleCommandNode::
doc ( std::string const &  doc )

Definition at line 329 of file Node.cci.

senf::console::SimpleCommandNode & senf::console::SimpleCommandNode::
shortdoc ( std::string const &  doc )

Definition at line 336 of file Node.cci.

senf::console::SimpleCommandNode::cptr senf::console::SimpleCommandNode::
thisptr ()

Get smart pointer to node (const).

Reimplemented from senf::console::CommandNode.

Definition at line 347 of file Node.cci.

senf::console::SimpleCommandNode::ptr senf::console::SimpleCommandNode::
thisptr ()

Get smart pointer to node.

Reimplemented from senf::console::CommandNode.

Definition at line 342 of file Node.cci.

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