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.Num.SimJMatProFileManagerBase.JMatResultInfo Class Reference

Class for checking and obtaining information about JMatPro results. More...

Public Member Functions

 JMatResultInfo (string jMatResultFilePath)
 Constructor. More...
 
virtual bool ElementExists (int row, int column)
 Whether the specified element (identified by row and column number) exists in the result table. More...
 
virtual string GetElement (int row, int column)
 Returns the specified element (identified by row and column number) of the result table. More...
 
virtual string GetElement (int row, int column, bool throwExceptions)
 Returns the specified element (identified by row and column number) of the result table. More...
 
virtual double GetDoubleElement (int row, int column, double defaultValue)
 Returns the numerical value of the specified element (identified by row and column number) of the result table. More...
 
virtual double GetDoubleElement (int row, int column)
 Returns the numerical value of the specified element (identified by row and column number) of the result table. More...
 
virtual double GetDoubleElement (int row, int column, double defaultValue, bool throwExceptions, out bool isProperlyDefined)
 Returns the numerical value of the specified element (identified by row and column number) of the result table. More...
 
override string ToString ()
 Returns string representation of the current object. More...
 

Protected Attributes

FileInfo _resultFileInfo
 
string[][] _csvTable
 
string _dataErrors
 
int _numRowsContainingData =-1
 
int _numColumns = -1
 
int _numColumnsInLastRow = -1
 
string _temperatureUnit
 
string _fractionUnit
 
double _highestTemperature
 
double _lowestTemperature
 

Properties

virtual string CsvSeparator [get]
 Separator in delimited text format in result file. More...
 
virtual int TemperatureColumn [get]
 Colum number for temperatures. More...
 
virtual int LiquidPhaseColumn [get]
 Column number for liquid fraction. More...
 
virtual int AustenitePhaseColumn [get]
 Column number for austenite. More...
 
virtual string TemperatureUnitKelvin [get]
 String represention of degrees Kelvin (temperature unit). More...
 
virtual string TemperatureUnitCelsius [get]
 String represention of degrees centigrate (temperature unit). More...
 
virtual string TemperatureUnitFahrenheit [get]
 String represention of degrees Fahrenheit (temperature unit). More...
 
virtual string CorrectTemperatureUnit [get]
 Temperature unit that must be used. More...
 
virtual string FractionUnitWeightPercent [get]
 String representation of fraction expressed in weight per cent (mass percent). More...
 
virtual string FractionUnitAtomicPercent [get]
 String representation of fraction expressed in atomix per cent (mass percent). More...
 
virtual string CorrectFractionUnit [get]
 Concentration unit used for fractions of components and phases. More...
 
virtual double CorrectHighestTemperature [get]
 Correct value for the highest temperature listed in the file in order to be usable for simulator. More...
 
virtual double CorrectLowestTemperature [get]
 Correct value for the lowest temperature listed in the file in order to be usable for simulator. More...
 
FileInfo ResultFileInfo [get, private set]
 File info for JMatPro result file. More...
 
string ResultFilePath [get]
 Full path to the JMatPro result file. More...
 
virtual string[][] CsvTable [get]
 Table obtained by considering the result file as CSV file (actually, tab delimited). More...
 
bool IsDataCorrect [get]
 Returns true if material data analysed by the current object is correct, false otherwise. More...
 
string DataErrorDescriptions [get]
 Strings that contain descriptions of all errors detected in data. More...
 
virtual int NumRowsContainingData [get]
 Number of rows in the table of results from the result file that contain data. More...
 
virtual int NumColumns [get]
 Number of columns in the table of results from the result file (obtained as the number of columns in the first line). More...
 
virtual int NumColumnsInLastRow [get]
 Gets the number of columns in the last row that contains data. More...
 
virtual bool IsLastRowIncomplete [get]
 Whether the last row is incomplete. More...
 
virtual string TemperatureUnit [get]
 Temperature unit used in the result file. More...
 
virtual string FractionUnit [get]
 Fraction unit used in the result file (usually "wt%" or "at%"). More...
 
virtual bool IsTemperatureUnitCorrect [get]
 Whether the temperature unit in the result file is correct (correct uit is contained in property CorrectTemperatureUnit). More...
 
virtual bool IsTemperatureUnitCelsius [get]
 Whether the temperature unit in the result file is degree Celsius. More...
 
virtual bool IsTemperatureUnitKelvin [get]
 Whether the temperature unit in the result file is degree Kelvin. More...
 
virtual bool IsTemperatureUnitFahrenheit [get]
 Whether the te mperature unit in the result file is degree Fahrenheit. More...
 
virtual bool IsFractionUnitCorrect [get]
 Whether the fraction unit in the result file is correct (correct uit is contained in property CorrectFractionUnit). More...
 
virtual bool IsFractionUnitWeightPercent [get]
 Whether phase fractions are expressed in weight percent. More...
 
virtual bool IsFractionUnitAtomicPercent [get]
 Whether phase fractions are expressed in atomic percent. More...
 
virtual double HighestTemperature [get]
 Highest temperature for which there is data in the result file. More...
 
virtual double LowestTemperature [get]
 Highest temperature for which there is data in the result file. More...
 
virtual double LowestLiquidTemperature [get]
 Returns the lowest temperature where liquid phase is present. More...
 
virtual double HighestSolidTemperature [get]
 Returns the highest temperature where solid phase is present. More...
 

Private Member Functions

 JMatResultInfo ()
 

Detailed Description

Class for checking and obtaining information about JMatPro results.

Constructor & Destructor Documentation

IG.Num.SimJMatProFileManagerBase.JMatResultInfo.JMatResultInfo ( )
inlineprivate
IG.Num.SimJMatProFileManagerBase.JMatResultInfo.JMatResultInfo ( string  jMatResultFilePath)
inline

Constructor.

Parameters
jMatResultFilePathPath to the JMatPro result file for which validation/information object is created.

Member Function Documentation

virtual bool IG.Num.SimJMatProFileManagerBase.JMatResultInfo.ElementExists ( int  row,
int  column 
)
inlinevirtual

Whether the specified element (identified by row and column number) exists in the result table.

Parameters
rowRow number.
columnColumn number.
virtual string IG.Num.SimJMatProFileManagerBase.JMatResultInfo.GetElement ( int  row,
int  column 
)
inlinevirtual

Returns the specified element (identified by row and column number) of the result table.

If throwExceptions is true and the specified element does not exist then exception is thrown.

Parameters
rowRow number of the element.
columnColumn number of the element.
throwExceptionsWhether to throw an exception when row and column are out of range.
virtual string IG.Num.SimJMatProFileManagerBase.JMatResultInfo.GetElement ( int  row,
int  column,
bool  throwExceptions 
)
inlinevirtual

Returns the specified element (identified by row and column number) of the result table.

If throwExceptions is true and the specified element does not exist then exception is thrown.

Parameters
rowRow number of the element.
columnColumn number of the element.
throwExceptionsWhether to throw an exception when row and column are out of range.
virtual double IG.Num.SimJMatProFileManagerBase.JMatResultInfo.GetDoubleElement ( int  row,
int  column,
double  defaultValue 
)
inlinevirtual

Returns the numerical value of the specified element (identified by row and column number) of the result table.

If there is no element with specified row and column number, or it does not represent a number, then default value is returned.

Parameters
rowRow number of the element.
columnColumn number of the element.
defaultValueDefault value that is returned in the case that the element does not exist or is not a double number (if exceptions are not thrown).
virtual double IG.Num.SimJMatProFileManagerBase.JMatResultInfo.GetDoubleElement ( int  row,
int  column 
)
inlinevirtual

Returns the numerical value of the specified element (identified by row and column number) of the result table.

If there is no element with specified row and column number, or it does not represent a number, then exception is thrown.

Parameters
rowRow number of the element.
columnColumn number of the element.
virtual double IG.Num.SimJMatProFileManagerBase.JMatResultInfo.GetDoubleElement ( int  row,
int  column,
double  defaultValue,
bool  throwExceptions,
out bool  isProperlyDefined 
)
inlinevirtual

Returns the numerical value of the specified element (identified by row and column number) of the result table.

If throwExceptions is true and the specified element does not exist or is not a double number then exception is thrown.

Parameters
rowRow number of the element.
columnColumn number of the element.
defaultValueDefault value that is returned in the case that the element does not exist or is not a double number (if exceptions are not thrown).
throwExceptionsWhether to throw an exception when row and column are out of range.
isProperlyDefinedBecomes true if the specified element exists and it actually is a number, false otherwise.
override string IG.Num.SimJMatProFileManagerBase.JMatResultInfo.ToString ( )
inline

Returns string representation of the current object.

Referenced by IG.Num.SimJMatProFileManagerBase.CalculateMaterialProperties().

Member Data Documentation

FileInfo IG.Num.SimJMatProFileManagerBase.JMatResultInfo._resultFileInfo
protected
string [][] IG.Num.SimJMatProFileManagerBase.JMatResultInfo._csvTable
protected
string IG.Num.SimJMatProFileManagerBase.JMatResultInfo._dataErrors
protected
int IG.Num.SimJMatProFileManagerBase.JMatResultInfo._numRowsContainingData =-1
protected
int IG.Num.SimJMatProFileManagerBase.JMatResultInfo._numColumns = -1
protected
int IG.Num.SimJMatProFileManagerBase.JMatResultInfo._numColumnsInLastRow = -1
protected
string IG.Num.SimJMatProFileManagerBase.JMatResultInfo._temperatureUnit
protected
string IG.Num.SimJMatProFileManagerBase.JMatResultInfo._fractionUnit
protected
double IG.Num.SimJMatProFileManagerBase.JMatResultInfo._highestTemperature
protected
double IG.Num.SimJMatProFileManagerBase.JMatResultInfo._lowestTemperature
protected

Property Documentation

virtual string IG.Num.SimJMatProFileManagerBase.JMatResultInfo.CsvSeparator
get

Separator in delimited text format in result file.

virtual int IG.Num.SimJMatProFileManagerBase.JMatResultInfo.TemperatureColumn
get

Colum number for temperatures.

virtual int IG.Num.SimJMatProFileManagerBase.JMatResultInfo.LiquidPhaseColumn
get

Column number for liquid fraction.

virtual int IG.Num.SimJMatProFileManagerBase.JMatResultInfo.AustenitePhaseColumn
get

Column number for austenite.

virtual string IG.Num.SimJMatProFileManagerBase.JMatResultInfo.TemperatureUnitKelvin
get

String represention of degrees Kelvin (temperature unit).

virtual string IG.Num.SimJMatProFileManagerBase.JMatResultInfo.TemperatureUnitCelsius
get

String represention of degrees centigrate (temperature unit).

virtual string IG.Num.SimJMatProFileManagerBase.JMatResultInfo.TemperatureUnitFahrenheit
get

String represention of degrees Fahrenheit (temperature unit).

virtual string IG.Num.SimJMatProFileManagerBase.JMatResultInfo.CorrectTemperatureUnit
get

Temperature unit that must be used.

virtual string IG.Num.SimJMatProFileManagerBase.JMatResultInfo.FractionUnitWeightPercent
get

String representation of fraction expressed in weight per cent (mass percent).

virtual string IG.Num.SimJMatProFileManagerBase.JMatResultInfo.FractionUnitAtomicPercent
get

String representation of fraction expressed in atomix per cent (mass percent).

virtual string IG.Num.SimJMatProFileManagerBase.JMatResultInfo.CorrectFractionUnit
get

Concentration unit used for fractions of components and phases.

virtual double IG.Num.SimJMatProFileManagerBase.JMatResultInfo.CorrectHighestTemperature
get

Correct value for the highest temperature listed in the file in order to be usable for simulator.

virtual double IG.Num.SimJMatProFileManagerBase.JMatResultInfo.CorrectLowestTemperature
get

Correct value for the lowest temperature listed in the file in order to be usable for simulator.

FileInfo IG.Num.SimJMatProFileManagerBase.JMatResultInfo.ResultFileInfo
getprivate set

File info for JMatPro result file.

string IG.Num.SimJMatProFileManagerBase.JMatResultInfo.ResultFilePath
get

Full path to the JMatPro result file.

virtual string [][] IG.Num.SimJMatProFileManagerBase.JMatResultInfo.CsvTable
get

Table obtained by considering the result file as CSV file (actually, tab delimited).

bool IG.Num.SimJMatProFileManagerBase.JMatResultInfo.IsDataCorrect
get

Returns true if material data analysed by the current object is correct, false otherwise.

Referenced by IG.Num.SimJMatProFileManagerBase.CalculateMaterialProperties().

string IG.Num.SimJMatProFileManagerBase.JMatResultInfo.DataErrorDescriptions
get

Strings that contain descriptions of all errors detected in data.

Referenced by IG.Num.SimJMatProFileManagerBase.CalculateMaterialProperties().

virtual int IG.Num.SimJMatProFileManagerBase.JMatResultInfo.NumRowsContainingData
get

Number of rows in the table of results from the result file that contain data.

More precisely, returned is the number of rows (including the title row) until the last row (inclusively) that contains a temperature in the first column.

Rows that do not have a number in the first (temperature) column can not be considered counted as last rows.

virtual int IG.Num.SimJMatProFileManagerBase.JMatResultInfo.NumColumns
get

Number of columns in the table of results from the result file (obtained as the number of columns in the first line).

virtual int IG.Num.SimJMatProFileManagerBase.JMatResultInfo.NumColumnsInLastRow
get

Gets the number of columns in the last row that contains data.

The last row is identified as the last row that contains (nonempty) data in the first column.

virtual bool IG.Num.SimJMatProFileManagerBase.JMatResultInfo.IsLastRowIncomplete
get

Whether the last row is incomplete.

virtual string IG.Num.SimJMatProFileManagerBase.JMatResultInfo.TemperatureUnit
get

Temperature unit used in the result file.

virtual string IG.Num.SimJMatProFileManagerBase.JMatResultInfo.FractionUnit
get

Fraction unit used in the result file (usually "wt%" or "at%").

virtual bool IG.Num.SimJMatProFileManagerBase.JMatResultInfo.IsTemperatureUnitCorrect
get

Whether the temperature unit in the result file is correct (correct uit is contained in property CorrectTemperatureUnit).

Referenced by IG.Num.SimJMatProFileManagerBase.CalculateMaterialProperties().

virtual bool IG.Num.SimJMatProFileManagerBase.JMatResultInfo.IsTemperatureUnitCelsius
get

Whether the temperature unit in the result file is degree Celsius.

virtual bool IG.Num.SimJMatProFileManagerBase.JMatResultInfo.IsTemperatureUnitKelvin
get

Whether the temperature unit in the result file is degree Kelvin.

Referenced by IG.Num.SimJMatProFileManagerBase.CalculateMaterialProperties().

virtual bool IG.Num.SimJMatProFileManagerBase.JMatResultInfo.IsTemperatureUnitFahrenheit
get

Whether the te mperature unit in the result file is degree Fahrenheit.

virtual bool IG.Num.SimJMatProFileManagerBase.JMatResultInfo.IsFractionUnitCorrect
get

Whether the fraction unit in the result file is correct (correct uit is contained in property CorrectFractionUnit).

Referenced by IG.Num.SimJMatProFileManagerBase.CalculateMaterialProperties().

virtual bool IG.Num.SimJMatProFileManagerBase.JMatResultInfo.IsFractionUnitWeightPercent
get

Whether phase fractions are expressed in weight percent.

virtual bool IG.Num.SimJMatProFileManagerBase.JMatResultInfo.IsFractionUnitAtomicPercent
get

Whether phase fractions are expressed in atomic percent.

virtual double IG.Num.SimJMatProFileManagerBase.JMatResultInfo.HighestTemperature
get

Highest temperature for which there is data in the result file.

virtual double IG.Num.SimJMatProFileManagerBase.JMatResultInfo.LowestTemperature
get

Highest temperature for which there is data in the result file.

virtual double IG.Num.SimJMatProFileManagerBase.JMatResultInfo.LowestLiquidTemperature
get

Returns the lowest temperature where liquid phase is present.

virtual double IG.Num.SimJMatProFileManagerBase.JMatResultInfo.HighestSolidTemperature
get

Returns the highest temperature where solid phase is present.


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