IGLib  1.7.2
The IGLib base library EXTENDED - with other lilbraries and applications.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
IG.Lib.SimJMatProSettingsDto< FmType > Class Template Reference

Settings for classes that inherit from SimJMatProFileManagerBase class. More...

+ Inheritance diagram for IG.Lib.SimJMatProSettingsDto< FmType >:
+ Collaboration diagram for IG.Lib.SimJMatProSettingsDto< FmType >:

Public Attributes

string IncludedSettingsPath
 If specified then setitngs from the specified file are read and set on the JMatPro file manager before the settings from the current object are set. More...
 
bool WorkingDirectory_RestoreFromSettings = false
 Specifies whether JMatPro interface' working directory should be stored with settings or not. If false then working directory will not copied form the setting object to the interface' file manager object (which is of type SimJMatProFileManagerBase or derived type) when calling the CopyToPlain or CopyTo method. More...
 
string WorkingDirectory
 Working directory of the JMatPro interface. More...
 
string DataDefinitionJMatFilename
 Name of the file containing data definition for all JMatPro input parameters (i.e. material composition expressed as mass fractions for individual parameters). More...
 
string DataDefinitionJMatFilePath
 Path to the file containing data definition for all JMatPro input parameters (i.e. material composition expressed as mass fractions for individual parameters). More...
 
string DataDefinitionProcessFilename
 Name of the file containing data definition for all process input and output parameters. More...
 
string DataDefinitionProcessFilePath
 Path to the file containing data definition for all process input and output parameters. More...
 
string DataDefinitionJointFilename
 Name of the file containing definition data for the superset of all input parameters and output values. More...
 
string DataDefinitionJointFilePath
 Path to the file containing definition data for the Joint of all input parameters and output values. More...
 
string WorkingMaterialParametersPath
 File path of the file in working directory where material parameters for calculation are stored. If set to null then path is set to null and will be recalculated when getter is called. More...
 
string RootDataDirectoryName
 Name of the root data directory. More...
 
string RootDataDirectoryPath
 Path to the root directory that contains directories with calculated material data for different parameters defining chemical compositions. More...
 
string LogFileName
 Name of the log file where operations are logged. More...
 
string LogFilePath
 Path to the log file where basic operations are logged. More...
 
string MaterialDataDirectoryPath
 Data directory for the current material parameters. More...
 
string MaterialParametersFilename
 Name of the file in material data directory where material parameters are stored. More...
 
string MaterialParametersPath
 File path of the file where material parameters are stored. If set to null then path is set to null and will be recalculated when getter is called. More...
 
string MaterialCompositionFilename
 Name of the file in material data directory where material composition is stored. More...
 
string MaterialCompositionPath
 File path of the file (normally in the material data directory) where material composition is stored. If set to null then path is set to null and will be recalculated when getter is called. More...
 
string MaterialResultsFilename
 Name of the file in material data directory where material results are stored. More...
 
string MaterialResultsPath
 File path of the file (normally in the material data directory) where material reslts are stored. If set to null then path is set to null and will be recalculated when getter is called. More...
 
string NameJMatProBase
 Name of the JMatPro directory (without root directories) and executable. More...
 
string JMatInstallationPath
 Path of the directory where JMAtPro is installed. Setter takes only pure directory name, without path information. If set to null then directory path is set to null and will be recalculated when getter is called. More...
 
string JMatExecutableFileName
 JMatPro executable relative path to installation directory. More...
 
string JMatExecutableFilePath
 Path to the JMatPro executable. More...
 
string JMatDataPath
 Path to the JMatPro data directory (containing material data, input and output data, etc.) More...
 
string JMatCompositionFilename
 Relative path, with respect to JMatPro data directory, of the file containing material composition (input for JMatPro calculation). More...
 
string JMatCompositionFilePath
 Path of the file containing material composition (input for JMatPro calculation). More...
 
string JMatResultsFilename
 Relative path, with respect to JMatPro data directory, of the file containing material results of JMatPro calculation. More...
 
string JMatResultsFilePath
 Path of the file containing results of JMatPro calculation. More...
 
int JMatResultsMinimalSize = 0
 Minimal size of the result file, used to verify validity of results. More...
 
int JMatResultsGoodSize = 0
 Size of the materials result file that is considered a good size - the file should be at least of this size if calculation was performed without errors. More...
 
string JMatCompletionDetectionFilename
 Relative path, with respect to JMatPro data directory, of the file used to detect whether calculation is still going on. More...
 
string JMatCompletionDetectionFilePath
 Path of the file used to detect whether calculation is still going on. More...
 
double JMatCompletionDetectionSleepTimeSeconds
 Sleeping time used in detectiong whether JMatPro calculation is still going on. More...
 
int JMatCompletionDetectionSize
 Minimal size of calculation detection file above which calculation is considered finished. More...
 
double JMatBeforeSaveSleepTimeSeconds = 3.5
 Waiting time (in seconds) after last increase in file size used before thinking that calculation is finished, to eventually prevent too early detection that calculation was finished. More...
 
double JMatTimeoutWaitCalculationSeconds
 Timeout for waiting completion of calculation, in seconds. More...
 
double JMatTimeoutWaitResultsSavedSeconds
 Timeout for waiting until results are completely saved, in seconds. More...
 
int JMatResultsSavedDetectionSize
 Minimal size of result file file, above which saving results can be considered finished. More...
 
double JMatBeforeResultsSavedSleepTimeSeconds
 Waiting time (in seconds) after last increase in file size used before assuming that saving result is finished, to eventually prevent too early detection that calculation was finished. More...
 
string UserInteractionCommand
 Command for playback of recorded user interaction (i.e. emulation of keyboard and mouse events) for various actions. More...
 
string UserInteractionRecordDir
 Dierctory containing recorded user interactions for different actions. More...
 
string UserInteractionRecordExtension
 Extension of files with recorded user interaction. More...
 
string UserInteractionRecordNameStartJMat
 Name of the user interaction record for starting JMatPro software via Windows GUI. More...
 
string UserInteractionRecordPathStartJMat
 Path to the user interaction record for starting JMatPro software via Windows GUI. More...
 
string UserInteractionRecordNameCloseJMat
 Name of the user interaction record for closing JMatPro software normally via GUI. More...
 
string UserInteractionRecordPathCloseJMat
 Path to the user interaction record for closing JMatPro software normally via GUI. More...
 
string UserInteractionRecordNameRepairJMat
 Name of the user interaction record for repairing JMatPro software. More...
 
string UserInteractionRecordPathRepairJMat
 Path to the user interaction record for repairing JMatPro software. More...
 
string UserInteractionRecordNameStartCalculation
 Name of the file containing recors of user interaction necessary to start JMatPro. More...
 
string UserInteractionRecordPathStartCalculation
 Name of the file containing recors of user interaction necessary to start JMatPro. More...
 
string UserInteractionRecordNameSaveResults
 Name of the file containing records of user interaction necessary to save results of JMatPro calculation. More...
 
string UserInteractionRecordPathSaveResults
 Path to the file containing recors of user interaction necessary to save results of JMatPro calculation. More...
 
string UserInteractionRecordNameChangeTemperatureUnit
 Name of the file containing records of user interaction necessary to change temperature uits in JMatPro that is already launched. More...
 
string UserInteractionRecordPathChangeTemperatureUnit
 Path to the file containing recors of user interaction necessary to change temperature uits in JMatPro that is already launched. More...
 
string UserInteractionRecordNameChangeFractionUnit
 Name of the file containing records of user interaction necessary to change fraction uits in JMatPro that is already launched. More...
 
string UserInteractionRecordPathChangeFractionUnit
 Path to the file containing recors of user interaction necessary to change fraction uits in JMatPro that is already launched. More...
 

Protected Member Functions

override void CopyFromPlain (SimJMatProFileManagerBase fm)
 Copies the specified training limits to the current DTO. More...
 
override void CopyToPlain (ref SimJMatProFileManagerBase fm)
 Copies contents of the current DTO to the specified training limits object. More...
 
- Protected Member Functions inherited from IG.Lib.SerializationDtoBase< Type, BaseType >
abstract void CopyFromPlain (BaseType obj)
 Copies contents of the specified object to the current DTO (Data Transfer Object). More...
 
abstract void CopyToPlain (ref BaseType obj)
 Copies contents of the current DTO (Data Transfer Object) to the specified object. More...
 
- Protected Member Functions inherited from IG.Lib.SerializationDto
 SerializationDto ()
 

Additional Inherited Members

- Public Member Functions inherited from IG.Lib.SerializationDtoBase< Type, BaseType >
 SerializationDtoBase ()
 
virtual bool GetNull ()
 Returns a flag indicating whether the object represented by the current DTO is null. More...
 
virtual void SetNull (bool isNull)
 Sets a flag indicating whether the object represented by the current DTO is null. More...
 
abstract Type CreateObject ()
 Creates and returns a new object of the type whose data is represented by the current DTO (Data Transfer Object). WARNING: Implement thread locking in overriding functions! More...
 
virtual void CopyFromBase (BaseType obj)
 Copies data to the current DTO from an object of type BaseType. More...
 
virtual void CopyToBase (ref BaseType obj)
 Copies data from the current DTO to an object of the base type. Object is created anew if necessary by using the CreateObject() method. More...
 
virtual void CopyFrom (Type obj)
 Copies data to the current DTO from an object of type Type. More...
 
virtual void CopyTo (ref Type obj)
 Copies data from the current DTO to an object of type Type. Object is created anew if necessary by using the CreateObject() method. More...
 
virtual void CopyFromObject (object obj)
 Copies data to the current DTO from an object of type object. The necessary casts are performed. More...
 
virtual void CopyToObject (ref object obj)
 Copies data from the current DTO to an object of type object. Object is created anew if necessary by using the CreateObject() method. The necessary casts are performed. More...
 
override string ToString ()
 Creates and returns string representation of the current DTO (data transfer object). More...
 
- Static Public Member Functions inherited from IG.Lib.SerializationDto
static ObjectType CopyToObjectReturned< DtoType, ObjectType > (DtoType dto, ObjectType obj)
 Replacement for CopyToObject for cases where object can not be passed by reference. The returned object must be assigned to object (property, list element, etc.) to which object state is copied. More...
 
static void CopyToObject< DtoType, ObjectType > (DtoType dto, ref ObjectType obj)
 Copies object state form the specified DTO (data transfer object) to the specified object. More...
 
static DtoType CopyFromObjectReturned< DtoType, ObjectType > (ObjectType obj, DtoType dto)
 Replacement for CopyFromObject for cases where object can not be passed by reference. The returned object must be assigned to object (property, list element, etc.) to which object state is copied. More...
 
static void CopyFromObject< DtoType, ObjectType > (ObjectType obj, ref DtoType dto)
 Copies object state form the specified object to the corresponding DTO (data transfer object). More...
 
static ObjectType[] CopyArrayToObjectReturned< DtoType, ObjectType > (DtoType[] tabDto, ObjectType[] tabObj)
 Replacement for CopyArrayToObject for cases where object can not be passed by reference. The returned object must be assigned to object (property, list element, etc.) to which data is copied. More...
 
static void CopyArrayToObject< DtoType, ObjectType > (DtoType[] tabDto, ref ObjectType[] tabObj)
 Copies array of DTOs (Data Transfer Objects) to an array of appropriate objects. More...
 
static DtoType[] CopyArrayFromObjectReturned< DtoType, ObjectType > (ObjectType[] tabObj, DtoType[] tabDto)
 Replacement for CopyArrayFromObject for cases where object can not be passed by reference. The returned object must be assigned to object (property, list element, etc.) to which data is copied. More...
 
static void CopyArrayFromObject< DtoType, ObjectType > (ObjectType[] tabObj, ref DtoType[] tabDto)
 Copies array of objects to an array of DTOs. More...
 
static List< ObjectType > CopyListToObjectReturned< DtoType, ObjectType > (DtoType[] tabDto, List< ObjectType > listObj)
 Replacement for CopyListToObject for cases where object can not be passed by reference. The returned object must be assigned to object (property, list element, etc.) to which data is copied. More...
 
static void CopyListToObject< DtoType, ObjectType > (DtoType[] tabDto, ref List< ObjectType > listObj)
 Copies array of DTOs (Data Transfer Objects) to a list of appropriate objects. More...
 
static DtoType[] CopyListFromObjectReturned< DtoType, ObjectType > (List< ObjectType > tabObj, DtoType[] tabDto)
 Replacement for CopyArrayFromObject for cases where object can not be passed by reference. The returned object must be assigned to object (property, list element, etc.) to which data is copied. More...
 
static void CopyListFromObject< DtoType, ObjectType > (List< ObjectType > tabObj, ref DtoType[] tabDto)
 Copies array of objects to a list of DTOs. More...
 
- Protected Attributes inherited from IG.Lib.SerializationDtoBase< Type, BaseType >
bool _isNull = false
 
- Properties inherited from IG.Lib.SerializationDtoBase< Type, BaseType >
object Lock [get]
 This object's central lock object to be used by other object. Do not use this object for locking in class' methods, for this you should use InternalLock. More...
 
- Properties inherited from IG.Lib.ILockable
object Lock [get]
 

Detailed Description

Settings for classes that inherit from SimJMatProFileManagerBase class.

Type Constraints
FmType :SimJMatProFileManagerBase 

Member Function Documentation

override void IG.Lib.SimJMatProSettingsDto< FmType >.CopyFromPlain ( SimJMatProFileManagerBase  fm)
inlineprotected

Copies the specified training limits to the current DTO.

Parameters
fmObject that is copied to the current DTO.
override void IG.Lib.SimJMatProSettingsDto< FmType >.CopyToPlain ( ref SimJMatProFileManagerBase  fm)
inlineprotected

Copies contents of the current DTO to the specified training limits object.

Parameters
fmObject that the current DTO content is copied to.

Member Data Documentation

string IG.Lib.SimJMatProSettingsDto< FmType >.IncludedSettingsPath

If specified then setitngs from the specified file are read and set on the JMatPro file manager before the settings from the current object are set.

bool IG.Lib.SimJMatProSettingsDto< FmType >.WorkingDirectory_RestoreFromSettings = false

Specifies whether JMatPro interface' working directory should be stored with settings or not. If false then working directory will not copied form the setting object to the interface' file manager object (which is of type SimJMatProFileManagerBase or derived type) when calling the CopyToPlain or CopyTo method.

string IG.Lib.SimJMatProSettingsDto< FmType >.WorkingDirectory

Working directory of the JMatPro interface.

string IG.Lib.SimJMatProSettingsDto< FmType >.DataDefinitionJMatFilename

Name of the file containing data definition for all JMatPro input parameters (i.e. material composition expressed as mass fractions for individual parameters).

string IG.Lib.SimJMatProSettingsDto< FmType >.DataDefinitionJMatFilePath

Path to the file containing data definition for all JMatPro input parameters (i.e. material composition expressed as mass fractions for individual parameters).

string IG.Lib.SimJMatProSettingsDto< FmType >.DataDefinitionProcessFilename

Name of the file containing data definition for all process input and output parameters.

string IG.Lib.SimJMatProSettingsDto< FmType >.DataDefinitionProcessFilePath

Path to the file containing data definition for all process input and output parameters.

string IG.Lib.SimJMatProSettingsDto< FmType >.DataDefinitionJointFilename

Name of the file containing definition data for the superset of all input parameters and output values.

This incluses definition of material parameters (i.e. composition expressed by mass fractions) followed by process parameters.

string IG.Lib.SimJMatProSettingsDto< FmType >.DataDefinitionJointFilePath

Path to the file containing definition data for the Joint of all input parameters and output values.

This incluses definition of material parameters (i.e. composition expressed by mass fractions) followed by process parameters.

string IG.Lib.SimJMatProSettingsDto< FmType >.WorkingMaterialParametersPath

File path of the file in working directory where material parameters for calculation are stored. If set to null then path is set to null and will be recalculated when getter is called.

string IG.Lib.SimJMatProSettingsDto< FmType >.RootDataDirectoryName

Name of the root data directory.

string IG.Lib.SimJMatProSettingsDto< FmType >.RootDataDirectoryPath

Path to the root directory that contains directories with calculated material data for different parameters defining chemical compositions.

string IG.Lib.SimJMatProSettingsDto< FmType >.LogFileName

Name of the log file where operations are logged.

string IG.Lib.SimJMatProSettingsDto< FmType >.LogFilePath

Path to the log file where basic operations are logged.

string IG.Lib.SimJMatProSettingsDto< FmType >.MaterialDataDirectoryPath

Data directory for the current material parameters.

string IG.Lib.SimJMatProSettingsDto< FmType >.MaterialParametersFilename

Name of the file in material data directory where material parameters are stored.

string IG.Lib.SimJMatProSettingsDto< FmType >.MaterialParametersPath

File path of the file where material parameters are stored. If set to null then path is set to null and will be recalculated when getter is called.

string IG.Lib.SimJMatProSettingsDto< FmType >.MaterialCompositionFilename

Name of the file in material data directory where material composition is stored.

string IG.Lib.SimJMatProSettingsDto< FmType >.MaterialCompositionPath

File path of the file (normally in the material data directory) where material composition is stored. If set to null then path is set to null and will be recalculated when getter is called.

string IG.Lib.SimJMatProSettingsDto< FmType >.MaterialResultsFilename

Name of the file in material data directory where material results are stored.

string IG.Lib.SimJMatProSettingsDto< FmType >.MaterialResultsPath

File path of the file (normally in the material data directory) where material reslts are stored. If set to null then path is set to null and will be recalculated when getter is called.

string IG.Lib.SimJMatProSettingsDto< FmType >.NameJMatProBase

Name of the JMatPro directory (without root directories) and executable.

string IG.Lib.SimJMatProSettingsDto< FmType >.JMatInstallationPath

Path of the directory where JMAtPro is installed. Setter takes only pure directory name, without path information. If set to null then directory path is set to null and will be recalculated when getter is called.

string IG.Lib.SimJMatProSettingsDto< FmType >.JMatExecutableFileName

JMatPro executable relative path to installation directory.

string IG.Lib.SimJMatProSettingsDto< FmType >.JMatExecutableFilePath

Path to the JMatPro executable.

string IG.Lib.SimJMatProSettingsDto< FmType >.JMatDataPath

Path to the JMatPro data directory (containing material data, input and output data, etc.)

By default, this path is just set to installation path (in version 4.0, all data is stored in installation directory).

string IG.Lib.SimJMatProSettingsDto< FmType >.JMatCompositionFilename

Relative path, with respect to JMatPro data directory, of the file containing material composition (input for JMatPro calculation).

string IG.Lib.SimJMatProSettingsDto< FmType >.JMatCompositionFilePath

Path of the file containing material composition (input for JMatPro calculation).

string IG.Lib.SimJMatProSettingsDto< FmType >.JMatResultsFilename

Relative path, with respect to JMatPro data directory, of the file containing material results of JMatPro calculation.

string IG.Lib.SimJMatProSettingsDto< FmType >.JMatResultsFilePath

Path of the file containing results of JMatPro calculation.

int IG.Lib.SimJMatProSettingsDto< FmType >.JMatResultsMinimalSize = 0

Minimal size of the result file, used to verify validity of results.

int IG.Lib.SimJMatProSettingsDto< FmType >.JMatResultsGoodSize = 0

Size of the materials result file that is considered a good size - the file should be at least of this size if calculation was performed without errors.

string IG.Lib.SimJMatProSettingsDto< FmType >.JMatCompletionDetectionFilename

Relative path, with respect to JMatPro data directory, of the file used to detect whether calculation is still going on.

string IG.Lib.SimJMatProSettingsDto< FmType >.JMatCompletionDetectionFilePath

Path of the file used to detect whether calculation is still going on.

double IG.Lib.SimJMatProSettingsDto< FmType >.JMatCompletionDetectionSleepTimeSeconds

Sleeping time used in detectiong whether JMatPro calculation is still going on.

int IG.Lib.SimJMatProSettingsDto< FmType >.JMatCompletionDetectionSize

Minimal size of calculation detection file above which calculation is considered finished.

double IG.Lib.SimJMatProSettingsDto< FmType >.JMatBeforeSaveSleepTimeSeconds = 3.5

Waiting time (in seconds) after last increase in file size used before thinking that calculation is finished, to eventually prevent too early detection that calculation was finished.

double IG.Lib.SimJMatProSettingsDto< FmType >.JMatTimeoutWaitCalculationSeconds

Timeout for waiting completion of calculation, in seconds.

If greater than 0 and results of calculation are waiter for more time than the timeout specifies, waiting is broken and it is considered that calculation could not be completed.

double IG.Lib.SimJMatProSettingsDto< FmType >.JMatTimeoutWaitResultsSavedSeconds

Timeout for waiting until results are completely saved, in seconds.

If greater than 0 and saving results is waited for more time than the timeout specifies, waiting is broken and it is considered that saving could not be completed.

int IG.Lib.SimJMatProSettingsDto< FmType >.JMatResultsSavedDetectionSize

Minimal size of result file file, above which saving results can be considered finished.

double IG.Lib.SimJMatProSettingsDto< FmType >.JMatBeforeResultsSavedSleepTimeSeconds

Waiting time (in seconds) after last increase in file size used before assuming that saving result is finished, to eventually prevent too early detection that calculation was finished.

string IG.Lib.SimJMatProSettingsDto< FmType >.UserInteractionCommand

Command for playback of recorded user interaction (i.e. emulation of keyboard and mouse events) for various actions.

string IG.Lib.SimJMatProSettingsDto< FmType >.UserInteractionRecordDir

Dierctory containing recorded user interactions for different actions.

string IG.Lib.SimJMatProSettingsDto< FmType >.UserInteractionRecordExtension

Extension of files with recorded user interaction.

string IG.Lib.SimJMatProSettingsDto< FmType >.UserInteractionRecordNameStartJMat

Name of the user interaction record for starting JMatPro software via Windows GUI.

string IG.Lib.SimJMatProSettingsDto< FmType >.UserInteractionRecordPathStartJMat

Path to the user interaction record for starting JMatPro software via Windows GUI.

string IG.Lib.SimJMatProSettingsDto< FmType >.UserInteractionRecordNameCloseJMat

Name of the user interaction record for closing JMatPro software normally via GUI.

string IG.Lib.SimJMatProSettingsDto< FmType >.UserInteractionRecordPathCloseJMat

Path to the user interaction record for closing JMatPro software normally via GUI.

string IG.Lib.SimJMatProSettingsDto< FmType >.UserInteractionRecordNameRepairJMat

Name of the user interaction record for repairing JMatPro software.

string IG.Lib.SimJMatProSettingsDto< FmType >.UserInteractionRecordPathRepairJMat

Path to the user interaction record for repairing JMatPro software.

string IG.Lib.SimJMatProSettingsDto< FmType >.UserInteractionRecordNameStartCalculation

Name of the file containing recors of user interaction necessary to start JMatPro.

string IG.Lib.SimJMatProSettingsDto< FmType >.UserInteractionRecordPathStartCalculation

Name of the file containing recors of user interaction necessary to start JMatPro.

string IG.Lib.SimJMatProSettingsDto< FmType >.UserInteractionRecordNameSaveResults

Name of the file containing records of user interaction necessary to save results of JMatPro calculation.

string IG.Lib.SimJMatProSettingsDto< FmType >.UserInteractionRecordPathSaveResults

Path to the file containing recors of user interaction necessary to save results of JMatPro calculation.

string IG.Lib.SimJMatProSettingsDto< FmType >.UserInteractionRecordNameChangeTemperatureUnit

Name of the file containing records of user interaction necessary to change temperature uits in JMatPro that is already launched.

string IG.Lib.SimJMatProSettingsDto< FmType >.UserInteractionRecordPathChangeTemperatureUnit

Path to the file containing recors of user interaction necessary to change temperature uits in JMatPro that is already launched.

string IG.Lib.SimJMatProSettingsDto< FmType >.UserInteractionRecordNameChangeFractionUnit

Name of the file containing records of user interaction necessary to change fraction uits in JMatPro that is already launched.

string IG.Lib.SimJMatProSettingsDto< FmType >.UserInteractionRecordPathChangeFractionUnit

Path to the file containing recors of user interaction necessary to change fraction uits in JMatPro that is already launched.


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