#include <value_by_id.h>
Inheritance diagram for ug::d3f::ValueById< TIdManager >:
Public Types | |
| typedef TIdManager | id_manager_type |
| the id manager | |
Public Member Functions | |
| number | interpolate (number x, number y, number t) const |
| gets the value for a given point | |
| void | load_values_from (const char *file_name) |
| loads values from a file | |
| size_t | max_identifier () const |
| returns the maximum index | |
| size_t | num_columns () const |
| returns the number of the 'columns' | |
| void | set_interval (number delta) |
| sets the 'time interval' to determine the column | |
| ValueById (number default_value) | |
| constructor | |
Private Member Functions | |
| void | append_value (long ident, std::vector< number > &val) |
| appends a value | |
| void | load_values_from (std::istream &input) |
| loads values from a stream | |
Private Attributes | |
| std::vector< bool > | m_assigned |
| if the data for the id has been read (i.e. specified) | |
| std::vector< number > | m_data |
| the data as a raw array for every id | |
| number | m_default_value |
| the value to return if no id specified | |
| number | m_interval |
| interval for the 'time' parameter to choose the correct column | |
| size_t | m_numCols |
| number of the "columns" in the data array (or 0 if not specified yet) | |
Detailed Description
class ug::d3f::ValueById< TIdManager >
This class template evaluates data using an id obtained from the "id manager"
Member Typedef Documentation
◆ id_manager_type
| typedef TIdManager ug::d3f::ValueById< TIdManager >::id_manager_type |
the id manager
Constructor & Destructor Documentation
◆ ValueById()
|
inline |
constructor
Member Function Documentation
◆ append_value()
|
private |
appends a value
Appends a value to the data arrays
- Parameters
-
ident the id for the value val the values
References UG_THROW.
◆ interpolate()
| number ug::d3f::ValueById< TIdManager >::interpolate | ( | number | x, |
| number | y, | ||
| number | t | ||
| ) | const |
gets the value for a given point
Gets the value for a given point:
- Parameters
-
t the 'time argument'
References UG_THROW.
◆ load_values_from() [1/2]
| void ug::d3f::ValueById< TIdManager >::load_values_from | ( | const char * | file_name | ) |
loads values from a file
Loads values from a file.
References ug::FindFileInStandardPaths(), UG_COND_THROW, UG_LOG, and UG_THROW.
◆ load_values_from() [2/2]
|
private |
loads values from a stream
Loads values from a stream.
References UG_CATCH_THROW, UG_LOG, and UG_THROW.
◆ max_identifier()
|
inline |
returns the maximum index
References ug::d3f::ValueById< TIdManager >::m_assigned.
◆ num_columns()
|
inline |
returns the number of the 'columns'
References ug::d3f::ValueById< TIdManager >::m_numCols.
◆ set_interval()
|
inline |
sets the 'time interval' to determine the column
References ug::d3f::ValueById< TIdManager >::m_interval.
Member Data Documentation
◆ m_assigned
|
private |
if the data for the id has been read (i.e. specified)
Referenced by ug::d3f::ValueById< TIdManager >::max_identifier().
◆ m_data
|
private |
the data as a raw array for every id
◆ m_default_value
|
private |
the value to return if no id specified
◆ m_interval
|
private |
interval for the 'time' parameter to choose the correct column
Referenced by ug::d3f::ValueById< TIdManager >::set_interval().
◆ m_numCols
|
private |
number of the "columns" in the data array (or 0 if not specified yet)
Referenced by ug::d3f::ValueById< TIdManager >::num_columns().
The documentation for this class was generated from the following files:
- /home/runner/work/docs/docs/ug4/plugins/d3f/value_by_id.h
- /home/runner/work/docs/docs/ug4/plugins/d3f/value_by_id_impl.h
