The CommandOptions class serves as a data struct to inform Command objects about all modifiers that can be applied to them. More...

#include <command.h>

Public Attributes
bool	addsRespToGrps

std::string	opt

bool	optHasParams

std::string	optName

bool	optReturnsParams

std::vector< std::pair< std::string, std::string > >	params

std::string	response

Detailed Description

The CommandOptions class serves as a data struct to inform Command objects about all modifiers that can be applied to them.

A list of instance of this struct is required to instantiate a Command object, this list may also be empty.

Definition at line 55 of file command.h.

Member Data Documentation

bool CommandOptions::addsRespToGrps

Does this option modify the response on a "set group" command? NOTE: At the moment this option is unused, hence untested, use with caution!

Definition at line 69 of file command.h.

std::string CommandOptions::opt

Option itself, containing keywords and parameters flagged with '$'

Definition at line 62 of file command.h.

bool CommandOptions::optHasParams

Does this CommandOption have dynamic parameters?

Definition at line 58 of file command.h.

std::string CommandOptions::optName

Unique identifier of a CommandOptions struct.

Definition at line 57 of file command.h.

bool CommandOptions::optReturnsParams

Does the response have dynamic parameters?

Definition at line 64 of file command.h.

std::vector<std::pair<std::string, std::string> > CommandOptions::params

List of dynamic parameters of this option/response (first: name, second: type)

Definition at line 60 of file command.h.

std::string CommandOptions::response

Response itself, containing keywords and parameters flagged with '$'. NOTE: At the moment there may only be one returned parameter per option!

Definition at line 66 of file command.h.

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