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

Classes

class  GenericArrayWidget
class  IntArrayWidget
class  ShortArrayWidget
class  DoubleArrayWidget
class  FloatArrayWidget
class  StringArrayWidget
class  Condition
class  Delegate
class  Dependency
class  DependencySheet
class  FileNameWidget
class  OptikaGUI
class  InvalidConditionException
class  InvalidDependencyException
class  SearchWidget
class  MetaWindow
class  GenericNumberValidator
class  EnhancedNumberValidator
class  EnhancedNumberValidator< int >
class  EnhancedNumberValidator< short >
class  EnhancedNumberValidator< double >
class  EnhancedNumberValidator< float >
class  FileNameValidator
class  StringValidator
class  ArrayValidator
class  ArrayStringValidator
class  ArrayNumberValidator
class  ArrayFileNameValidator
class  BinaryLogicalCondition
class  OrCondition
class  AndCondition
class  EqualsCondition
class  NotCondition
class  ParameterCondition
class  StringCondition
class  NumberCondition
class  BoolCondition
class  VisualDependency
class  ValidatorDependency
class  StringVisualDependency
class  BoolVisualDependency
class  ConditionVisualDependency
class  NumberVisualDependency
class  NumberValidatorAspectDependency
class  NumberArrayLengthDependency
class  StringValidatorDependency
class  BoolValidatorDependency
class  RangeValidatorDependency
class  TreeItem
class  TreeModel
class  TreeView
class  ValidatorFactory

Functions

bool doesParameterContainArray (const Teuchos::ParameterEntry *parameter)
QStringList getValues (QString &values)
QString determineArrayType (Teuchos::ParameterEntry *parameter)
template<>
Teuchos::Array< std::string > fromStringToArray< std::string > (QString arrayString)
template<class S >
Teuchos::Array< S > fromStringToArray (QString arrayString)
void getInput (Teuchos::RCP< Teuchos::ParameterList > validParameters)
void getInput (Teuchos::RCP< Teuchos::ParameterList > validParameters, void(*customFunc)(Teuchos::RCP< const Teuchos::ParameterList >))
void getInput (Teuchos::RCP< Teuchos::ParameterList > validParameters, Teuchos::RCP< DependencySheet > dependencySheet)
void getInput (Teuchos::RCP< Teuchos::ParameterList > validParameters, Teuchos::RCP< DependencySheet > dependencySheet, void(*customFunc)(Teuchos::RCP< const Teuchos::ParameterList >))
template<>
void NumberArrayLengthDependency::modifyArrayLength< std::string > (int newLength, Teuchos::ParameterEntry *dependentToModify)
std::string Optika_Version ()

Variables

const int numRecentDocuments = 7
static int intDefaultStep = 1
static short shortDefaultStep = 1
static double doubleDefaultStep = 1
static int doubleDefaultPrecision = 3
static float floatDefaultStep = 1
static int floatDefaultPrecision = 3
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")

Function Documentation

bool Optika::doesParameterContainArray ( const Teuchos::ParameterEntry parameter)

Determines whether or not a ParameterEntry contains an array.

Returns:
True if the ParameterEntry contains an array, false otherwise.

Definition at line 31 of file Optika_ArrayHelperFunctions.cpp.

QStringList Optika::getValues ( QString &  values)

Takes a string representing an array, formats it, and returns a QStringList containing each value in the array.

Parameters:
valuesA QString containing the values in the array.
Returns:
A QStringList containing the values in the array.

Definition at line 36 of file Optika_ArrayHelperFunctions.cpp.

QString Optika::determineArrayType ( Teuchos::ParameterEntry parameter)

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 48 of file Optika_ArrayHelperFunctions.cpp.

template<>
Teuchos::Array< std::string > Optika::fromStringToArray< std::string > ( QString  arrayString)

Definition at line 71 of file Optika_ArrayHelperFunctions.cpp.

template<class S >
Teuchos::Array<S> Optika::fromStringToArray ( QString  arrayString)

Definition at line 61 of file Optika_ArrayHelperFunctions.hpp.

void Optika::getInput ( Teuchos::RCP< Teuchos::ParameterList validParameters)

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.

Parameters:
validParametersA list of parameters from which the users may specify values.

Definition at line 34 of file Optika_GUI.cpp.

void Optika::getInput ( Teuchos::RCP< Teuchos::ParameterList validParameters,
void(*)(Teuchos::RCP< const Teuchos::ParameterList >)  customFunc 
)

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 hits the submit button.

Parameters:
validParametersA list of parameters from which the users may specify values.
customFuncCustom function to run whenever the user clicks the submit button.

Definition at line 48 of file Optika_GUI.cpp.

void Optika::getInput ( Teuchos::RCP< Teuchos::ParameterList validParameters,
Teuchos::RCP< DependencySheet >  dependencySheet 
)

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.

Parameters:
validParametersA list of parameters from which the users may specify values.
dependencySheetA sheet listing any dependencies between parameters in the validParameters ParameterList.

Definition at line 62 of file Optika_GUI.cpp.

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

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 hits the submit button.

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 submit button.

Definition at line 76 of file Optika_GUI.cpp.

template<>
void Optika::NumberArrayLengthDependency::modifyArrayLength< std::string > ( int  newLength,
Teuchos::ParameterEntry dependentToModify 
)

Definition at line 270 of file Optika_StandardDependencies.cpp.

std::string Optika::Optika_Version ( )

Definition at line 33 of file Optika_Version.hpp.


Variable Documentation

Definition at line 45 of file Optika_metawindow.cpp.

int Optika::intDefaultStep = 1 [static]

Definition at line 45 of file Optika_SpecificParameterEntryValidators.hpp.

short Optika::shortDefaultStep = 1 [static]

Definition at line 46 of file Optika_SpecificParameterEntryValidators.hpp.

double Optika::doubleDefaultStep = 1 [static]

Definition at line 48 of file Optika_SpecificParameterEntryValidators.hpp.

Definition at line 49 of file Optika_SpecificParameterEntryValidators.hpp.

float Optika::floatDefaultStep = 1 [static]

Definition at line 50 of file Optika_SpecificParameterEntryValidators.hpp.

Definition at line 51 of file Optika_SpecificParameterEntryValidators.hpp.

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

The id's for the supported Optika types.

Definition at line 30 of file Optika_Types.cpp.

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

Definition at line 31 of file Optika_Types.cpp.

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

Definition at line 32 of file Optika_Types.cpp.

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

Definition at line 34 of file Optika_Types.cpp.

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

Definition at line 35 of file Optika_Types.cpp.

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

Definition at line 36 of file Optika_Types.cpp.

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

Definition at line 37 of file Optika_Types.cpp.

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

Definition at line 38 of file Optika_Types.cpp.

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

Definition at line 39 of file Optika_Types.cpp.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends