ngcb_cmd_t Class Reference

#include <ngcbCMD.hpp>

Public Member Functions
bool	operator< (const ngcb_cmd_t &other) const
	Comparison operator.
	ngcb_cmd_t (const char *name)
	Constructor.
virtual	~ngcb_cmd_t ()
	Destructor.
const char *	Cmd () const
	Return command name.
void	Syntax (const char *s)
	Assign syntax.
void	Help (const char *s)
	Assign help text.

Static Public Member Functions
static bool	Compare (const ngcb_cmd_t *a, const ngcb_cmd_t *b)
	Comparison function.

Public Attributes
ngcb_function_t	function
	Command handling function.
char	syntax [256]
	Syntax string (for help)
char	help [1024]
	Help text.
int	flags
	Flags (ngcbCMD_UPDATE, ngcbCMD_PROTECTED)
void *	udata
	User data to be forwarded.

Detailed Description

Command handler class

Constructor & Destructor Documentation

ngcb_cmd_t()

ngcb_cmd_t::ngcb_cmd_t ( const char * name )

inlineexplicit

Constructor.

~ngcb_cmd_t()

virtual ngcb_cmd_t::~ngcb_cmd_t ( )

inlinevirtual

Destructor.

Member Function Documentation

Cmd()

const char * ngcb_cmd_t::Cmd ( ) const

inline

Return command name.

Compare()

static bool ngcb_cmd_t::Compare ( const ngcb_cmd_t * a, const ngcb_cmd_t * b )

inlinestatic

Comparison function.

Help()

void ngcb_cmd_t::Help ( const char * s )

inline

Assign help text.

operator<()

bool ngcb_cmd_t::operator< ( const ngcb_cmd_t & other ) const

inline

Comparison operator.

Syntax()

void ngcb_cmd_t::Syntax ( const char * s )

inline

Assign syntax.

Member Data Documentation

flags

int ngcb_cmd_t::flags

Flags (ngcbCMD_UPDATE, ngcbCMD_PROTECTED)

function

ngcb_function_t ngcb_cmd_t::function

Command handling function.

help

char ngcb_cmd_t::help[1024]

Help text.

syntax

char ngcb_cmd_t::syntax[256]

Syntax string (for help)

udata

void* ngcb_cmd_t::udata

User data to be forwarded.

---

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

• core/ngcbCORE/src/include/ngc/core/ngcbCMD.hpp