• Overview
  • Examples
  • HowTos
  • Glossary
    • Public Member Functions | Protected Member Functions | List of all members
    senf::console::ParsedCommandAttributor< Overload > Class Template Reference

    Non argument dependent ParsedCommandBase attributes. More...

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

    Inheritance diagram for senf::console::ParsedCommandAttributor< Overload >:
    Inheritance graph
    [legend]

    Public Member Functions

    Overload & overload () const
     Get the command overload. More...
     

    Protected Member Functions

     ParsedCommandAttributor (typename Overload::ptr overload, unsigned index)
     
     ParsedCommandAttributor (ParsedCommandAttributorBase const &other, unsigned index)
     
    - Protected Member Functions inherited from senf::console::ParsedCommandAttributorBase
     ParsedCommandAttributorBase (ParsedCommandOverloadBase::ptr overload, unsigned index)
     
     ParsedCommandAttributorBase (ParsedCommandAttributorBase const &other, unsigned index)
     
    void argName (std::string const &name)
     
    void argDoc (std::string const &doc)
     
    void typeName (std::string const &doc)
     
    void defaultDoc (std::string const &doc)
     
    ParsedCommandOverloadBase & overload () const
     
    void overloadDoc (std::string const &doc)
     
    void nodeDoc (std::string const &doc)
     
    void shortDoc (std::string const &doc)
     

    Additional Inherited Members

    - Public Types inherited from senf::console::ParsedCommandAttributorBase
    typedef OverloadedCommandNode node_type
     
    typedef OverloadedCommandNode & result_type
     

    Detailed Description

    template<class Overload>
    class senf::console::ParsedCommandAttributor< Overload >

    Non argument dependent ParsedCommandBase attributes.

    Attributes for parsed commands are not set directly on the node. They are set via a special attributor temporary returned when adding a parsed command to the tree.

    This class adds all those members, which do depend on the type of command added (and thereby on that commands signature) but do not depend on the type of any single argument.

    See also
    Automatic argument parsing

    Definition at line 235 of file ParsedCommand.hh.

    Constructor & Destructor Documentation

    ◆ ParsedCommandAttributor() [1/2]

    template<class Overload >
    senf::console::ParsedCommandAttributor< Overload >::ParsedCommandAttributor ( typename Overload::ptr  overload,
    unsigned  index 
    )
    		protected

    ◆ ParsedCommandAttributor() [2/2]

    template<class Overload >
    senf::console::ParsedCommandAttributor< Overload >::ParsedCommandAttributor ( ParsedCommandAttributorBase const &  other,
    unsigned  index 
    )
    		protected

    Member Function Documentation

    ◆ overload()

    template<class Overload >
    Overload& senf::console::ParsedCommandAttributor< Overload >::overload ( ) const

    Get the command overload.

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