EAbstractAnalytic::Input Class Reference

#include <eabstractanalytic_input.h>

Inheritance diagram for EAbstractAnalytic::Input:

Public Types
enum	Type {   Boolean, Integer, Double, String,   Selection, FileIn, FileOut, DataIn,   DataOut }
enum	Role {   CommandLineName, Title, WhatsThis, Default,   Minimum, Maximum, Decimals, SelectionValues,   FileFilters, DataType }

Public Member Functions
virtual int	size () const =0
virtual EAbstractAnalytic::Input::Type	type (int index) const =0
virtual QVariant	data (int index, Role role) const =0
virtual void	set (int index, const QVariant &value)=0
virtual void	set (int index, QFile *file)=0
virtual void	set (int index, EAbstractData *data)=0
	Input (EAbstractAnalytic *parent)

Detailed Description

This represents the input class that handles taking in all user input for its parent analytic. An implementation of this class must define all inputs for its analytic type and then handle setting all values for that input to its parent analytic. For file and data object inputs/outputs the ACE system handles closing them on its own so an implementation of this class does not need to worry about that; for those types only a pointer is passed and not actual ownership of the underlying objects.

Member Enumeration Documentation

Role

enum EAbstractAnalytic::Input::Role

Defines all possible data roles an argument can possess.

Enumerator
CommandLineName	Defines the command line name for an argument. This data is a string and unique within all other arguments for an analytic type. Defines the title for an argument. This data is a string that is displayed in the analytic GUI as an argument's title.
Title	Defines the "What's this?" for an argument. This data is a string that is used to describe what this argument is to the end user.
WhatsThis	Defines the default value for an argument. This data is a variant type depending on the argument type.
Default	Defines the minimum value for a number argument. This data is an integer or real number.
Minimum	Defines the maximum value for a number argument. This data is an integer or real number.
Maximum	Defines the decimal precision used for a real number argument. This data is an integer.
Decimals	Defines the list of possible values for a selection argument. This data is a list of strings containing all possible values for a selection.
SelectionValues	Defines the file filters used for a file input/output argument. This data is a string that defines file filters as defined by Qt.
FileFilters	Defines the data type for a data input/output argument. This data is an integer that identifies a unique data type.

Type

enum EAbstractAnalytic::Input::Type

Defines all possible argument types that can be used as input for an analytic.

Enumerator
Boolean	Defines the boolean argument type. Defines the integer argument type.
Integer	Defines the real number argument type. Double precision is always used.
Double	Defines the string argument type.
String	Defines the selection argument type. A selection is a list of predefined strings where only one can be chosen.
Selection	Defines a raw input file argument type. A qt file device is used.
FileIn	Defines a raw output file argument type. A qt file device is used.
FileOut	Defines an input data object argument type.
DataIn	Defines an output data object argument type.

Constructor & Destructor Documentation

Input()

EAbstractAnalytic::Input::Input ( EAbstractAnalytic *  parent )

explicit

Constructs a new input object with the given analytic as its parent.

Parameters

parent

The parent analytic object for this new input object.

Member Function Documentation

data()

virtual QVariant EAbstractAnalytic::Input::data ( int  index, Role  role  ) const

pure virtual

This interface returns data for a given role on an argument with the given index.

Parameters

index	Index of argument whose data with the given role is returned.
role	Role for the data that is returned.

Returns

Variant data for the given role and index.

set() [1/3]

virtual void EAbstractAnalytic::Input::set ( int  index, const QVariant &  value  )

pure virtual

This interface sets an argument with the given index to the given value.

Parameters

index	Index of argument whose value is set to the given value.
value	Variant value which is set to the argument with the given index.

set() [2/3]

virtual void EAbstractAnalytic::Input::set ( int  index, QFile *  file  )

pure virtual

This interface passes a pointer to the qt file device for a file input/output argument with the given index.

Parameters

index	Index of argument whose qt file device pointer is given.
file	Pointer to qt file device for the argument with the given index.

set() [3/3]

virtual void EAbstractAnalytic::Input::set ( int  index, EAbstractData *  data  )

pure virtual

This interface passes a pointer to the abstract data object for a data input/output argument with the given index.

Parameters

index	Index of argument whose abstract data object pointer is given.
data	Pointer to abstract data object for the argument with the given index.

size()

virtual int EAbstractAnalytic::Input::size ( ) const

pure virtual

This interface returns the total number of arguments this analytic type contains.

Returns

Total number of arguments for this analytic type.

type()

virtual EAbstractAnalytic::Input::Type EAbstractAnalytic::Input::type ( int  index ) const

pure virtual

This interface returns the argument type for a given index.

Parameters

index

Index of argument whose type is returned.

Returns

Argument type for the given index.

---

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

• eabstractanalytic_input.h
• eabstractanalytic_input.cpp