| IGLib 1.4 The IGLib base library for development of numerical, technical and business applications.

- Main Page
- Namespaces
- Classes
- Files
- Directories

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Properties | Private Member Functions | Private Attributes | Static Private Attributes

# IG::Neural::MappingApproximationFileManager Class Reference

File manager for mapping file client and server. More...

Inheritance diagram for IG::Neural::MappingApproximationFileManager:
[legend]
Collaboration diagram for IG::Neural::MappingApproximationFileManager:
[legend]

List of all members.

## Public Member Functions
| MappingApproximationFileManager (string directoryPath)
| Constructs a new file manager for mapping approximation file client/server that operates in the specified directory.
| MappingApproximationFileManager (string directoryPath, DataMapperSimple mapper)
void | SetFunctionInputReady ()
| Sets the falg that indicates that the reduced approximation input data is ready.
void | ClearFunctionInputReady ()
| Clears the falg that indicates that the reduced approximation input data is ready.
bool | IsFunctionInputReady ()
| Returns value of the falg that indicates whether the reduced approximation input data is ready.
void | SetFunctionOutputReady ()
| Sets the falg that indicates that the reduced approximation output data is ready.
void | ClearFunctionOutputReady ()
| Clears the falg that indicates that the reduced approximation output data is ready.
bool | IsFunctionOutputReady ()
| Returns value of the falg that indicates whether the reduced approximation output data is ready.
void | ClearMessages ()
| Clears all messages for neural approximation client and server.
virtual void | ReadFunctionInput (ref IVector inputParameters)
| Reads function reduced input parameters form the file at standard location.
virtual void | WriteFunctionInput (IVector inputParameters)
| Writes function reduced input parameters to standard location.
virtual void | ReadFunctionOutput (ref IVector outputValues)
| Reads Function reduced output values from the file at standard location.
virtual void | WriteFunctionOutput (IVector outputValues)
| Writes function reduced outut values to the file at standard location.
virtual void | LoadDataDefinition (ref InputOutputDataDefiniton definitionData)
| Loads the definition data from the file at standard location.
virtual void | LoadMappingDefinition (ref MappingDefinition mappingDefinition)
| Loads the mapping definition data from the file at standard location.
virtual void | ClientTestCalculateMappingApproximation (string functionInputFilePath, string functionOutputFilePath)
| Performs client-side test calculation of neural network based approximation where input parameters are read from a specified function JSON file with reduced input parameters, copies to specified JSON file with total inputs and calculated output values are written to the specified file.
virtual void | ServerCalculateMappingApproximation ()
| Performs neural network-based approximation at prescribed reduced input parameters and saves results. Messages are set and cleared appropriately. This method read reduced input parameters from standard location, mapps input parameters, loads trained neural network, calculates approximated outpur values, mapps output values, and stores them to the standard location.
## Properties
static DataMapperIdentity | Aux`[get]`
| Initialize DataMapperIdentity object for identity copying.
IDataMapper | MapperDefinition`[get, set]`
| Initialize DataMapperIdentity object for identity copying if mapper is null. Setter takes DataMapperSimple object.
string | MappingDefinitionPath`[get, set]`
| File path of the input and output mapping definition file. Setter takes only pure file name, without path information. If set to null then file path is set to null and will be recalculated when getter is called.
string | FunctionInputPath`[get, set]`
| File path of the file with reduced input parameters. Setter takes only pure file name, without path information. If set to null then file path is set to null and will be recalculated when getter is called.
string | FunctionOutputPath`[get, set]`
| File path of the file for storing reduced approximated output values. Setter takes only pure file name, without path information. If set to null then file path is set to null and will be recalculated when getter is called.
string | MsgFunctionInputReadyPath`[get, set]`
| File path of the message file indicating that reduced input data is ready to be processed. Setter takes only pure file name, without path information. If set to null then file path is set to null and will be recalculated when getter is called.
string | MsgFunctionOutputReadyPath`[get, set]`
| File path of the message file indicating that the reduced approximated output is ready to be read. Setter takes only pure file name, without path information. If set to null then file path is set to null and will be recalculated when getter is called.
## Private Member Functions
| MappingApproximationFileManager ()
## Private Attributes
string | _mappingDefinitionFilename = NeuralFileConst.MappingDefinitionFilename
string | _mappingDefinitionPath = null
string | _functionInputFilename = NeuralFileConst.FunctionInputFilename
string | _functionInputPath = null
string | _functionOutputFilename = NeuralFileConst.FunctiOutputFilename
string | _functionOutputPath = null
string | _msgFunctionInputReadyFilename = NeuralFileConst.MsgFunctionInputReadyFilename
string | _msgFunctionInputReadyPath = null
string | _msgFunctionOutputReadyFilename = NeuralFileConst.MsgFunctionOutputReadyFilename
string | _msgFunctionOutputReadyPath = null
IDataMapper | _mapperDefinition = null
## Static Private Attributes
static DataMapperIdentity | _aux = null

## Detailed Description

File manager for mapping file client and server.

$A tako78 Jul11; Igor Jul11;

## Constructor & Destructor Documentation

IG::Neural::MappingApproximationFileManager::MappingApproximationFileManager | ( |  | ) | `[inline, private]`

IG::Neural::MappingApproximationFileManager::MappingApproximationFileManager | ( | string | directoryPath | ) | `[inline]`

Constructs a new file manager for mapping approximation file client/server that operates in the specified directory.

Parameters:

  directoryPath | Operation directory for data & message exchange through files.

$A Igor Jul, tako78 Jul

IG::Neural::MappingApproximationFileManager::MappingApproximationFileManager | ( | string | directoryPath,
|  | DataMapperSimple | mapper
| ) |  | `[inline]`

Parameters:

  directoryPath |
  mapper |

$A Igor Jul, tako78 Jul

## Member Function Documentation

void IG::Neural::MappingApproximationFileManager::SetFunctionInputReady | ( |  | ) | `[inline]`

Sets the falg that indicates that the reduced approximation input data is ready.

$A tako78 Jul.21

void IG::Neural::MappingApproximationFileManager::ClearFunctionInputReady | ( |  | ) | `[inline]`

Clears the falg that indicates that the reduced approximation input data is ready.

$A tako78 Jul.21

bool IG::Neural::MappingApproximationFileManager::IsFunctionInputReady | ( |  | ) | `[inline]`

Returns value of the falg that indicates whether the reduced approximation input data is ready.

$A tako78 Jul.21

void IG::Neural::MappingApproximationFileManager::SetFunctionOutputReady | ( |  | ) | `[inline]`

Sets the falg that indicates that the reduced approximation output data is ready.

$A tako78 Jul.21

void IG::Neural::MappingApproximationFileManager::ClearFunctionOutputReady | ( |  | ) | `[inline]`

Clears the falg that indicates that the reduced approximation output data is ready.

$A tako78 Jul.21

bool IG::Neural::MappingApproximationFileManager::IsFunctionOutputReady | ( |  | ) | `[inline]`

Returns value of the falg that indicates whether the reduced approximation output data is ready.

$A tako78 Jul.21

void IG::Neural::MappingApproximationFileManager::ClearMessages | ( |  | ) | `[inline]`

Clears all messages for neural approximation client and server.

$A tako78 Jul.21

Reimplemented from IG::Neural::NeuraApproximationFileManager.

virtual void IG::Neural::MappingApproximationFileManager::ReadFunctionInput | ( | ref IVector | inputParameters | ) | `[inline, virtual]`

Reads function reduced input parameters form the file at standard location.

Parameters:

  inputParameters | Object where parameters are stored.

$A tako78 Jul.21

virtual void IG::Neural::MappingApproximationFileManager::WriteFunctionInput | ( | IVector | inputParameters | ) | `[inline, virtual]`

Writes function reduced input parameters to standard location.

Parameters:

  inputParameters | Parameters to be written.

$A tako78 Jul.21

virtual void IG::Neural::MappingApproximationFileManager::ReadFunctionOutput | ( | ref IVector | outputValues | ) | `[inline, virtual]`

Reads Function reduced output values from the file at standard location.

Parameters:

  outputValues | Object where the read outut values are stored.

$A tako78 Jul.21

virtual void IG::Neural::MappingApproximationFileManager::WriteFunctionOutput | ( | IVector | outputValues | ) | `[inline, virtual]`

Writes function reduced outut values to the file at standard location.

Parameters:

  outputValues | Output values that are written.

$A tako78 Jul.21

virtual void IG::Neural::MappingApproximationFileManager::LoadDataDefinition | ( | ref InputOutputDataDefiniton | definitionData | ) | `[inline, virtual]`

Loads the definition data from the file at standard location.

Parameters:

  trainedNetwork | Object where the loaded neural network approximator is stored.

$A tako78 Jul.21

virtual void IG::Neural::MappingApproximationFileManager::LoadMappingDefinition | ( | ref MappingDefinition | mappingDefinition | ) | `[inline, virtual]`

Loads the mapping definition data from the file at standard location.

Parameters:

  trainedNetwork | Object where the loaded neural network approximator is stored.

$A tako78 Jul.21

virtual void IG::Neural::MappingApproximationFileManager::ClientTestCalculateMappingApproximation | ( | string | functionInputFilePath,
|  | string | functionOutputFilePath
| ) |  | `[inline, virtual]`

Performs client-side test calculation of neural network based approximation where input parameters are read from a specified function JSON file with reduced input parameters, copies to specified JSON file with total inputs and calculated output values are written to the specified file.

Parameters:

  inputFilePath | Path to the JSON file where input parameters are read from. The file pointed at must exist.
  outputFilePath | Path of a file where the calculated approximated values are written to. It can be null or empty string, in this case parameters are not written to a file (but they are still output on console).

$A tako78 Jul;

virtual void IG::Neural::MappingApproximationFileManager::ServerCalculateMappingApproximation | ( |  | ) | `[inline, virtual]`

Performs neural network-based approximation at prescribed reduced input parameters and saves results. Messages are set and cleared appropriately. This method read reduced input parameters from standard location, mapps input parameters, loads trained neural network, calculates approximated outpur values, mapps output values, and stores them to the standard location.

$A tako78 Jul.21

## Member Data Documentation

string IG::Neural::MappingApproximationFileManager::_mappingDefinitionFilename = NeuralFileConst.MappingDefinitionFilename`[private]`

string IG::Neural::MappingApproximationFileManager::_mappingDefinitionPath = null`[private]`

string IG::Neural::MappingApproximationFileManager::_functionInputFilename = NeuralFileConst.FunctionInputFilename`[private]`

string IG::Neural::MappingApproximationFileManager::_functionInputPath = null`[private]`

string IG::Neural::MappingApproximationFileManager::_functionOutputFilename = NeuralFileConst.FunctiOutputFilename`[private]`

string IG::Neural::MappingApproximationFileManager::_functionOutputPath = null`[private]`

string IG::Neural::MappingApproximationFileManager::_msgFunctionInputReadyFilename = NeuralFileConst.MsgFunctionInputReadyFilename`[private]`

string IG::Neural::MappingApproximationFileManager::_msgFunctionInputReadyPath = null`[private]`

string IG::Neural::MappingApproximationFileManager::_msgFunctionOutputReadyFilename = NeuralFileConst.MsgFunctionOutputReadyFilename`[private]`

string IG::Neural::MappingApproximationFileManager::_msgFunctionOutputReadyPath = null`[private]`

DataMapperIdentity IG::Neural::MappingApproximationFileManager::_aux = null`[static, private]`

IDataMapper IG::Neural::MappingApproximationFileManager::_mapperDefinition = null`[private]`

## Property Documentation

DataMapperIdentity IG::Neural::MappingApproximationFileManager::Aux`[static, get, private]`

Initialize DataMapperIdentity object for identity copying.

Initializing is performed only once. $A Igor Jul, tako78 Jul

IDataMapper IG::Neural::MappingApproximationFileManager::MapperDefinition`[get, set]`

Initialize DataMapperIdentity object for identity copying if mapper is null. Setter takes DataMapperSimple object.

$A Igor Jul, tako78 Jul

string IG::Neural::MappingApproximationFileManager::MappingDefinitionPath`[get, set]`

File path of the input and output mapping definition file. Setter takes only pure file name, without path information. If set to null then file path is set to null and will be recalculated when getter is called.

$A tako78 Jul.21

string IG::Neural::MappingApproximationFileManager::FunctionInputPath`[get, set]`

File path of the file with reduced input parameters. Setter takes only pure file name, without path information. If set to null then file path is set to null and will be recalculated when getter is called.

$A tako78 Jul.21

string IG::Neural::MappingApproximationFileManager::FunctionOutputPath`[get, set]`

File path of the file for storing reduced approximated output values. Setter takes only pure file name, without path information. If set to null then file path is set to null and will be recalculated when getter is called.

$A tako78 Jul.21

string IG::Neural::MappingApproximationFileManager::MsgFunctionInputReadyPath`[get, set]`

File path of the message file indicating that reduced input data is ready to be processed. Setter takes only pure file name, without path information. If set to null then file path is set to null and will be recalculated when getter is called.

$A tako78 Jul.21

string IG::Neural::MappingApproximationFileManager::MsgFunctionOutputReadyPath`[get, set]`

File path of the message file indicating that the reduced approximated output is ready to be read. Setter takes only pure file name, without path information. If set to null then file path is set to null and will be recalculated when getter is called.

$A tako78 Jul.21

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

- NeuralFileManager.cs

All Classes Namespaces Files Functions Variables Enumerations Properties Events