senf::console::ScopedDirectoryBase Class Reference

Internal: Marker base class for all ScopedDirectory proxies. More...

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

Inheritance diagram for senf::console::ScopedDirectoryBase:

Public Member Functions

DirectoryNodenode () const
 Access the proxied DirectoryNode. More...
 
 operator DirectoryNode & () const
 Access the proxied DirectoryNode. More...
 

Protected Member Functions

 ScopedDirectoryBase ()
 
 ~ScopedDirectoryBase ()
 

Proxied members (see DirectoryNode)

GenericNode::ptr remove (std::string const &name)
 
bool hasChild (std::string const &name) const
 
DirectoryNodegetDirectory (std::string const &name) const
 
DirectoryNodeoperator[] (std::string const &name) const
 
CommandNodegetCommand (std::string const &name) const
 
CommandNodeoperator() (std::string const &name) const
 
GenericNodeget (std::string const &name) const
 
DirectoryNode::ChildrenRange children () const
 
DirectoryNodedoc (std::string const &doc)
 
std::string const & name () const
 
bool active () const
 
std::string path () const
 
std::string path (DirectoryNode const &root) const
 
boost::shared_ptr< DirectoryNodeparent () const
 
GenericNode::ptr unlink ()
 
void help (std::ostream &output) const
 
std::string shorthelp () const
 

Detailed Description

Internal: Marker base class for all ScopedDirectory proxies.

Definition at line 36 of file ScopedDirectory.hh.

Constructor & Destructor Documentation

◆ ScopedDirectoryBase()

senf::console::ScopedDirectoryBase::ScopedDirectoryBase ( )
protected

◆ ~ScopedDirectoryBase()

senf::console::ScopedDirectoryBase::~ScopedDirectoryBase ( )
protected

Member Function Documentation

◆ active()

bool senf::console::ScopedDirectoryBase::active ( ) const

◆ children()

DirectoryNode::ChildrenRange senf::console::ScopedDirectoryBase::children ( ) const

◆ doc()

DirectoryNode& senf::console::ScopedDirectoryBase::doc ( std::string const &  doc)

◆ get()

GenericNode& senf::console::ScopedDirectoryBase::get ( std::string const &  name) const

◆ getCommand()

CommandNode& senf::console::ScopedDirectoryBase::getCommand ( std::string const &  name) const

◆ getDirectory()

DirectoryNode& senf::console::ScopedDirectoryBase::getDirectory ( std::string const &  name) const

◆ hasChild()

bool senf::console::ScopedDirectoryBase::hasChild ( std::string const &  name) const

◆ help()

void senf::console::ScopedDirectoryBase::help ( std::ostream &  output) const

◆ name()

std::string const& senf::console::ScopedDirectoryBase::name ( ) const

◆ node()

DirectoryNode& senf::console::ScopedDirectoryBase::node ( ) const

Access the proxied DirectoryNode.

◆ operator DirectoryNode &()

senf::console::ScopedDirectoryBase::operator DirectoryNode & ( ) const

Access the proxied DirectoryNode.

◆ operator()()

CommandNode& senf::console::ScopedDirectoryBase::operator() ( std::string const &  name) const

◆ operator[]()

DirectoryNode& senf::console::ScopedDirectoryBase::operator[] ( std::string const &  name) const

◆ parent()

boost::shared_ptr<DirectoryNode> senf::console::ScopedDirectoryBase::parent ( ) const

◆ path() [1/2]

std::string senf::console::ScopedDirectoryBase::path ( ) const

◆ path() [2/2]

std::string senf::console::ScopedDirectoryBase::path ( DirectoryNode const &  root) const

◆ remove()

GenericNode::ptr senf::console::ScopedDirectoryBase::remove ( std::string const &  name)

◆ shorthelp()

std::string senf::console::ScopedDirectoryBase::shorthelp ( ) const

◆ unlink()

GenericNode::ptr senf::console::ScopedDirectoryBase::unlink ( )

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