concepts::InputSlot Class Reference

Helps for reading input parameters for single problem with slot. More...

#include <slot.hh>

Inheritance diagram for concepts::InputSlot:

Collaboration diagram for concepts::InputSlot:

List of all members.

Public Member Functions
virtual std::ostream &	arguments (std::ostream &os) const
	Returns argument list as string.
virtual std::ostream &	description (std::ostream &os) const
	Returns description for help.
virtual int	input (int opt, const char *optarg)
	Process an argument and sets input parameter, if found.
	InputSlot (InOutParameters &input)
	Constructor.
virtual std::ostream &	letters (std::ostream &os) const
	Return letters for the arguments.
const InOutParameters	parameters () const
	Returns input parameters.
InOutParameters &	parameters ()
const unsigned long long	slotWidthReciprocal () const
	Returns that value, where the reciprocal of 2 to the power of it is the slotwith.
Protected Member Functions
virtual std::ostream &	info (std::ostream &os) const
	Returns information in an output stream.
Protected Attributes
InOutParameters &	input_
	Input parameter.
Private Attributes
unsigned long long	slot_
	Reciprocal of slot width.

---

Detailed Description

Helps for reading input parameters for single problem with slot.

Author:

Kersten Schmidt, 2005

Definition at line 14 of file slot.hh.

---

Constructor & Destructor Documentation

concepts::InputSlot::InputSlot

(

InOutParameters &

input

)

Constructor.

Definition at line 43 of file slot.hh.

---

Member Function Documentation

std::ostream & concepts::InputSlot::arguments

(

std::ostream &

os

)

const [virtual]

Returns argument list as string.

Implements concepts::InputParameter.

Definition at line 51 of file slot.hh.

std::ostream & concepts::InputSlot::description

(

std::ostream &

os

)

const [virtual]

Returns description for help.

Implements concepts::InputParameter.

Definition at line 55 of file slot.hh.

std::ostream & concepts::InputSlot::info

(

std::ostream &

os

)

const [protected, virtual]

Returns information in an output stream.

Reimplemented from concepts::InputParameter.

Definition at line 82 of file slot.hh.

Here is the call graph for this function:

int concepts::InputSlot::input	(	int	opt,
		const char *	optarg
	)		[virtual]

Process an argument and sets input parameter, if found.

Returns:

0 ok, 1 not appropiate argument, 2 error

Implements concepts::InputParameter.

Definition at line 62 of file slot.hh.

Here is the call graph for this function:

std::ostream & concepts::InputSlot::letters

(

std::ostream &

os

)

const [virtual]

Return letters for the arguments.

If parameters are needed ':' is appended for this letter.

Implements concepts::InputParameter.

Definition at line 47 of file slot.hh.

InOutParameters& concepts::InputParameter::parameters

(

)

[inline, inherited]

Definition at line 43 of file inputParam.hh.

const InOutParameters concepts::InputParameter::parameters

(

)

const [inline, inherited]

Returns input parameters.

Definition at line 42 of file inputParam.hh.

const unsigned long long concepts::InputSlot::slotWidthReciprocal

(

)

const [inline]

Returns that value, where the reciprocal of 2 to the power of it is the slotwith.

Definition at line 34 of file slot.hh.

---

Member Data Documentation

InOutParameters& concepts::InputParameter::input_ [protected, inherited]

Input parameter.

Definition at line 47 of file inputParam.hh.

unsigned long long concepts::InputSlot::slot_ [private]

Reciprocal of slot width.

Definition at line 39 of file slot.hh.

---

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

• app-kersten/slot.hh