 |
GemaCoreLib
The GeMA Core library
|
|
GemaCoreLib
The GeMA Core library
|
Interface class for accessing and setting values from an "indexable" collection of values. More...
#include <gmValueAccessor.h>
Public Member Functions | |
| virtual | ~GmValueAccessor () |
| Virtual destructor. | |
| virtual int | size () const =0 |
| Returns the number of values in the set refered to by the accessor, meaning that valid indices will fall in the range [0..size()-1]. | |
| virtual GmValueInfo * | info () const =0 |
| Returns the information object describing the values returned by this accessor. | |
| bool | isScalar () const |
| Returns true if the accessor returns scalar values (can be false even if valueSize() == 1 – think about a 1x1 matrix) | |
| virtual bool | isDefValue (int index) const =0 |
| Returns true if the value at the specified index is equal to the default value defined by info()->defValue() | |
| virtual const double * | defValue () const |
| Returns the default value for the data converted to the accessor unit. The returned array contents is valid only UNTIL a new call to the accessor is done. Meaningfull only when the default value is NOT a function. | |
| virtual Unit | unit () const =0 |
| Returns the unit in which data returned/received by the accessor is expressed. More... | |
| virtual bool | hasUnitConversion () const =0 |
| Returns true if this accessor perfroms unit conversions, false if not. | |
| int | valueSize () const |
| Returns the size of the array returned by value(), i.e. 1 for scalar values and nlin * ncol for vector or matrix values. | |
| virtual int | adjustLinearIndex (int index, const GmMesh *m) |
| Translates a linear index (from 0 to mesh->totalNumNodes()-1) into a valid index for this accessor or into -1 if the given index is out of range. More... | |
| virtual int | adjustLinearIndex (int index, int firstGhostIndex) |
| Simmilar to adjustLinearIndex(int, const GmMesh*), this function overload gets as second parameter the index of the first ghost node in the mesh (equal to mesh->numNodes()). | |
| virtual const double * | valueAt (int index, const GmVector *coord) const =0 |
| Returns the value associated with the "index" position of the data set, evaluated at the requested position (when necessary). More... | |
| const double * | value (int index) const |
| Similar to valueAt(), passing NULL as coordinates. | |
| virtual double | scalarValueAt (int index, const GmVector *coord) const =0 |
| Similar to valueAt() but returning a single double. Must be used for scalar data sets only. | |
| double | scalarValue (int index) const |
| Similar to scalarValueAt(), passing NULL as coordinates. | |
| void | matrixValueAt (int index, const GmVector *coord, GmCRMatrix &mat) const |
| Similar to valueAt(), but returning the result as a CONST matrix. Bear in mind that the resulting matrix is valid only UNTIL the next call to the accessor. | |
| void | matrixValue (int index, GmCRMatrix &mat) const |
| Similar to matrixValueAt(), passing NULL as coordinates. | |
| void | vectorValueAt (int index, const GmVector *coord, GmCRVector &vec) const |
| Similar to valueAt(), but returning the result as a CONST vector. Bear in mind that the resulting vector is valid only UNTIL the next call to the accessor. | |
| void | vectorValue (int index, GmCRVector &vec) const |
| Similar to vectorValueAt(), passing NULL as coordinates. | |
| virtual bool | setValue (int index, const double *value)=0 |
| Allows for altering the value associated with entry "index" in the value set. This version of the function works for scalar, vector or matrix values. Values are copied to the data set. Matrix values should be organized in COLUMN MAJOR ORDER. More... | |
| virtual bool | setScalarValue (int index, double value)=0 |
| Similar to setValue() but passing a single double. Must be used for scalar data sets only. | |
| virtual bool | setScalarValueAtDim (int index, int dim, double val) |
| Similar to setValue() but changing only the value at the given dimension. Can be used over scalar, vector and matrix sets. For matrices, dim refers to the position in the linearized vector data in COLUMN MAJOR FORMAT. Should be used only if the current value is NOT a function. | |
| virtual bool | setValueAsDef (int index)=0 |
| Similar to setValue(), filling the index entry with the default value. | |
| bool | setMatrixValue (int index, const GmMatrix &mat) |
| Similar to setValue() but receiving the data as a matrix. | |
| bool | setVectorValue (int index, const GmVector &vec) |
| Similar to setValue() but receiving the data as a vector. | |
| bool | addScalarToValue (int index, double value) |
| Convenience function equivalent to calling setScalarValue(index, scalarValue(index) + value) | |
| bool | addToValue (int index, const double *val) |
| Convenience function logically equivalent to calling setValue(index, value(index) + val) operating over the full vector. Should be used only if the current value is NOT a function. | |
| virtual bool | setFunctionValue (int index, GmUserFunction *functionDef)=0 |
| Overload of setValue() storing a user function definition. More... | |
| virtual bool | setFunctionValue (int index, GmUserFunctionEvaluator *functionEval)=0 |
| Overload of setValue() storing a user function evaluation context. More... | |
| virtual QString | valueStr (int index, bool evalFunctions, bool printDefAsNil, int fieldWidth=0, char format='g', int precision=-1, const GmVector *coord=NULL) const =0 |
| Auxiliary function to return the value of an accessor converted to a string. Works for scalars, vectors and matrices. More... | |
| virtual bool | setFunctionFromName (int index, QString userFunctionId, QString &err)=0 |
| Sets a function value from the function name. More... | |
| virtual bool | setValueFromVariant (int index, const QVariant &v, bool acceptMissingDimension, QString &err)=0 |
| Sets a value with data read from a QVariant. More... | |
| virtual bool | isFunction (int index) const =0 |
| Returns true if the data in index is a reference to a function (in C or Lua). Used by valueStr() to mark function results. | |
| virtual QString | functionId (int index) const =0 |
| Returns a function id name for a function reference at the index or an empty string for non function indices. Used by valueStr(). | |
| virtual void | setEvalContext (GmValueSetEvalContext *context, bool ownsContext)=0 |
| Sets the EvalContext object that will be used to translate function names / objects into function evaluators to allow for evaluating user functions. | |
| virtual GmValueSetEvalContext * | evalContext () const =0 |
| Returns the internal evaluation context. Needed by GmCellAccessorProxy, GmBcAccessorProxy & state dump functions. | |
Protected Member Functions | |
| virtual double | convertToAccessorUnit (double val) const =0 |
| An utility function that given a value, converts it to the accessor unit. If no conversion is needed, returns val. | |
| virtual const double * | convertToAccessorUnit (const double *p) const =0 |
| An utility function that given a pointer to the stored data, converts the value to the accessor unit and returns a pointer to the internal buffer used to store the converted value. If no conversion is needed, returns p. | |
| virtual void | convertFromAccessorUnit (double val, double *dst) const =0 |
| Copies the values given by val into the area pointed to by dst, converting units if needed. | |
| virtual void | convertFromAccessorUnit (const double *val, double *dst) const =0 |
| Copies the values given by val into the area pointed to by dst, converting units if needed. | |
Friends | |
| class | GmAccessorProxy |
| class | GmGhostNodeAccessor |
Interface class for accessing and setting values from an "indexable" collection of values.
Through its public value() and setValue() interface, a user should be able to query and set values from a set in a manner independent of how or where the data is beeing stored. The only requirement is that the data should be randomly accessible by an index passed to this functions.
If configured in the accessor construction, values should be converted to and from a desired work unit. If a value is a reference to a function, as defined by GmValueData, the appropriate function execution should also be done by the accessor.
|
inlinevirtual |
Translates a linear index (from 0 to mesh->totalNumNodes()-1) into a valid index for this accessor or into -1 if the given index is out of range.
When dealing with ghost nodes in a general setting, where a loop traverses all available linear node indices, we might have to adjust the linear index since an accessor might be able to honor only the geometry or the ghost part of the data. Also, for ghost only accessors, the indexing rule that says that valid indices fall in the range [0..size()-1] can cause surprises since the global linear index can not be used to access the ghost only accessor directly. A zero based index should be used instead.
This function adjusts the given index to both scenarios, converting indices for ghost only accessors and returning -1 if the linear index is out of the accessor range (a ghost index for a geometry only accessor or a geometry index for a ghost only accessor).
It receives as a second parameter the associated mesh, used to get access to the number of geometric nodes in the mesh.
Reimplemented in GmGhostNodeAccessor.
|
pure virtual |
Sets a function value from the function name.
On errors, returns false and fills err with a description of the problem (errors in this case are not logged through the accessor logger).
Implemented in GmValueAccessorBase, and GmGhostNodeAccessor.
|
pure virtual |
Overload of setValue() storing a user function definition.
This is the intended way to store a user function if the value set corresponding to this accessor is NOT directly tied to a mesh
(its a property set ValueSet, for example)
Implemented in GmValueSetDataAccessor< T >, GmNoFunctionValueSetDataAccessor< T >, GmGhostNodeAccessor, and StringListAccessor.
|
pure virtual |
Overload of setValue() storing a user function evaluation context.
This is the intended way to store a user function if the value set corresponding to this accessor is directly tied to a mesh (a node or cell attribute, for example). Storing an evaluator is more efficient than a function definition, but can only be done if the value set is not shared between several meshes.
Implemented in GmValueSetDataAccessor< T >, GmNoFunctionValueSetDataAccessor< T >, GmGhostNodeAccessor, and StringListAccessor.
|
pure virtual |
Allows for altering the value associated with entry "index" in the value set. This version of the function works for scalar, vector or matrix values. Values are copied to the data set. Matrix values should be organized in COLUMN MAJOR ORDER.
Returns false if the data could not be set due to allocation or permission problems and an error message will be logged.
Assumes that values are expressed in the REQUESTED desired unit if that was given when the accessor was created. If that unit exists and is different from the data base unit, values are converted to the data unit before beeing stored.
Implemented in GmGhostNodeAccessor, StringListAccessor, and GmValueSetDataAccessorBase< T >.
|
pure virtual |
Sets a value with data read from a QVariant.
The variant v can contain a double, a Lua table with a set of doubles or a string referencing an user function, according to the accessor dimension and possibility of having functions.
Matrix values can be provided either by a Lua table with values organized per column or by a table of tables.
If v is a null object, nothing is done. If a component is missing for a multidimensional object (vector or matrix), an error is reported if acceptMissingDimension is false. Otherwise, the missing data is filled with the corresponding value from the default value.
On errors, returns false and fills err with a description of the problem (errors in this case are not logged through the accessor logger).
Implemented in GmValueAccessorBase, and GmGhostNodeAccessor.
|
pure virtual |
Returns the unit in which data returned/received by the accessor is expressed.
Keep in mind that this unit can be different from info()->unit() if the accessor was created with a different unit than the original data unit.
Implemented in GmValueAccessorBase, and GmGhostNodeAccessor.
|
pure virtual |
Returns the value associated with the "index" position of the data set, evaluated at the requested position (when necessary).
If the data is a function reference, the function will be called and the result returned. Also, the results will be converted to the requested desired unit.
The function returns the address of an array (possibly internal to the accessor), storing the requested data, which can be a scalar, a vector or a matrix, linearized using COLUMN MAJOR ORDER. This array contents is valid only UNTIL a new call to the accessor is done. This restriction allows for the accessor implementation to be free to return a pointer to the data when no unit conversion is needed or a pointer to a static internal buffer when converting values.
If an error happens while evaluating a function, the result will be the (converted) default value for the data set and an error message will be logged (if the default value is itself a function, the function will return a vector filled with zeros, converted to the desired unit if needed).
The set of coordinates is used only for the evaluation of user functions over cell attributes / properties. A NULL pointer can be passed if the accessor context doesn't needs this information (and that's why this parameter is a GmVector* and not a GmVector&).
The coordinate values depends on the type of cell. For 'plain' cells, it should be cartesian coordinates in the same unit as coordinates are expressed in the mesh.
For element cells, it should be natural coordinates.
Implemented in GmValueSetDataAccessor< T >, GmNoFunctionValueSetDataAccessor< T >, GmGhostNodeAccessor, and StringListAccessor.
|
pure virtual |
Auxiliary function to return the value of an accessor converted to a string. Works for scalars, vectors and matrices.
The evalFunctions parameter defines whether function based values will be evaluated or not. If printDefAsNil == true, default values will be printed as the 'nil' string.
The formatted value conforms to the standard QString::arg() parameters. Scalars are presented as simple formatted numbers. Vectors and matrices are surrounded by [...]. Matrix values are listed in COLUMN MAJOR ORDER. Values returned by function calls are surrounded by (), which means that a vector returned by a function call will be represented as ([...]).
Implemented in GmValueAccessorBase, GmGhostNodeAccessor, and StringListAccessor.
1.8.15