Mantid::Kernel::Direction Struct Reference

Describes the direction (within an algorithm) of a Property. More...

#include <Property.h>

Public Types
enum	Type { Input , Output , InOut , None }
	Enum giving the possible directions. More...

Static Public Member Functions
static int	asEnum (const std::string &direction)
	Returns an enum representation of the input Direction string. More...
static const std::string	asText (const unsigned int &direction)
	Returns a text representation of the input Direction enum. More...

Detailed Description

Describes the direction (within an algorithm) of a Property.

Used by WorkspaceProperty.

Definition at line 50 of file Property.h.

Member Enumeration Documentation

Type

enum Mantid::Kernel::Direction::Type

Enum giving the possible directions.

Enumerator
Input	An input workspace.
Output	An output workspace.
InOut	Both an input & output workspace.
None

Definition at line 52 of file Property.h.

Member Function Documentation

asEnum()

static int Mantid::Kernel::Direction::asEnum ( const std::string &  direction )

inlinestatic

Returns an enum representation of the input Direction string.

Definition at line 74 of file Property.h.

References InOut, Input, None, and Output.

Referenced by Mantid::API::WorkspaceHistory::parseAlgorithmHistory().

asText()

static const std::string Mantid::Kernel::Direction::asText ( const unsigned int &  direction )

inlinestatic

Returns a text representation of the input Direction enum.

Definition at line 60 of file Property.h.

References InOut, Input, and Output.

Referenced by Mantid::Kernel::PropertyHistory::printSelf().

---

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

• Framework/Kernel/inc/MantidKernel/Property.h