task::IntTask Class Reference

A simple Task that sets an Int variable. More...

#include <int-task.hh>

Inheritance diagram for task::IntTask:

Collaboration diagram for task::IntTask:

Public Types
typedef TaskRegister::tasks_list_type	tasks_list_type
typedef std::list< std::string >	deps_type

Public Member Functions
	IntTask (int &var, int min, int max, const char *module_name, const char *desc, const char *name, std::string deps)
virtual bool	check () const override
	Check that the preconditions are verified.
virtual void	execute () const override
	Execute this task.
virtual deps_type	resolve_dependencies (tasks_list_type &active_tasks) const
void	print_dependencies () const
	Display dependencies of this task .
Accessors.
const char *	name_get () const
const char *	module_name_get () const
	Access to 'module_name'.
int	key_get () const
	Access to 'key'.
const char *	desc_get () const
	Access to 'desc'.
const char *	argname_get () const
	The argument name.
void	argname_set (const char *)
void	arg_set (const char *arg) const
	The argument.
const char *	arg_get () const
const deps_type &	dependencies_get () const
	Access to tasks dependencies.

Static Public Member Functions
static std::string	normalize (const std::string &task_name)
	Normalize the name of a task.

Protected Attributes
std::string	name_
	Task name.
const char *	module_name_
	Module name to which the task belongs.
int	key_
	The integer key provided by the this task to the option parser.
const char *	desc_
	A short description of this task (displayed in program usage).
const char *	argname_
	The name of the argument to display in the –help message.
const char *	arg_
	The actual argument value.
deps_type	dependencies_
	Contains the name of the tasks on which this one depends.

Private Attributes
int &	var_
int	min_
int	max_

Detailed Description

A simple Task that sets an Int variable.

Member Typedef Documentation

typedef std::list<std::string> task::Task::deps_type

inherited

typedef TaskRegister::tasks_list_type task::Task::tasks_list_type

inherited

Constructor & Destructor Documentation

task::IntTask::IntTask	(	int &	var,
		int	min,
		int	max,
		const char *	module_name,
		const char *	desc,
		const char *	name,
		std::string	deps
	)

References task::Task::argname_set().

Member Function Documentation

const char * task::Task::arg_get ( ) const

inlineinherited

References task::Task::arg_.

Referenced by check(), task::StringTask::check(), and task::MultipleStringTask::check().

void task::Task::arg_set ( const char *  arg ) const

inlineinherited

The argument.

References task::Task::arg_.

Referenced by task::TaskRegister::enable_task().

const char * task::Task::argname_get ( ) const

inlineinherited

The argument name.

References task::Task::argname_.

void task::Task::argname_set ( const char *  argname )

inlineinherited

References task::Task::argname_.

Referenced by IntTask(), task::MultipleStringTask::MultipleStringTask(), and task::StringTask::StringTask().

bool task::IntTask::check ( ) const

overridevirtual

Check that the preconditions are verified.

Implements task::Task.

References task::Task::arg_get(), max_, min_, program_name, and var_.

const Task::deps_type & task::Task::dependencies_get ( ) const

inlineinherited

Access to tasks dependencies.

References task::Task::dependencies_.

Referenced by task::TaskRegister::print_task_graph(), and task::TaskRegister::resolve_dependencies().

const char * task::Task::desc_get ( ) const

inlineinherited

Access to 'desc'.

References task::Task::desc_.

void task::IntTask::execute ( ) const

overridevirtual

Execute this task.

Implements task::Task.

int task::Task::key_get ( ) const

inlineinherited

Access to 'key'.

References task::Task::key_.

Referenced by task::TaskRegister::register_task().

const char * task::Task::module_name_get ( ) const

inlineinherited

Access to 'module_name'.

References task::Task::module_name_.

const char * task::Task::name_get ( ) const

inlineinherited

Access to 'name'.

'const char*' is preferred to 'std::string' because TaskRegister calls C functions, that expect 'const char*'. The use of 'std::string::c_str()' is so forbidden and a call to 'strdup(std::string::c_str())' would implies dummy memory leaks.

References task::Task::name_.

Referenced by task::TaskRegister::print_task_graph(), task::TaskRegister::register_task(), and task::TaskRegister::resolve_dependencies().

std::string task::Task::normalize ( const std::string &  task_name )

staticinherited

Normalize the name of a task.

Referenced by task::Task::Task().

void task::Task::print_dependencies ( ) const

inherited

Display dependencies of this task .

Display dependencies of this task.

References task::Task::dependencies_, and task::Task::name_.

Task::deps_type task::Task::resolve_dependencies ( tasks_list_type &  active_tasks ) const

virtualinherited

Reimplemented in task::DisjunctiveTask.

References task::Task::dependencies_.

Referenced by task::TaskRegister::resolve_dependencies().

Member Data Documentation

const char* task::Task::arg_

mutableprotectedinherited

The actual argument value.

Referenced by task::Task::arg_get(), and task::Task::arg_set().

const char* task::Task::argname_

protectedinherited

The name of the argument to display in the –help message.

Referenced by task::Task::argname_get(), and task::Task::argname_set().

deps_type task::Task::dependencies_

protectedinherited

Contains the name of the tasks on which this one depends.

Referenced by task::Task::dependencies_get(), task::Task::print_dependencies(), task::DisjunctiveTask::resolve_dependencies(), task::Task::resolve_dependencies(), and task::Task::Task().

const char* task::Task::desc_

protectedinherited

A short description of this task (displayed in program usage).

Referenced by task::Task::desc_get().

int task::Task::key_

protectedinherited

The integer key provided by the this task to the option parser.

From 'argp ()': "If key has a value that is a printable ASCII character (i.e., isascii (key) is true), it also specifies a short option '-char' where char is the ASCII character with the code key"

Referenced by task::Task::key_get(), and task::Task::Task().

int task::IntTask::max_

private

Referenced by check().

int task::IntTask::min_

private

Referenced by check().

const char* task::Task::module_name_

protectedinherited

Module name to which the task belongs.

Referenced by task::Task::module_name_get().

std::string task::Task::name_

protectedinherited

Task name.

Referenced by task::Task::name_get(), task::Task::print_dependencies(), and task::Task::Task().

int& task::IntTask::var_

private

Referenced by check().

---

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

• task/int-task.hh
• task/int-task.cc