Optika GUI Toolik Version of the Day
Classes | Functions | Variables
Optika Namespace Reference

Classes

class  GenericArrayWidget
 An Abstract base class for both 2D and 1D ArrayWidgets. More...
class  Generic2DArrayWidget
 An abstract base class for all 2D Array Widets. More...
class  Int2DArrayWidget
 A 2DArrayWidget used for editing arrays whose template type is int. More...
class  Short2DArrayWidget
 A 2DArrayWidget used for editing arrays whose template type is short. More...
class  Double2DArrayWidget
 A 2DArrayWidget used for editing arrays whose template type is double. More...
class  Float2DArrayWidget
 A 2DArrayWidget used for editing arrays whose template type is float. More...
class  String2DArrayWidget
 A 2DArrayWidget used for editing arrays whose template type is std::string. More...
class  Generic1DArrayWidget
 A templated abstract base class for all 1D array editing widgets. More...
class  IntArrayWidget
 A 1D widget for editing Arrays of type int. More...
class  ShortArrayWidget
 A widget for editing Arrays of type short. More...
class  DoubleArrayWidget
 A widget for editing Arrays of type double. More...
class  FloatArrayWidget
 A widget for editing Arrays of type short. More...
class  StringArrayWidget
 A widget for editing an array of strings. More...
class  Delegate
 The delegate used for the Optika package. For non-documented functions please refer to the Qt API. More...
class  FileNameWidget
 A small widget consisting of a button and label that allows the user to select a file through a QFileDialog. The label displays the currently selected file. More...
class  OptikaGUI
 A class that allows the user to create and customize their Optika GUI. More...
class  SearchWidget
 A small widget that searchs through a parameter list for a particular name of either a parameter or another parameter list. More...
class  MetaWindow
 The Main Window that contains all other widgets in the Optika GUI. For all undocumented functions please refer to the Qt API. More...
class  TreeItem
 The TreeItem class is the item class used by the TreeModel class. More...
class  TreeModel
 TreeModel is a type of QAbstractItemModel that has a Tree like structure. More...
class  TreeView
 Class used to view TreeModels. More...
class  ValidatorApplier
 A templated class that applies the minimum, maximum and step specified in an EnhancedNumberValidator onto a QSpingBox. More...
class  ValidatorApplier< double >
 A template spcialization of the ValidatorApplier class on the type double. More...
class  ValidatorApplier< float >
 A template specialzation of the ValidatorApplier class on the type float. More...
class  ModalClicker
class  OptikaGUITests

Functions

QString determineArrayType (RCP< const ParameterEntry > parameter, bool twoD=false)
 Determines the type of array stored in a parameter.
QString determineArrayType (RCP< const ParameterEntry > parameter)
QVariant arrayEntryToVariant (RCP< const ParameterEntry > arrayEntry, QString type, bool twoD=false)
 Creates a QVariant containing the array that is in arrayEntry.
QString getArrayType (QString itemType)
 Given a type string, determines the template type of the Array.
bool isArrayEmpty (RCP< const ParameterEntry > arrayEntry, QString type)
 Determines wether or no the array inside a ParameterEntry is empty.
std::string Optika_Version ()
 Return a string describing the version of Optika.
void RUN_BASIC_OPTIKA_TESTS ()
void RUN_OPTIKA_DATA_TYPE_TESTS ()
void RUN_OPTIKA_DEPENDENCY_AND_EXEC_TEST ()
template<class T >
void testingSpinBoxApply (const RCP< EnhancedNumberValidator< T > > validator, QAbstractSpinBox *spinner)
template<>
void testingSpinBoxApply (const RCP< EnhancedNumberValidator< double > > validator, QAbstractSpinBox *spinner)
template<>
void testingSpinBoxApply (const RCP< EnhancedNumberValidator< float > > validator, QAbstractSpinBox *spinner)
template<class T >
QAbstractSpinBox * createDefaultSpinner ()
template<>
QAbstractSpinBox * createDefaultSpinner< float > ()
template<>
QAbstractSpinBox * createDefaultSpinner< double > ()
template<class T >
void assertSpinnerDefaults (QAbstractSpinBox *spinBox)
template<>
void assertSpinnerDefaults< float > (QAbstractSpinBox *spinBox)
template<>
void assertSpinnerDefaults< double > (QAbstractSpinBox *spinBox)
template<class T >
void assertLineEditDetails (const QValidator *validator, QString &val20, QString &valneg1, int &pos)
template<>
void assertLineEditDetails< float > (const QValidator *validator, QString &val20, QString &valneg1, int &pos)
template<>
void assertLineEditDetails< double > (const QValidator *validator, QString &val20, QString &valneg1, int &pos)
template<class T >
void valApplyTestTemplate ()
 TEUCHOS_UNIT_TEST (Array_Helper_Functions, ArrayToQVariant)
 TEUCHOS_UNIT_TEST (Array_Helper_Functions, DetermineArrayType)
 TEUCHOS_UNIT_TEST (Array_Helper_Functions, GetArrayType)
 TEUCHOS_UNIT_TEST (Array_Helper_Functions, IsArrayEmpty)
 TEUCHOS_UNIT_TEST (TreeItem_Functions, ArrayTypes)

Variables

const int numRecentDocuments = 7
QString listId = QString("list")
 
QString intId = QString("int")
 
QString shortId = QString("short")
 
QString doubleId = QString("double")
 
QString floatId = QString("float")
 
QString boolId = QString("bool")
 
QString stringId = QString("string")
 
QString arrayId = QString("array")
 
QString unrecognizedId = QString("unrecognized")
 
QString twoDArrayId = QString("2DArray")
 

Basic Input Getting Function

void getInput (RCP< ParameterList > validParameters, RCP< DependencySheet > dependencySheet=null, void(*customFunc)(RCP< const ParameterList >)=NULL)
 Retreives the input for a Teuchos Parameter List using a GUI. Note the Parameter List will be edited. All user input will be stored in it. Also runs the function specified whenever the user clicks the action button and uses the specified dependency list.
void getInput (const std::string &nameOfXmlFile, RCP< ParameterList > &userInput, void(*customFunc)(RCP< const ParameterList >)=NULL)
 Reads in a set of parameters and dependencies from the specified xmlfile, displays a GUI, and stores the users input in the sprecified ParameterList. If a custom function is provided, it is run upon the user clicking the action button.

Function Documentation

QString Optika::determineArrayType ( RCP< const ParameterEntry >  parameter,
bool  twoD = false 
)

Determines the type of array stored in a parameter.

Parameters:
parameterThe parameter whose array type is in question.
Returns:
A QString containing the type of array in the parameter.

Definition at line 45 of file Optika_ArrayHelperFunctions.cpp.

QString Optika::determineArrayType ( RCP< const ParameterEntry >  parameter)

Definition at line 67 of file Optika_ArrayHelperFunctions.cpp.

QVariant Optika::arrayEntryToVariant ( RCP< const ParameterEntry >  arrayEntry,
QString  type,
bool  twoD = false 
)

Creates a QVariant containing the array that is in arrayEntry.

Parameters:
arrayEntryThe parameter entry containing the array.
typeThe array's template type.
Returns:
A QVariant containing an Array that is equal to the Array in array entry.

Definition at line 89 of file Optika_ArrayHelperFunctions.cpp.

QString Optika::getArrayType ( QString  itemType)

Given a type string, determines the template type of the Array.

Parameters:
itemTypeThe type string describing the array.
Returns:
The template type of the Array.

Definition at line 134 of file Optika_ArrayHelperFunctions.cpp.

bool Optika::isArrayEmpty ( RCP< const ParameterEntry >  arrayEntry,
QString  type 
)

Determines wether or no the array inside a ParameterEntry is empty.

Parameters:
arrayEntryThe parameter entry containging the array.
typeThe template type of the array.
Returns:
True if the array is empty, false otherwise.

Definition at line 138 of file Optika_ArrayHelperFunctions.cpp.

void Optika::getInput ( RCP< ParameterList >  validParameters,
RCP< DependencySheet >  dependencySheet = null,
void(*)(RCP< const ParameterList >)  customFunc = NULL 
)

Retreives the input for a Teuchos Parameter List using a GUI. Note the Parameter List will be edited. All user input will be stored in it. Also runs the function specified whenever the user clicks the action button and uses the specified dependency list.

Parameters:
validParametersA list of parameters from which the users may specify values.
dependencySheetA sheet listing any dependencies between parameters in the validParameters ParameterList.
customFuncCustom function to run whenever the user clicks the action button.

Definition at line 47 of file Optika_GUI.cpp.

void Optika::getInput ( const std::string &  nameOfXmlFile,
RCP< ParameterList > &  userInput,
void(*)(RCP< const ParameterList >)  customFunc = NULL 
)

Reads in a set of parameters and dependencies from the specified xmlfile, displays a GUI, and stores the users input in the sprecified ParameterList. If a custom function is provided, it is run upon the user clicking the action button.

Parameters:
namOfXmlFileThe name of the xml file from which parameters and dependencies will be read in.
userInputA ParameterList into which all user input should be stored.
customFuncA custom function for Optika to run upon the user clicking the action button.

Definition at line 61 of file Optika_GUI.cpp.

std::string Optika::Optika_Version ( )

Return a string describing the version of Optika.

Returns:
A string describing the version of Optika.

Definition at line 55 of file Optika_Version.hpp.

void Optika::RUN_BASIC_OPTIKA_TESTS ( )

Definition at line 49 of file test/gui/basic/main.cpp.

void Optika::RUN_OPTIKA_DATA_TYPE_TESTS ( )

Definition at line 50 of file test/gui/datatypes/main.cpp.

void Optika::RUN_OPTIKA_DEPENDENCY_AND_EXEC_TEST ( )

Definition at line 56 of file test/gui/dependencyandexec/main.cpp.

template<class T >
void Optika::testingSpinBoxApply ( const RCP< EnhancedNumberValidator< T > >  validator,
QAbstractSpinBox *  spinner 
)

Definition at line 492 of file GUI_UnitTests.cpp.

template<>
void Optika::testingSpinBoxApply ( const RCP< EnhancedNumberValidator< double > >  validator,
QAbstractSpinBox *  spinner 
)

Definition at line 500 of file GUI_UnitTests.cpp.

template<>
void Optika::testingSpinBoxApply ( const RCP< EnhancedNumberValidator< float > >  validator,
QAbstractSpinBox *  spinner 
)

Definition at line 508 of file GUI_UnitTests.cpp.

template<class T >
QAbstractSpinBox* Optika::createDefaultSpinner ( )

Definition at line 516 of file GUI_UnitTests.cpp.

template<>
QAbstractSpinBox* Optika::createDefaultSpinner< float > ( )

Definition at line 521 of file GUI_UnitTests.cpp.

template<>
QAbstractSpinBox* Optika::createDefaultSpinner< double > ( )

Definition at line 526 of file GUI_UnitTests.cpp.

template<class T >
void Optika::assertSpinnerDefaults ( QAbstractSpinBox *  spinBox)

Definition at line 531 of file GUI_UnitTests.cpp.

template<>
void Optika::assertSpinnerDefaults< float > ( QAbstractSpinBox *  spinBox)

Definition at line 539 of file GUI_UnitTests.cpp.

template<>
void Optika::assertSpinnerDefaults< double > ( QAbstractSpinBox *  spinBox)

Definition at line 550 of file GUI_UnitTests.cpp.

template<class T >
void Optika::assertLineEditDetails ( const QValidator *  validator,
QString &  val20,
QString &  valneg1,
int &  pos 
)

Definition at line 562 of file GUI_UnitTests.cpp.

template<>
void Optika::assertLineEditDetails< float > ( const QValidator *  validator,
QString &  val20,
QString &  valneg1,
int &  pos 
)

Definition at line 573 of file GUI_UnitTests.cpp.

template<>
void Optika::assertLineEditDetails< double > ( const QValidator *  validator,
QString &  val20,
QString &  valneg1,
int &  pos 
)

Definition at line 588 of file GUI_UnitTests.cpp.

template<class T >
void Optika::valApplyTestTemplate ( )

Do spinner testing

Do lineedit testing

Definition at line 603 of file GUI_UnitTests.cpp.

Optika::TEUCHOS_UNIT_TEST ( Array_Helper_Functions  ,
ArrayToQVariant   
)

Definition at line 49 of file NonGUI_UnitTests.cpp.

Optika::TEUCHOS_UNIT_TEST ( Array_Helper_Functions  ,
DetermineArrayType   
)

Definition at line 68 of file NonGUI_UnitTests.cpp.

Optika::TEUCHOS_UNIT_TEST ( Array_Helper_Functions  ,
GetArrayType   
)

Definition at line 107 of file NonGUI_UnitTests.cpp.

Optika::TEUCHOS_UNIT_TEST ( Array_Helper_Functions  ,
IsArrayEmpty   
)

Definition at line 122 of file NonGUI_UnitTests.cpp.

Optika::TEUCHOS_UNIT_TEST ( TreeItem_Functions  ,
ArrayTypes   
)

Definition at line 132 of file NonGUI_UnitTests.cpp.


Variable Documentation

Definition at line 59 of file Optika_metawindow.cpp.

QString Optika::listId = QString("list")

The id's for the supported Optika types. *

Definition at line 43 of file Optika_Types.cpp.

QString Optika::intId = QString("int")

*

Definition at line 44 of file Optika_Types.cpp.

QString Optika::shortId = QString("short")

*

Definition at line 45 of file Optika_Types.cpp.

QString Optika::doubleId = QString("double")

*

Definition at line 47 of file Optika_Types.cpp.

QString Optika::floatId = QString("float")

*

Definition at line 48 of file Optika_Types.cpp.

QString Optika::boolId = QString("bool")

*

Definition at line 49 of file Optika_Types.cpp.

QString Optika::stringId = QString("string")

*

Definition at line 50 of file Optika_Types.cpp.

QString Optika::arrayId = QString("array")

*

Definition at line 51 of file Optika_Types.cpp.

QString Optika::unrecognizedId = QString("unrecognized")

*

Definition at line 52 of file Optika_Types.cpp.

QString Optika::twoDArrayId = QString("2DArray")

*

Definition at line 53 of file Optika_Types.cpp.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends Defines