Command

#include <Module.hpp>

Public Member Functions
virtual	~Command ()=default
virtual const std::vector< std::string > &	respond_to () const =0
virtual int	call_command (int argc, const char *argv[]) const =0
virtual const std::string *	brief_summary () const
virtual const std::string *	group () const

Detailed Description

Superclass of commands to be added to oc

Definition at line 65 of file Module.hpp.

Constructor & Destructor Documentation

~Command()

virtual ~Command ( )

virtualdefault

Standard, empty virtual destructor

Member Function Documentation

brief_summary()

virtual const std::string* brief_summary ( ) const

inlinevirtual

Optional brief text summary, for documentation/help commands

Definition at line 74 of file Module.hpp.

call_command()

virtual int call_command ( int  argc, const char *  argv[]  ) const

pure virtual

The function called when the command is run

group()

virtual const std::string* group ( ) const

inlinevirtual

Optional command group, for documentation/help commands

Definition at line 76 of file Module.hpp.

respond_to()

virtual const std::vector<std::string>& respond_to ( ) const

pure virtual

The name of the command, with optional aliases

---

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

• /gfs-oceanweb/web/ocssw/ocssw_src/include/focs/Module.hpp