C++ main module for emicrom Package  1.0
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
CORE_Out Class Reference

this class describes the output by default write on standart output More...

#include <CORE_Out.h>

Inheritance diagram for CORE_Out:
Inheritance graph
[legend]
Collaboration diagram for CORE_Out:
Collaboration graph
[legend]

Public Member Functions

 CORE_Out ()
 build a CORE_Out More...
 
virtual ~CORE_Out (void)
 destroy a CORE_Out More...
 
void setVerbose (const tFlag &f)
 set the type of verbose of the int conversion of the binary form CDWE More...
 
void setVerbose (const tString &f)
 set the type of verbose CDWE More...
 
void setOutput (const tFlag &type)
 set outputType of the int conversion of the binary form : SFO More...
 
void setOutput (const tString &type)
 set outputType of the form : "SFO" More...
 
void setOutputBit (const tUChar &index, const tBoolean &v)
 set only the bit value at index to v of the output type More...
 
void backup ()
 backup the output More...
 
void restore ()
 restore the ouput from the last backup More...
 
void reset ()
 reset the output More...
 
void setOutputFile (const tString &fileName, const tFlag &mode)
 set output file More...
 
void setOutputFile (const tString &fileName)
 set output file More...
 
void update ()
 update the output More...
 
tBoolean isVerbose (const tFlag &type)
 return true if the printed type is type More...
 
tBoolean isOutput (const tFlag &type)
 return true if the output is selected More...
 
ofstream & getOutputFile ()
 get output More...
 
const tFlaggetOutput ()
 get output type More...
 
tString getOutputFileName () const
 get the output file name More...
 
tString getOutputString () const
 get the output string More...
 
tString str () const
 get the output string More...
 
virtual void printInt (const tInteger &i)
 print an integer More...
 
virtual void printString (const tString &message)
 print a string More...
 
virtual void print (const tFlag &type, const tString &message)
 print a string More...
 
virtual void println (const tFlag &type, const tString &message)
 print the message with an end of line More...
 
virtual void print (const tString &message)
 print a string More...
 
virtual void println (const tString &message)
 print a string and an end of line More...
 
virtual void printTime (const tFlag &type)
 print time More...
 
void printTime ()
 print time More...
 
virtual void abort ()
 abort the process More...
 
tBoolean isAborting () const
 abort More...
 
virtual void printArgs (const tFlag &type, const vector< tString > &args)
 print args More...
 
virtual void ask (const tString &question, tString &ret)
 ask a question More...
 
virtual void ask (const tString &question, tInteger &ret)
 ask a question More...
 
virtual CORE_OutgenericPrint (const tFlag &type, const CORE_Object &obj)
 print Operators More...
 
virtual CORE_OutgenericPrint (const tFlag &type, const tString &obj)
 print Operators More...
 
virtual CORE_OutgenericPrint (const tFlag &type, const tBoolean &obj)
 print Operators More...
 
virtual CORE_OutgenericPrint (const tFlag &type, const tChar &obj)
 print Operators More...
 
virtual CORE_OutgenericPrint (const tFlag &type, const tChar *obj)
 print Operators More...
 
virtual CORE_OutgenericPrint (const tFlag &type, const tUChar &obj)
 print Operators More...
 
virtual CORE_OutgenericPrint (const tFlag &type, const tSInt &obj)
 print Operators More...
 
virtual CORE_OutgenericPrint (const tFlag &type, const tUSInt &obj)
 print Operators More...
 
virtual CORE_OutgenericPrint (const tFlag &type, const tInt &obj)
 print Operators More...
 
virtual CORE_OutgenericPrint (const tFlag &type, const tUInt &obj)
 print Operators More...
 
virtual CORE_OutgenericPrint (const tFlag &type, const tLInt &obj)
 print Operators More...
 
virtual CORE_OutgenericPrint (const tFlag &type, const tULInt &obj)
 print Operators More...
 
virtual CORE_OutgenericPrint (const tFlag &type, const tLLInt &obj)
 print Operators More...
 
virtual CORE_OutgenericPrint (const tFlag &type, const tULLInt &obj)
 print Operators More...
 
virtual CORE_OutgenericPrint (const tFlag &type, const tFloat &obj)
 print Operators More...
 
virtual CORE_OutgenericPrint (const tFlag &type, const tDouble &obj)
 print Operators More...
 
virtual CORE_OutgenericPrint (const tFlag &type, const tLDouble &obj)
 print Operators More...
 
virtual CORE_OutgenericPrint (const tFlag &type, const tFComplex &obj)
 print Operators More...
 
virtual CORE_OutgenericPrint (const tFlag &type, const tDComplex &obj)
 print Operators More...
 
virtual CORE_OutgenericPrint (const tFlag &type, const tLDComplex &obj)
 print Operators More...
 
virtual tString toString () const
 return the string representation of the class More...
 
void getSharedPointer (SP::CORE_Object &p)
 get the shared pointer of this class into p More...
 
void getSharedPointer (SPC::CORE_Object &p) const
 get the shared pointer of this class into p More...
 
tString getClassName () const
 return the class name of the object More...
 
tString getIdentityString () const
 return the identity string of the object of the form className_at_address More...
 
tString getPointerAddress () const
 return the identity string of the object More...
 
template<class T >
tBoolean isInstanceOf () const
 test if the clas T is an instance of this class More...
 
tBoolean isInstanceOf (const tString &name) const
 test if the object is an instance of className More...
 

Static Public Member Functions

static SP::CORE_Out New ()
 create a CORE_out class : no output by default More...
 
static SP::CORE_Out New (const tString &outputType)
 create a CORE_out class on string,file or/and std outputs More...
 
static SP::CORE_Out New (const tFlag &outputType)
 create a CORE_out class on string,file or/and std outputs More...
 
static void setPrintedType (const tFlag &type)
 set the type of message to print More...
 
static const tFlaggetPrintedType ()
 get the default printed type of message to print More...
 
static tString getTime ()
 get time More...
 
static void setIsMemoryChecked (const tBoolean &v)
 set if the memory checking is used More...
 
static void setOut (SP::CORE_Out out)
 set the output stream More...
 
static void resetOut ()
 reset the output stream More...
 
static void setThread (SP::CORE_Thread thread)
 set the thread More...
 
static void resetThread ()
 reset the output stream More...
 
static CORE_Outout ()
 get the output More...
 
static SP::CORE_Out getOut ()
 get the output More...
 
static CORE_ThreadgetThread ()
 get the profilier More...
 
static const tBooleanisMemoryChecked ()
 get if the memory checking is used More...
 
static tString getClassName (const tString &identityString)
 return the class name of the object More...
 
template<class T >
static tString getTypeName ()
 get type name More...
 
static tBoolean is64Architecture ()
 return true if the machine is a 64 bits machine More...
 
static tBoolean is32Architecture ()
 return true if the machine is a 32 bits machine More...
 
static tString pointer2String (const void *obj)
 return the string representation of a pointer More...
 
static void printObjectsInMemory (ostream &f)
 print object in memory More...
 
static void printObjectsInMemory ()
 print object in memory in the standart output More...
 
static tChar getMaxChar ()
 get the max value for tChar type More...
 
static tChar getMinChar ()
 get the min value for tChar type More...
 
static tUChar getMaxUChar ()
 get the max value for tUChar type More...
 
static tUChar getMinUChar ()
 get the min value for tUChar type More...
 
static tSInt getMaxSInt ()
 get the max value for tSInt type More...
 
static tSInt getMinSInt ()
 get the min value for tSInt type More...
 
static tUSInt getMaxUSInt ()
 get the max value for tUSInt type More...
 
static tUSInt getMinUSInt ()
 get the min value for tUSInt type More...
 
static tInt getMaxInt ()
 get the max value for tInt type More...
 
static tInt getMinInt ()
 get the min value for tInt type More...
 
static tUInt getMaxUInt ()
 get the max value for tUInt type More...
 
static tUInt getMinUInt ()
 get the min value for tUInt type More...
 
static tLInt getMaxLInt ()
 get the max value for tLInt type More...
 
static tLInt getMinLInt ()
 get the min value for tLInt type More...
 
static tULInt getMaxULInt ()
 get the max value for tULInt type More...
 
static tULInt getMinULInt ()
 get the min value for tULInt type More...
 
static tLLInt getMaxLLInt ()
 get the max value for tULInt type More...
 
static tLLInt getMinLLInt ()
 get the min value for tLLInt type More...
 
static tULLInt getMaxULLInt ()
 get the max value for tULLInt type More...
 
static tULLInt getMinULLInt ()
 get the min value for tULLInt type More...
 
static tFloat getMaxFloat ()
 get the max value for tFloat type More...
 
static tFloat getMinFloat ()
 get the min value for tFloat type More...
 
template<class T >
static T getEpsilon ()
 get the epsilon value for T type More...
 
template<class T >
static T getInfinity ()
 get the infinity for T type More...
 
static tFloat getFloatEpsilon ()
 get the epsilon value for tFloat type More...
 
static tFloat getFloatInfinity ()
 get the infinity value for tFloat type More...
 
static tDouble getMaxDouble ()
 get the max value for tDouble type More...
 
static tDouble getMinDouble ()
 get the min value for tDouble type More...
 
static tDouble getDoubleInfinity ()
 get the infinity value for tFloat type More...
 
static tDouble getDoubleEpsilon ()
 get the epsilon value for tDouble type More...
 
static tLDouble getMinLDouble ()
 get the min value for tLDouble type More...
 
static tLDouble getMaxLDouble ()
 get the max value for tLDouble type More...
 
static tLDouble getLDoubleEpsilon ()
 get the epsilon value for tLDouble type More...
 
static tDouble getLDoubleInfinity ()
 get the infinity value for tDouble type More...
 
static tIndex getMaxIndex ()
 get the max value for the array/vector indexing type More...
 
static tIndex getMinIndex ()
 get the min value for the array/vector indexing type More...
 
static tUIndex getMaxUIndex ()
 get the max value for difference the array/vector indexing type More...
 
static tUIndex getMinUIndex ()
 get the min value for difference the array/vector indexing type More...
 
static tFlag getMaxFlag ()
 get the max value for the tFlag type More...
 
static tFlag getMinFlag ()
 get the min value for the tFlag type More...
 
static tUInteger getMaxUInteger ()
 get the max value for the unsigned integer type More...
 
static tUInteger getMinUInteger ()
 get the min value for the unsigned integer type More...
 
static tInteger getMaxInteger ()
 get the max value for the integer type More...
 
static tInteger getMinInteger ()
 get the min value for the integer type More...
 
static tReal getMaxReal ()
 get the max value for the real type More...
 
static tReal getMinReal ()
 get the min value for the real type More...
 
static tReal getRealEpsilon ()
 get the eps which is the difference between 1 and the least value greater than 1 that is representable. More...
 
static tReal getRealInfinity ()
 get the infinity value More...
 
template<class T >
static T computeEpsilon ()
 compute epsilon More...
 

Static Public Attributes

static const tFlag STRING_OUTPUT =4
 
static const tFlag SCREEN_OUTPUT =1
 
static const tFlag FILE_OUTPUT =2
 
static const tFlag APPEND =1
 
static const tFlag CREATE =0
 
static const tFlag ERROR_MSG =1
 
static const tFlag WARNING_MSG =2
 
static const tFlag DEBUG_MSG =4
 
static const tFlag COMMENT_MSG =8
 
static tBoolean IS_ERROR_MESSAGE_PRINTED_ON_SCREEN =true
 

Protected Member Functions

void setThis (SP::CORE_Object p)
 set this weak shared pointer called toDoAfterThis setting method More...
 
virtual void toDoAfterThisSetting ()
 method called after setThis() method this method can oly be called once. More...
 

Private Member Functions

void release ()
 de-allocate the memory More...
 
void createStreams ()
 
template<class T >
CORE_OuttemplatedPrint (const tFlag &type, const T &str)
 print the msg value for the type in {ERROR_MSG, WARNING_MSG, DEBUG_MSG , COMMENt_MSG} on th eoutput More...
 

Private Attributes

tBoolean mIsAborting
 
tFlag mVerbose
 
tFlag mVerbose_back
 
tFlag mOutput
 
tFlag mOutput_back
 
tFlag mOutputFileMode
 
tString mOutputFileName
 
tFlag mOutputFileMode_back
 
tString mOutputFileName_back
 
ofstream * mOutputFile
 
std::stringstream * mOutputString
 

Static Private Attributes

static tFlag mPrintedType =COMMENT_MSG
 

Friends

CORE_Outoperator<< (CORE_Out &out, const CORE_Object &obj)
 print Operators More...
 
CORE_Outoperator<< (CORE_Out &out, const tString &obj)
 print Operators More...
 
CORE_Outoperator<< (CORE_Out &out, const tBoolean &obj)
 print Operators More...
 
CORE_Outoperator<< (CORE_Out &out, const tChar &obj)
 print Operators More...
 
CORE_Outoperator<< (CORE_Out &out, const tChar *obj)
 print Operators More...
 
CORE_Outoperator<< (CORE_Out &out, const tUChar &obj)
 print Operators More...
 
CORE_Outoperator<< (CORE_Out &out, const tSInt &obj)
 print Operators More...
 
CORE_Outoperator<< (CORE_Out &out, const tUSInt &obj)
 print Operators More...
 
CORE_Outoperator<< (CORE_Out &out, const tInt &obj)
 print Operators More...
 
CORE_Outoperator<< (CORE_Out &out, const tUInt &obj)
 print Operators More...
 
CORE_Outoperator<< (CORE_Out &out, const tLInt &obj)
 print Operators More...
 
CORE_Outoperator<< (CORE_Out &out, const tULInt &obj)
 print Operators More...
 
CORE_Outoperator<< (CORE_Out &out, const tLLInt &obj)
 print Operators More...
 
CORE_Outoperator<< (CORE_Out &out, const tULLInt &obj)
 print Operators More...
 
CORE_Outoperator<< (CORE_Out &out, const tFloat &obj)
 print Operators More...
 
CORE_Outoperator<< (CORE_Out &out, const tDouble &obj)
 print Operators More...
 
CORE_Outoperator<< (CORE_Out &out, const tLDouble &obj)
 print Operators More...
 
CORE_Outoperator<< (CORE_Out &out, const tFComplex &obj)
 print Operators More...
 
CORE_Outoperator<< (CORE_Out &out, const tDComplex &obj)
 print Operators More...
 
CORE_Outoperator<< (CORE_Out &out, const tLDComplex &obj)
 print Operators More...
 

Detailed Description

this class describes the output by default write on standart output

Constructor & Destructor Documentation

◆ CORE_Out()

CORE_Out::CORE_Out ( )

build a CORE_Out

References backup(), CREATE, mIsAborting, mOutput, mOutputFile, mOutputFileMode, mOutputFileName, mOutputString, mVerbose, and SCREEN_OUTPUT.

Referenced by New().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ~CORE_Out()

CORE_Out::~CORE_Out ( void  )
virtual

destroy a CORE_Out

References release().

Here is the call graph for this function:

Member Function Documentation

◆ abort()

virtual void CORE_Out::abort ( )
inlinevirtual

abort the process

◆ ask() [1/2]

void CORE_Out::ask ( const tString question,
tString ret 
)
virtual

ask a question

Parameters
questionquestion to ask
retreturned answer of the question as a string

Referenced by printArgs().

Here is the caller graph for this function:

◆ ask() [2/2]

void CORE_Out::ask ( const tString question,
tInteger ret 
)
virtual

ask a question

Parameters
questionquestion to ask
retreturned answer of the question as an integer

◆ backup()

void CORE_Out::backup ( )

backup the output

References mOutput, mOutput_back, mOutputFileMode, mOutputFileMode_back, mOutputFileName, mOutputFileName_back, mVerbose, and mVerbose_back.

Referenced by CORE_Out(), and setOutput().

Here is the caller graph for this function:

◆ computeEpsilon()

template<class T >
static T CORE_Object::computeEpsilon ( )
inlinestaticinherited

compute epsilon

Returns
the epsilon value eps=10^{-p/3} where p is defined by getEpsilon()=10^{-p}

◆ createStreams()

void CORE_Out::createStreams ( )
private

References APPEND, FILE_OUTPUT, isOutput(), mOutputFile, mOutputFileMode, mOutputFileName, mOutputString, null, and STRING_OUTPUT.

Referenced by setOutput(), setOutputBit(), and update().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ genericPrint() [1/20]

virtual CORE_Out& CORE_Out::genericPrint ( const tFlag type,
const CORE_Object obj 
)
inlinevirtual

print Operators

Parameters
typetype of message to print
objobject to print
Returns
the output stream

References templatedPrint(), and CORE_Object::toString().

Referenced by print(), printInt(), println(), printString(), and printTime().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ genericPrint() [2/20]

virtual CORE_Out& CORE_Out::genericPrint ( const tFlag type,
const tString obj 
)
inlinevirtual

print Operators

Parameters
typetype of message to print
objobject to print
Returns
the output stream

References templatedPrint().

Here is the call graph for this function:

◆ genericPrint() [3/20]

virtual CORE_Out& CORE_Out::genericPrint ( const tFlag type,
const tBoolean obj 
)
inlinevirtual

print Operators

Parameters
typetype of message to print
objobject to print
Returns
the output stream

References CORE_String::boolean2String(), and templatedPrint().

Here is the call graph for this function:

◆ genericPrint() [4/20]

virtual CORE_Out& CORE_Out::genericPrint ( const tFlag type,
const tChar obj 
)
inlinevirtual

print Operators

Parameters
typetype of message to print
objobject to print
Returns
the output stream

References templatedPrint().

Here is the call graph for this function:

◆ genericPrint() [5/20]

virtual CORE_Out& CORE_Out::genericPrint ( const tFlag type,
const tChar obj 
)
inlinevirtual

print Operators

Parameters
typetype of message to print
objobject to print
Returns
the output stream

References templatedPrint().

Here is the call graph for this function:

◆ genericPrint() [6/20]

virtual CORE_Out& CORE_Out::genericPrint ( const tFlag type,
const tUChar obj 
)
inlinevirtual

print Operators

Parameters
typetype of message to print
objobject to print
Returns
the output stream

References templatedPrint().

Here is the call graph for this function:

◆ genericPrint() [7/20]

virtual CORE_Out& CORE_Out::genericPrint ( const tFlag type,
const tSInt obj 
)
inlinevirtual

print Operators

Parameters
typetype of message to print
objobject to print
Returns
the output stream

References templatedPrint().

Here is the call graph for this function:

◆ genericPrint() [8/20]

virtual CORE_Out& CORE_Out::genericPrint ( const tFlag type,
const tUSInt obj 
)
inlinevirtual

print Operators

Parameters
typetype of message to print
objobject to print
Returns
the output stream

References templatedPrint().

Here is the call graph for this function:

◆ genericPrint() [9/20]

virtual CORE_Out& CORE_Out::genericPrint ( const tFlag type,
const tInt obj 
)
inlinevirtual

print Operators

Parameters
typetype of message to print
objobject to print
Returns
the output stream

References templatedPrint().

Here is the call graph for this function:

◆ genericPrint() [10/20]

virtual CORE_Out& CORE_Out::genericPrint ( const tFlag type,
const tUInt obj 
)
inlinevirtual

print Operators

Parameters
typetype of message to print
objobject to print
Returns
the output stream

References templatedPrint().

Here is the call graph for this function:

◆ genericPrint() [11/20]

virtual CORE_Out& CORE_Out::genericPrint ( const tFlag type,
const tLInt obj 
)
inlinevirtual

print Operators

Parameters
typetype of message to print
objobject to print
Returns
the output stream

References templatedPrint().

Here is the call graph for this function:

◆ genericPrint() [12/20]

virtual CORE_Out& CORE_Out::genericPrint ( const tFlag type,
const tULInt obj 
)
inlinevirtual

print Operators

Parameters
typetype of message to print
objobject to print
Returns
the output stream

References templatedPrint().

Here is the call graph for this function:

◆ genericPrint() [13/20]

virtual CORE_Out& CORE_Out::genericPrint ( const tFlag type,
const tLLInt obj 
)
inlinevirtual

print Operators

Parameters
typetype of message to print
objobject to print
Returns
the output stream

References templatedPrint().

Here is the call graph for this function:

◆ genericPrint() [14/20]

virtual CORE_Out& CORE_Out::genericPrint ( const tFlag type,
const tULLInt obj 
)
inlinevirtual

print Operators

Parameters
typetype of message to print
objobject to print
Returns
the output stream

References templatedPrint().

Here is the call graph for this function:

◆ genericPrint() [15/20]

virtual CORE_Out& CORE_Out::genericPrint ( const tFlag type,
const tFloat obj 
)
inlinevirtual

print Operators

Parameters
typetype of message to print
objobject to print
Returns
the output stream

References templatedPrint().

Here is the call graph for this function:

◆ genericPrint() [16/20]

virtual CORE_Out& CORE_Out::genericPrint ( const tFlag type,
const tDouble obj 
)
inlinevirtual

print Operators

Parameters
typetype of message to print
objobject to print
Returns
the output stream

References templatedPrint().

Here is the call graph for this function:

◆ genericPrint() [17/20]

virtual CORE_Out& CORE_Out::genericPrint ( const tFlag type,
const tLDouble obj 
)
inlinevirtual

print Operators

Parameters
typetype of message to print
objobject to print
Returns
the output stream

References templatedPrint().

Here is the call graph for this function:

◆ genericPrint() [18/20]

virtual CORE_Out& CORE_Out::genericPrint ( const tFlag type,
const tFComplex obj 
)
inlinevirtual

print Operators

Parameters
typetype of message to print
objobject to print
Returns
the output stream

References templatedPrint().

Here is the call graph for this function:

◆ genericPrint() [19/20]

virtual CORE_Out& CORE_Out::genericPrint ( const tFlag type,
const tDComplex obj 
)
inlinevirtual

print Operators

Parameters
typetype of message to print
objobject to print
Returns
the output stream

References templatedPrint().

Here is the call graph for this function:

◆ genericPrint() [20/20]

virtual CORE_Out& CORE_Out::genericPrint ( const tFlag type,
const tLDComplex obj 
)
inlinevirtual

print Operators

Parameters
typetype of message to print
objobject to print
Returns
the output stream

References templatedPrint().

Here is the call graph for this function:

◆ getClassName() [1/2]

tString CORE_Object::getClassName ( ) const
inherited

return the class name of the object

Returns
the class name of the object

References tString.

Referenced by CORE_Object::getIdentityString(), EMM_Operator::getName(), and CORE_Object::isMemoryChecked().

Here is the caller graph for this function:

◆ getClassName() [2/2]

static tString CORE_Object::getClassName ( const tString identityString)
inlinestaticinherited

return the class name of the object

Parameters
identityStringthe identity string of the object
Returns
the class name

◆ getDoubleEpsilon()

static tDouble CORE_Object::getDoubleEpsilon ( )
inlinestaticinherited

get the epsilon value for tDouble type

Returns
the epsilon value for tDouble type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getDoubleInfinity()

static tDouble CORE_Object::getDoubleInfinity ( )
inlinestaticinherited

get the infinity value for tFloat type

Returns
the intinity value for tFloat type

◆ getEpsilon()

template<class T >
static T CORE_Object::getEpsilon ( )
inlinestaticinherited

get the epsilon value for T type

Returns
the epsilon value for T type

◆ getFloatEpsilon()

static tFloat CORE_Object::getFloatEpsilon ( )
inlinestaticinherited

get the epsilon value for tFloat type

Returns
the epsilon value for tFloat type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getFloatInfinity()

static tFloat CORE_Object::getFloatInfinity ( )
inlinestaticinherited

get the infinity value for tFloat type

Returns
the intinity value for tFloat type

◆ getIdentityString()

tString CORE_Object::getIdentityString ( ) const
inlineinherited

◆ getInfinity()

template<class T >
static T CORE_Object::getInfinity ( )
inlinestaticinherited

get the infinity for T type

Returns
the infinity value for T type

◆ getLDoubleEpsilon()

static tLDouble CORE_Object::getLDoubleEpsilon ( )
inlinestaticinherited

get the epsilon value for tLDouble type

Returns
the epsilon value for tLDouble type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getLDoubleInfinity()

static tDouble CORE_Object::getLDoubleInfinity ( )
inlinestaticinherited

get the infinity value for tDouble type

Returns
the infinity value for tDouble type

◆ getMaxChar()

static tChar CORE_Object::getMaxChar ( )
inlinestaticinherited

get the max value for tChar type

Returns
the max value for tChar type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxDouble()

static tDouble CORE_Object::getMaxDouble ( )
inlinestaticinherited

get the max value for tDouble type

Returns
the max value for tDouble type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxFlag()

static tFlag CORE_Object::getMaxFlag ( )
inlinestaticinherited

get the max value for the tFlag type

Returns
the max value for the tFlag type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxFloat()

static tFloat CORE_Object::getMaxFloat ( )
inlinestaticinherited

get the max value for tFloat type

Returns
the max value for tFloat type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxIndex()

static tIndex CORE_Object::getMaxIndex ( )
inlinestaticinherited

get the max value for the array/vector indexing type

Returns
the max value for the array/vector indexing type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxInt()

static tInt CORE_Object::getMaxInt ( )
inlinestaticinherited

get the max value for tInt type

Returns
the max value for tInt type

Referenced by MATSGN_FFT::fastFourierTransform3D_FFTW(), and CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxInteger()

static tInteger CORE_Object::getMaxInteger ( )
inlinestaticinherited

get the max value for the integer type

Returns
the max value for the integer type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxLDouble()

static tLDouble CORE_Object::getMaxLDouble ( )
inlinestaticinherited

get the max value for tLDouble type

Returns
the max value for tLDouble type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxLInt()

static tLInt CORE_Object::getMaxLInt ( )
inlinestaticinherited

get the max value for tLInt type

Returns
the max value for tLInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxLLInt()

static tLLInt CORE_Object::getMaxLLInt ( )
inlinestaticinherited

get the max value for tULInt type

Returns
the max value for tULInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxReal()

static tReal CORE_Object::getMaxReal ( )
inlinestaticinherited

get the max value for the real type

Returns
he max value for the real type

Referenced by EMM_MatterField::adimensionize(), and CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxSInt()

static tSInt CORE_Object::getMaxSInt ( )
inlinestaticinherited

get the max value for tSInt type

Returns
the max value for tSInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxUChar()

static tUChar CORE_Object::getMaxUChar ( )
inlinestaticinherited

get the max value for tUChar type

Returns
the max value for tUChar type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxUIndex()

static tUIndex CORE_Object::getMaxUIndex ( )
inlinestaticinherited

get the max value for difference the array/vector indexing type

Returns
the max value for difference the array/vector indexing type

Referenced by CORE_Vector< T >::addAfterIndices(), CORE_Vector< T >::search(), CORE_Test::testType(), CORE_Integer::toHexString(), and CORE_Integer::toString().

Here is the caller graph for this function:

◆ getMaxUInt()

static tUInt CORE_Object::getMaxUInt ( )
inlinestaticinherited

get the max value for tUInt type

Returns
the max value for tUInt type

Referenced by EMM_Array< tCellFlag >::loadFromFile(), EMM_RealField::loadFromFile(), and CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxUInteger()

static tUInteger CORE_Object::getMaxUInteger ( )
inlinestaticinherited

get the max value for the unsigned integer type

Returns
the max value for the unsigned integer type

Referenced by MATH_Pn::computeExtrenums(), EMM_MultiScaleGrid::computeLevelsNumber(), EMM_Input::restoreBackup(), MATH_P0::solve(), and CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxULInt()

static tULInt CORE_Object::getMaxULInt ( )
inlinestaticinherited

get the max value for tULInt type

Returns
the max value for tULInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxULLInt()

static tULLInt CORE_Object::getMaxULLInt ( )
inlinestaticinherited

get the max value for tULLInt type

Returns
the max value for tULLInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMaxUSInt()

static tUSInt CORE_Object::getMaxUSInt ( )
inlinestaticinherited

get the max value for tUSInt type

Returns
the max value for tUSInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinChar()

static tChar CORE_Object::getMinChar ( )
inlinestaticinherited

get the min value for tChar type

Returns
the min value for tChar type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinDouble()

static tDouble CORE_Object::getMinDouble ( )
inlinestaticinherited

get the min value for tDouble type

Returns
the min value for tDouble type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinFlag()

static tFlag CORE_Object::getMinFlag ( )
inlinestaticinherited

get the min value for the tFlag type

Returns
the min value for the tFlag type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinFloat()

static tFloat CORE_Object::getMinFloat ( )
inlinestaticinherited

get the min value for tFloat type

Returns
the min value for tFloat type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinIndex()

static tIndex CORE_Object::getMinIndex ( )
inlinestaticinherited

get the min value for the array/vector indexing type

Returns
the min value for the array/vector indexing type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinInt()

static tInt CORE_Object::getMinInt ( )
inlinestaticinherited

get the min value for tInt type

Returns
the min value for tInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinInteger()

static tInteger CORE_Object::getMinInteger ( )
inlinestaticinherited

get the min value for the integer type

Returns
the minin value for the integer type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinLDouble()

static tLDouble CORE_Object::getMinLDouble ( )
inlinestaticinherited

get the min value for tLDouble type

Returns
the min value for tLDouble type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinLInt()

static tLInt CORE_Object::getMinLInt ( )
inlinestaticinherited

get the min value for tLInt type

Returns
the min value for tLInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinLLInt()

static tLLInt CORE_Object::getMinLLInt ( )
inlinestaticinherited

get the min value for tLLInt type

Returns
the min value for tLLInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinReal()

static tReal CORE_Object::getMinReal ( )
inlinestaticinherited

get the min value for the real type

Returns
the min value for the real type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinSInt()

static tSInt CORE_Object::getMinSInt ( )
inlinestaticinherited

get the min value for tSInt type

Returns
the min value for tSInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinUChar()

static tUChar CORE_Object::getMinUChar ( )
inlinestaticinherited

get the min value for tUChar type

Returns
the min value for tUChar type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinUIndex()

static tUIndex CORE_Object::getMinUIndex ( )
inlinestaticinherited

get the min value for difference the array/vector indexing type

Returns
the min value for difference the array/vector indexing type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinUInt()

static tUInt CORE_Object::getMinUInt ( )
inlinestaticinherited

get the min value for tUInt type

Returns
the min value for tUInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinUInteger()

static tUInteger CORE_Object::getMinUInteger ( )
inlinestaticinherited

get the min value for the unsigned integer type

Returns
the min value for the unsigned integer type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinULInt()

static tULInt CORE_Object::getMinULInt ( )
inlinestaticinherited

get the min value for tULInt type

Returns
the min value for tULInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinULLInt()

static tULLInt CORE_Object::getMinULLInt ( )
inlinestaticinherited

get the min value for tULLInt type

Returns
the min value for tULLInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getMinUSInt()

static tUSInt CORE_Object::getMinUSInt ( )
inlinestaticinherited

get the min value for tUSInt type

Returns
the min value for tUSInt type

Referenced by CORE_Test::testType().

Here is the caller graph for this function:

◆ getOut()

static SP::CORE_Out CORE_Object::getOut ( )
inlinestaticinherited

get the output

Returns
the shared pointer to the output stream

References CORE_Object::OUT.

◆ getOutput()

const tFlag& CORE_Out::getOutput ( )
inline

get output type

Returns
the output flag SFO:
  • S : 1 if the output is a string, 0 otherwise
  • F : 1 if the output is a file, 0 otherwise
  • O : 1 if the output is the standart output, 0 otherwise

References mOutput.

◆ getOutputFile()

ofstream& CORE_Out::getOutputFile ( )
inline

get output

Returns
the ofstream pointer to output file

References mOutputFile.

◆ getOutputFileName()

tString CORE_Out::getOutputFileName ( ) const
inline

get the output file name

Returns
the output file name

References mOutputFileName.

◆ getOutputString()

tString CORE_Out::getOutputString ( ) const
inline

get the output string

Returns
the output string

References null.

Referenced by str().

Here is the caller graph for this function:

◆ getPointerAddress()

tString CORE_Object::getPointerAddress ( ) const
inlineinherited

return the identity string of the object

Returns
the identity string of the object

References CORE_Object::pointer2String().

Here is the call graph for this function:

◆ getPrintedType()

static const tFlag& CORE_Out::getPrintedType ( )
inlinestatic

get the default printed type of message to print

Returns
he default printed type in {CORE_Out::ERROR_MSG,CORE_Out::WARNING_MSG, CORE_Out::DEBUG_MSG,CORE_Out::COMMENT_MSG}

References mPrintedType.

◆ getRealEpsilon()

static tReal CORE_Object::getRealEpsilon ( )
inlinestaticinherited

get the eps which is the difference between 1 and the least value greater than 1 that is representable.

Returns
the eps which is the difference between 1 and the least value greater than 1 that is representable.

Referenced by MATH_P4::solveP4De(), and CORE_Test::testType().

Here is the caller graph for this function:

◆ getRealInfinity()

static tReal CORE_Object::getRealInfinity ( )
inlinestaticinherited

◆ getSharedPointer() [1/2]

void CORE_Object::getSharedPointer ( SP::CORE_Object &  p)
inlineinherited

◆ getSharedPointer() [2/2]

void CORE_Object::getSharedPointer ( SPC::CORE_Object &  p) const
inlineinherited

get the shared pointer of this class into p

Parameters
p: shared pointer of the class This

◆ getThread()

static CORE_Thread& CORE_Object::getThread ( )
inlinestaticinherited

get the profilier

Returns
the profiler

Referenced by MATH_MaskVector::add(), MATH_Vector::add(), EMM_DisplacementFEMOperator::addBoundaryElasticStress(), EMM_DisplacementFEMOperator::buildDataOnNeumannBoundaryFaces(), EMM_DisplacementFVMOperator::computeCineticEnergy(), EMM_DisplacementFVMOperator::computeElasticStress(), EMM_DisplacementFEMOperator::computeElasticStress(), EMM_DisplacementFVMOperator::computeElasticTensor(), EMM_DisplacementFEMOperator::computeElasticTensor(), EMM_StaticMagneticTensorOperator::computeEnergy(), EMM_CubicAnisotropyOperator::computeEnergy(), EMM_MagnetostrictionOperator::computeEnergy(), EMM_DisplacementOperator::computeEnergy(), EMM_AnisotropyOperator::computeEnergyWithMagneticExcitation(), EMM_DisplacementFVMOperator::computeEquilibriumMatrixDiagonalConditioner(), EMM_DisplacementFEMOperator::computeEquilibriumMatrixDiagonalConditioner(), EMM_FullExchangeOperator::computeMagneticExcitationField(), EMM_StaticMagnetostrictionOperator::computeMagneticExcitationField(), EMM_LinearAnisotropyOperator::computeMagneticExcitationField(), EMM_StaticMagneticTensorOperator::computeMagneticExcitationField(), EMM_CubicAnisotropyOperator::computeMagneticExcitationField(), EMM_MinimalExchangeOperator::computeMagneticExcitationField(), EMM_AnisotropyOperator::computeMagneticExcitationField(), EMM_MagnetostrictionOperator::computeMagneticExcitationField(), EMM_CubicAnisotropyOperator::computeMagneticExcitationFieldGradient(), EMM_AnisotropyOperator::computeMagneticExcitationFieldGradient(), EMM_DisplacementFVMOperator::computeMagneticStress(), EMM_DisplacementFEMOperator::computeMagneticStress(), EMM_OptimalTimeStep::computeOptimalTimeStep(), EMM_DisplacementFEMOperator::computeStressConstraintEnergy(), EMM_FullExchangeOperator::discretize(), EMM_MinimalExchangeOperator::discretize(), EMM_CondensedMassMatrix::discretize(), EMM_LinearAnisotropyOperator::discretize(), EMM_AnisotropyOperator::discretize(), EMM_DemagnetizedOperator::discretize(), EMMG_SLDemagnetizedOperator::discretize(), EMM_LandauLifschitzSystem::discretize(), MATH_Vector::divide(), MATH_MaskVector::dot(), MATH_Vector::dot(), EMM_4SymmetricTensors::doubleDot(), EMM_4Tensors::doubleDotCrossDoubleDotScalar(), EMM_4Tensors::doubleDotCrossProduct(), EMM_4Tensors::doubleDotCrossSquaredScalar(), EMM_4Tensors::doubleDotProduct(), MATH_Vector::init(), MATH_MaskVector::init(), EMM_LandauLifschitzODE_RK::integrateMagnetizationFieldAtTime(), EMM_DisplacementFVM_Interpolator::interpolateUAtVertices(), EMMG_SLDemagnetizedOperator::localAssembly(), EMM_DisplacementOperator::nullProjectionOnDirichletBoundary(), EMM_DisplacementOperator::periodicProjection(), EMM_2PackedSymmetricTensors::product(), EMM_CanonicalMassMatrix::product(), MATH_FullMatrix::product(), EMM_CondensedMassMatrix::product(), EMM_BlockMassMatrix::product(), MATH_MorseMatrix::product(), EMMG_SLDemagnetizedOperator::product(), EMM_DisplacementOperator::projectionOnDirichletBoundary(), EMM_LandauLifschitzSystem::resetOperatorsToInitialState(), EMM_DisplacementFVMOperator::setBoundaryFaceTypes(), FFTW_MultiDFTs::setFFT(), FFTW_MultiLevelsDFT::setFFT(), FFTW_MultiLevelsDFT::setLevels(), FFTW_MultiDFTs::setPlan(), FFTW_MultiLevelsDFT::setPlan(), EMM_CondensedMassMatrix::solve(), EMM_LandauLifschitzODE::solveODE(), EMM_4SymmetricTensors::squaredDoubleDot(), EMM_4Tensors::squaredDoubleDotCrossScalar(), EMM_4Tensors::squaredDoubleDotScalar(), EMM_CanonicalMassMatrix::symmetricDot(), EMM_CondensedMassMatrix::symmetricDot(), EMM_BlockMassMatrix::symmetricDot(), FFTW_Test::test(), MATH_SolverTest::test(), EMM_ODETest::testODE(), and EMM_Grid3D::updateLimitConditionOnPoints().

Here is the caller graph for this function:

◆ getTime()

tString CORE_Out::getTime ( )
static

get time

Returns
the string representation of the current time

References CORE_Time::toString().

Referenced by printTime(), and EMMH_HysteresisFile::save().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getTypeName()

template<class T >
static tString CORE_Object::getTypeName ( )
inlinestaticinherited

get type name

Returns
the type name of the class

References tString.

◆ is32Architecture()

static tBoolean CORE_Object::is32Architecture ( )
inlinestaticinherited

return true if the machine is a 32 bits machine

Returns
true is the computing is done in a 32 bits machine

References CORE_Object::pointer2String(), CORE_Object::printObjectsInMemory(), and tString.

Referenced by CORE_Test::testType().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ is64Architecture()

static tBoolean CORE_Object::is64Architecture ( )
inlinestaticinherited

return true if the machine is a 64 bits machine

Returns
true is the computing is done in a 64 bits machine

Referenced by EMM_VTK::getVTKType(), and CORE_Test::testType().

Here is the caller graph for this function:

◆ isAborting()

tBoolean CORE_Out::isAborting ( ) const
inline

abort

Returns
true if the process is aborting

References mIsAborting.

◆ isInstanceOf() [1/2]

template<class T >
tBoolean CORE_Object::isInstanceOf ( ) const
inlineinherited

test if the clas T is an instance of this class

Returns
true if the object is an instance of T

References null.

Referenced by MATH_ToeplitzTest::toeplitzTest().

Here is the caller graph for this function:

◆ isInstanceOf() [2/2]

tBoolean CORE_Object::isInstanceOf ( const tString name) const
inlineinherited

test if the object is an instance of className

Parameters
namename of the class
Returns
true if the object is an instance of class Name

References CORE_Object::getIdentityString().

Here is the call graph for this function:

◆ isMemoryChecked()

static const tBoolean& CORE_Object::isMemoryChecked ( )
inlinestaticinherited

get if the memory checking is used

Returns
true: if the memory checking is used.

References CORE_Object::getClassName(), CORE_Object::mIsMemoryTesting, and tString.

Referenced by main().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ isOutput()

tBoolean CORE_Out::isOutput ( const tFlag type)
inline

return true if the output is selected

Parameters
typethe type of output in {SCREEN_OUTPUT,FILE_OUTPUT,STRING_OUTPUT}
Returns
true if the type is in output flag

Referenced by createStreams(), and templatedPrint().

Here is the caller graph for this function:

◆ isVerbose()

tBoolean CORE_Out::isVerbose ( const tFlag type)
inline

return true if the printed type is type

Parameters
type;the type of verbose in {ERROR_MSG,WARNING_MSG,DEBUG_MSG,COMMENT_MSG}
Returns
true if the type is in verbose flag

Referenced by templatedPrint().

Here is the caller graph for this function:

◆ New() [1/3]

static SP::CORE_Out CORE_Out::New ( )
inlinestatic

create a CORE_out class : no output by default

Returns
a shared pointer to this

References CORE_Out().

Referenced by New().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ New() [2/3]

static SP::CORE_Out CORE_Out::New ( const tString outputType)
inlinestatic

create a CORE_out class on string,file or/and std outputs

Returns
a shared pointer to this

References New().

Here is the call graph for this function:

◆ New() [3/3]

static SP::CORE_Out CORE_Out::New ( const tFlag outputType)
inlinestatic

create a CORE_out class on string,file or/and std outputs

Parameters
outputTypethe output typ in
Returns
a shared pointer to this

References New(), and release().

Here is the call graph for this function:

◆ out()

static CORE_Out& CORE_Object::out ( )
inlinestaticinherited

get the output

Returns
the output stream

Referenced by EMM_Matter::adimensionize(), EMM_DisplacementFVMOperator::backup(), EMM_DisplacementOperator::backup(), MATH_ElementaryMultiLevelsToeplitzMatrix::buildSpectralVectorProjector(), EMM_Test::caseTest(), EMM_Test::caseTests(), EMM_MatterField::computeAnisotropyDirectionsField(), EMM_OptimalTimeStep::computeOptimalTimeStep(), MATH_MultiLevelsToeplitzMatrix::copy(), CORE_Exception::CORE_Exception(), EMM_MatterField::createAnisotropyOperator(), CORE_Run::createIO(), EMM_ElementaryTest::defaultBackupTest(), EMM_ElementaryTest::defaultTest(), MATH_MultiLevelsFFTToeplitzMatrix::diagonalize(), EMM_DisplacementFVMOperator::discretize(), EMM_MagnetostrictionOperator::discretize(), EMM_DisplacementFEMOperator::discretize(), EMM_4SymmetricTensors::doubleDot(), EMM_4Tensors::doubleDotCrossDoubleDotScalar(), EMM_TensorsTest::doubleDotCrossDoubleDotScalarTests(), EMM_4Tensors::doubleDotCrossProduct(), EMM_TensorsTest::doubleDotCrossProductTests(), EMM_4Tensors::doubleDotCrossSquaredScalar(), EMM_TensorsTest::doubleDotCrossSquaredScalarTests(), EMM_4Tensors::doubleDotProduct(), EMM_TensorsTest::doubleDotProductTests(), EMM_DisplacementWaveTest::elasticWaveTest(), EMM_Test::elementaryTests(), FFTW_Test::fftwTutorial(), MATH_IntegrationTest::gaussLegendreTest(), EMM_MagnetostrictionTest::HComputingTest(), EMM_DemagnetizedPeriodicalTest::HTest(), EMMH_HysteresisTest::hysteresisDefaultCycleTest(), EMM_TensorsTest::initializationTests(), EMM_MultiScaleGrid::initialize(), EMM_MultiScaleSDGrid::initialize(), EMM_MatterField::loadFromANIFile(), EMM_AnisotropyDirectionsField::loadFromFile(), EMM_Matter::loadFromFile(), EMM_Grid3D::loadFromGEOFile(), EMM_MatterField::loadFromLOCFile(), EMM_Array< tCellFlag >::loadFromStream(), EMM_Matter::loadFromStream(), EMM_Matter::loadMattersFromFile(), EMM_Run::loadSystemFromOptions(), EMM_ElementaryTest::magnetostrictionBackupTest(), CORE_Run::make(), EMMH_Run::makeHysteresis(), EMM_Run::makeRun(), CORE_Run::makeType(), EMM_ElementaryTest::optionsTest(), MATH_PolynomialTest::P4Tests(), EMM_Test::primaryTests(), EMM_LandauLifschitzSystem::printLog(), CORE_Run::printOptions(), EMM_2PackedSymmetricTensors::product(), EMMG_SLDemagnetizedOperator::projectionOnSpectralSpace(), CORE_Run::readOptionsFromCommandLine(), CORE_Test::readVectorTest(), EMM_DemagnetizedPeriodicalTest::relaxationTest(), EMM_DisplacementFVMOperator::restore(), EMM_DisplacementOperator::restore(), EMM_Input::restoreBackup(), EMMH_Hysteresis::run(), EMM_Output::save(), EMM_AnisotropyDirectionsField::saveToFile(), EMM_MatterField::saveToFile(), EMM_Grid3D::saveToGEOFile(), CORE_IOTest::searchTest(), EMMH_Hysteresis::setInitialMagnetizationField(), MATH_MultiLevelsToeplitzMatrix::setLevels(), EMM_4SymmetricTensors::squaredDoubleDot(), EMM_4Tensors::squaredDoubleDotCrossScalar(), EMM_TensorsTest::squaredDoubleDotCrossScalarTests(), EMM_4Tensors::squaredDoubleDotScalar(), EMM_TensorsTest::squaredDoubleDotScalarTests(), EMM_TensorsTest::squaredDoubleDotTests(), EMM_MatterTest::testAdimensionize(), EMM_MatterTest::testANIFile(), CORE_Test::testComplex(), CORE_Test::testDateWeek(), FFTW_Test::testDFT(), EMM_MatterTest::testIO(), EMM_ODETest::testODE(), CORE_Test::testOut(), CORE_Test::testReal(), EMM_FieldTest::testRealArray(), EMM_Grid3DTest::testSegment(), EMM_Grid3DTest::testThinSheet(), CORE_Test::testTime(), CORE_Test::testType(), MATH_FullMatrix::toString(), EMM_DemagnetizedPeriodicalTest::xyPeriodicalCubeSDGTest(), and EMM_DemagnetizedPeriodicalTest::xyPeriodicalSheetSDGTest().

Here is the caller graph for this function:

◆ pointer2String()

tString CORE_Object::pointer2String ( const void *  obj)
staticinherited

return the string representation of a pointer

Parameters
obj: oject to get the string pointer
Returns
the string pointer of the object

References tString.

Referenced by CORE_Object::CORE_Object(), CORE_Object::getIdentityString(), CORE_Object::getPointerAddress(), CORE_Object::is32Architecture(), and CORE_Object::~CORE_Object().

Here is the caller graph for this function:

◆ print() [1/2]

virtual void CORE_Out::print ( const tFlag type,
const tString message 
)
inlinevirtual

◆ print() [2/2]

virtual void CORE_Out::print ( const tString message)
inlinevirtual

print a string

Parameters
messagevalue to print

References genericPrint().

Here is the call graph for this function:

◆ printArgs()

virtual void CORE_Out::printArgs ( const tFlag type,
const vector< tString > &  args 
)
inlinevirtual

print args

Parameters
type: printed type
argsvector strings to print

References ask(), print(), tInteger, CORE_Integer::toString(), tString, and tUIndex.

Here is the call graph for this function:

◆ printInt()

virtual void CORE_Out::printInt ( const tInteger i)
inlinevirtual

print an integer

Parameters
ivalue to print

References genericPrint().

Here is the call graph for this function:

◆ println() [1/2]

virtual void CORE_Out::println ( const tFlag type,
const tString message 
)
inlinevirtual

print the message with an end of line

Parameters
typeprinted type of the message
messagevalue to print

References genericPrint().

Referenced by EMM_Matter::adimensionize(), EMM_DisplacementFVMOperator::backup(), EMM_DisplacementOperator::backup(), MATH_ElementaryMultiLevelsToeplitzMatrix::buildSpectralVectorProjector(), EMM_Test::caseTest(), EMM_Test::caseTests(), EMM_MatterField::computeAnisotropyDirectionsField(), MATH_MultiLevelsToeplitzMatrix::copy(), EMM_MatterField::createAnisotropyOperator(), EMM_ElementaryTest::defaultBackupTest(), EMM_ElementaryTest::defaultTest(), MATH_MultiLevelsFFTToeplitzMatrix::diagonalize(), EMM_DisplacementFVMOperator::discretize(), EMM_MagnetostrictionOperator::discretize(), EMM_DisplacementFEMOperator::discretize(), EMM_4SymmetricTensors::doubleDot(), EMM_4Tensors::doubleDotCrossDoubleDotScalar(), EMM_TensorsTest::doubleDotCrossDoubleDotScalarTests(), EMM_4Tensors::doubleDotCrossProduct(), EMM_TensorsTest::doubleDotCrossProductTests(), EMM_4Tensors::doubleDotCrossSquaredScalar(), EMM_TensorsTest::doubleDotCrossSquaredScalarTests(), EMM_4Tensors::doubleDotProduct(), EMM_TensorsTest::doubleDotProductTests(), EMM_DisplacementWaveTest::elasticWaveTest(), EMM_Test::elementaryTests(), MATH_IntegrationTest::gaussLegendreTest(), EMM_DemagnetizedPeriodicalTest::HTest(), EMMH_HysteresisTest::hysteresisDefaultCycleTest(), EMM_TensorsTest::initializationTests(), EMM_MultiScaleGrid::initialize(), EMM_MultiScaleSDGrid::initialize(), EMM_MatterField::loadFromANIFile(), EMM_AnisotropyDirectionsField::loadFromFile(), EMM_Matter::loadFromFile(), EMM_Grid3D::loadFromGEOFile(), EMM_MatterField::loadFromLOCFile(), EMM_Array< tCellFlag >::loadFromStream(), EMM_Matter::loadMattersFromFile(), EMM_ElementaryTest::magnetostrictionBackupTest(), EMMH_Run::makeHysteresis(), EMM_Run::makeRun(), MATH_PolynomialTest::P4Tests(), EMM_Test::primaryTests(), EMM_LandauLifschitzSystem::printLog(), CORE_Run::printOptions(), EMM_2PackedSymmetricTensors::product(), EMMG_SLDemagnetizedOperator::projectionOnSpectralSpace(), EMM_DemagnetizedPeriodicalTest::relaxationTest(), EMM_DisplacementFVMOperator::restore(), EMM_DisplacementOperator::restore(), EMM_Input::restoreBackup(), EMMH_Hysteresis::run(), EMM_Output::save(), EMM_AnisotropyDirectionsField::saveToFile(), EMM_MatterField::saveToFile(), EMM_Grid3D::saveToGEOFile(), CORE_IOTest::searchTest(), EMMH_Hysteresis::setInitialMagnetizationField(), MATH_MultiLevelsToeplitzMatrix::setLevels(), EMM_4SymmetricTensors::squaredDoubleDot(), EMM_4Tensors::squaredDoubleDotCrossScalar(), EMM_TensorsTest::squaredDoubleDotCrossScalarTests(), EMM_4Tensors::squaredDoubleDotScalar(), EMM_TensorsTest::squaredDoubleDotScalarTests(), EMM_TensorsTest::squaredDoubleDotTests(), EMM_MatterTest::testAdimensionize(), EMM_MatterTest::testANIFile(), EMM_MatterTest::testIO(), EMM_ODETest::testODE(), EMM_FieldTest::testRealArray(), EMM_Grid3DTest::testSegment(), EMM_Grid3DTest::testThinSheet(), EMM_DemagnetizedPeriodicalTest::xyPeriodicalCubeSDGTest(), and EMM_DemagnetizedPeriodicalTest::xyPeriodicalSheetSDGTest().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ println() [2/2]

virtual void CORE_Out::println ( const tString message)
inlinevirtual

print a string and an end of line

Parameters
messagevalue to print

References genericPrint().

Here is the call graph for this function:

◆ printObjectsInMemory() [1/2]

void CORE_Object::printObjectsInMemory ( ostream &  f)
staticinherited

print object in memory

Parameters
f: output to print the objects in memory

References CORE_Object::getIdentityString(), CORE_Object::getSharedPointer(), CORE_Object::mIsMemoryTesting, CORE_Object::mObjects, and tInteger.

Here is the call graph for this function:

◆ printObjectsInMemory() [2/2]

static void CORE_Object::printObjectsInMemory ( )
inlinestaticinherited

print object in memory in the standart output

Referenced by CORE_Object::is32Architecture(), and main().

Here is the caller graph for this function:

◆ printString()

virtual void CORE_Out::printString ( const tString message)
inlinevirtual

print a string

Parameters
messagevalue to print

References genericPrint().

Here is the call graph for this function:

◆ printTime() [1/2]

virtual void CORE_Out::printTime ( const tFlag type)
inlinevirtual

print time

Parameters
typeprinted type of the message

References genericPrint(), and getTime().

Referenced by EMMH_HysteresisTest::hysteresisDefaultCycleTest(), EMMH_Run::makeHysteresis(), EMM_Run::makeRun(), EMM_ODETest::testODE(), and CORE_Test::testOut().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ printTime() [2/2]

void CORE_Out::printTime ( )
inline

print time

References getTime(), and tString.

Here is the call graph for this function:

◆ release()

void CORE_Out::release ( )
private

de-allocate the memory

References mOutputFile, mOutputString, and null.

Referenced by New(), reset(), and ~CORE_Out().

Here is the caller graph for this function:

◆ reset()

void CORE_Out::reset ( )

reset the output

References CREATE, mIsAborting, mOutput, mOutputFile, mOutputFileMode, mOutputFileName, mOutputString, mVerbose, release(), SCREEN_OUTPUT, and update().

Referenced by EMM_MagnetostrictionTest::HComputingTest(), setOutput(), EMM_ODETest::testODE(), and CORE_Test::testTime().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ resetOut()

static void CORE_Object::resetOut ( )
inlinestaticinherited

reset the output stream

Referenced by run().

Here is the caller graph for this function:

◆ resetThread()

static void CORE_Object::resetThread ( )
inlinestaticinherited

reset the output stream

Referenced by run().

Here is the caller graph for this function:

◆ restore()

void CORE_Out::restore ( )

restore the ouput from the last backup

References mOutput, mOutput_back, mOutputFileMode, mOutputFileMode_back, mOutputFileName, mOutputFileName_back, mVerbose, mVerbose_back, and update().

Referenced by setOutput().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setIsMemoryChecked()

static void CORE_Object::setIsMemoryChecked ( const tBoolean v)
inlinestaticinherited

set if the memory checking is used

Parameters
v: true to check memory

Referenced by main().

Here is the caller graph for this function:

◆ setOut()

static void CORE_Object::setOut ( SP::CORE_Out  out)
inlinestaticinherited

set the output stream

Parameters
out: the shared pointer to the new output stream

References null.

◆ setOutput() [1/2]

void CORE_Out::setOutput ( const tFlag type)
inline

set outputType of the int conversion of the binary form : SFO

  • S : 1 if the output is a string, 0 otherwise
  • F : 1 if the output is a file, 0 otherwise
  • O : 1 if the output is the standart output, 0 otherwise examples:
  • no output 0 (000)
  • all output 7 (111)
  • only screen 1 (001)
  • only file 2 (010)
  • only string 4 (100)

References backup(), createStreams(), reset(), restore(), setOutputBit(), setOutputFile(), tBoolean, tFlag, tString, and tUChar.

Referenced by CORE_Run::createIO(), EMM_DisplacementWaveTest::elasticWaveTest(), CORE_Run::makeType(), EMM_ElementaryTest::optionsTest(), and CORE_Test::testOut().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setOutput() [2/2]

void CORE_Out::setOutput ( const tString type)

set outputType of the form : "SFO"

Parameters
typestring as SFO format:
  • S : 1 if the output is a string, 0 otherwise
  • F : 1 if the output is a file, 0 otherwise
  • O : 1 if the output is the standart output, 0 otherwise examples:
  • no output 000
  • all output 111
  • only screen 001
  • only file 010
  • only string 100
  • file & screen 011

References createStreams(), mOutput, tBoolean, and tUChar.

Here is the call graph for this function:

◆ setOutputBit()

void CORE_Out::setOutputBit ( const tUChar index,
const tBoolean v 
)

set only the bit value at index to v of the output type

Parameters
indexin [0,3[
  • 0: set the screen output bit
  • 1: set the file output bit
  • 2: set the string output bit
vvalue of the bit

References createStreams(), and mOutput.

Referenced by setOutput().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setOutputFile() [1/2]

void CORE_Out::setOutputFile ( const tString fileName,
const tFlag mode 
)

set output file

References mOutputFileMode, and mOutputFileName.

Referenced by CORE_Run::createIO(), EMM_DisplacementWaveTest::elasticWaveTest(), EMM_ElementaryTest::optionsTest(), setOutput(), and setOutputFile().

Here is the caller graph for this function:

◆ setOutputFile() [2/2]

void CORE_Out::setOutputFile ( const tString fileName)
inline

set output file

References setOutputFile().

Here is the call graph for this function:

◆ setPrintedType()

static void CORE_Out::setPrintedType ( const tFlag type)
inlinestatic

set the type of message to print

Parameters
typein {CORE_Out::ERROR_MSG,CORE_Out::WARNING_MSG, CORE_Out::DEBUG_MSG,CORE_Out::COMMENT_MSG} set the default type of the message to print

◆ setThis()

void CORE_Object::setThis ( SP::CORE_Object  p)
inlineprotectedinherited

set this weak shared pointer called toDoAfterThis setting method

Parameters
p: shared pointer of the class This

References CORE_Object::toDoAfterThisSetting().

Here is the call graph for this function:

◆ setThread()

static void CORE_Object::setThread ( SP::CORE_Thread  thread)
inlinestaticinherited

set the thread

Parameters
threadthe shared pointer to the thread

References null.

Referenced by EMM_Run::EMM_Run(), EMM_TensorsRun::EMM_TensorsRun(), and MATH_SolverRun::MATH_SolverRun().

Here is the caller graph for this function:

◆ setVerbose() [1/2]

void CORE_Out::setVerbose ( const tFlag f)
inline

set the type of verbose of the int conversion of the binary form CDWE

Parameters
f: the flag in the form CDWE
  • C : 1 if the verbose is comment, 0 otherwise
  • D : 1 if the verbose is debug, 0 otherwise
  • W : 1 if the verbose is warning, 0 otherwise
  • E : 1 if the verbose is error, 0 otherwise

References tString.

Referenced by CORE_Run::createIO(), CORE_Test::testOut(), and CORE_Test::testType().

Here is the caller graph for this function:

◆ setVerbose() [2/2]

void CORE_Out::setVerbose ( const tString f)

set the type of verbose CDWE

Parameters
f: the string in the form CDWE
  • C : 1 if the verbose is comment, 0 otherwise
  • D : 1 if the verbose is debug, 0 otherwise
  • W : 1 if the verbose is warning, 0 otherwise
  • E : 1 if the verbose is error, 0 otherwise examples:
  • comment 8 (1000)
  • debug 4 (0100)
  • warning 2 (0010)
  • error 1 (0001)
  • all 15 (1111)
  • no 0 (0000)

References mVerbose, tBoolean, and tUChar.

◆ str()

tString CORE_Out::str ( ) const
inline

get the output string

Returns
the poutput string

References getOutputString().

Referenced by CORE_Test::testOut().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ templatedPrint()

template<class T >
CORE_Out& CORE_Out::templatedPrint ( const tFlag type,
const T &  str 
)
inlineprivate

print the msg value for the type in {ERROR_MSG, WARNING_MSG, DEBUG_MSG , COMMENt_MSG} on th eoutput

Parameters
typein {ERROR_MSG, WARNING_MSG, DEBUG_MSG, COMMENT_MSG}
str: value to print

References isOutput(), isVerbose(), and tString.

Referenced by genericPrint().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ toDoAfterThisSetting()

virtual void CORE_Object::toDoAfterThisSetting ( )
inlineprotectedvirtualinherited

method called after setThis() method this method can oly be called once.

Reimplemented in EMM_DisplacementOperator, EMM_DisplacementFVMOperator, EMM_GaussLegendreRelaxation, EMM_GradGaussLegendreRelaxation, and EMM_Object.

Referenced by CORE_Object::setThis().

Here is the caller graph for this function:

◆ toString()

virtual tString CORE_Out::toString ( ) const
inlinevirtual

return the string representation of the class

Returns
the string representation of the class

Reimplemented from CORE_Object.

References CORE_Integer::toString(), and tString.

Referenced by CORE_Test::testDateWeek(), and CORE_Test::testTime().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ update()

void CORE_Out::update ( )
inline

update the output

References createStreams().

Referenced by reset(), and restore().

Here is the call graph for this function:
Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator<< [1/20]

CORE_Out& operator<< ( CORE_Out out,
const CORE_Object obj 
)
friend

print Operators

Parameters
outoutput stream
objto print
Returns
the output stream

◆ operator<< [2/20]

CORE_Out& operator<< ( CORE_Out out,
const tString obj 
)
friend

print Operators

Parameters
outoutput stream
objmessage to print
Returns
the output stream

◆ operator<< [3/20]

CORE_Out& operator<< ( CORE_Out out,
const tBoolean obj 
)
friend

print Operators

Parameters
outoutput stream
objobject to print
Returns
the output stream

◆ operator<< [4/20]

CORE_Out& operator<< ( CORE_Out out,
const tChar obj 
)
friend

print Operators

Parameters
outoutput stream
objobject to print
Returns
the output stream

◆ operator<< [5/20]

CORE_Out& operator<< ( CORE_Out out,
const tChar obj 
)
friend

print Operators

Parameters
outoutput stream
objobject to print
Returns
the output stream

◆ operator<< [6/20]

CORE_Out& operator<< ( CORE_Out out,
const tUChar obj 
)
friend

print Operators

Parameters
outoutput stream
objobject to print
Returns
the output stream

◆ operator<< [7/20]

CORE_Out& operator<< ( CORE_Out out,
const tSInt obj 
)
friend

print Operators

Parameters
outoutput stream
objobject to print
Returns
the output stream

◆ operator<< [8/20]

CORE_Out& operator<< ( CORE_Out out,
const tUSInt obj 
)
friend

print Operators

Parameters
outoutput stream
objobject to print
Returns
the output stream

◆ operator<< [9/20]

CORE_Out& operator<< ( CORE_Out out,
const tInt obj 
)
friend

print Operators

Parameters
outoutput stream
objobject to print
Returns
the output stream

◆ operator<< [10/20]

CORE_Out& operator<< ( CORE_Out out,
const tUInt obj 
)
friend

print Operators

Parameters
outoutput stream
objobject to print
Returns
the output stream

◆ operator<< [11/20]

CORE_Out& operator<< ( CORE_Out out,
const tLInt obj 
)
friend

print Operators

Parameters
outoutput stream
objobject to print
Returns
the output stream

◆ operator<< [12/20]

CORE_Out& operator<< ( CORE_Out out,
const tULInt obj 
)
friend

print Operators

Parameters
outoutput stream
objobject to print
Returns
the output stream

◆ operator<< [13/20]

CORE_Out& operator<< ( CORE_Out out,
const tLLInt obj 
)
friend

print Operators

Parameters
outoutput stream
objobject to print
Returns
the output stream

◆ operator<< [14/20]

CORE_Out& operator<< ( CORE_Out out,
const tULLInt obj 
)
friend

print Operators

Parameters
outoutput stream
objobject to print
Returns
the output stream

◆ operator<< [15/20]

CORE_Out& operator<< ( CORE_Out out,
const tFloat obj 
)
friend

print Operators

Parameters
outoutput stream
objobject to print
Returns
the output stream

◆ operator<< [16/20]

CORE_Out& operator<< ( CORE_Out out,
const tDouble obj 
)
friend

print Operators

Parameters
outoutput stream
objobject to print
Returns
the output stream

◆ operator<< [17/20]

CORE_Out& operator<< ( CORE_Out out,
const tLDouble obj 
)
friend

print Operators

Parameters
out: output stream
objobject to print
Returns
the output stream

◆ operator<< [18/20]

CORE_Out& operator<< ( CORE_Out out,
const tFComplex obj 
)
friend

print Operators

Parameters
outoutput stream
objobject to print
Returns
the output stream

◆ operator<< [19/20]

CORE_Out& operator<< ( CORE_Out out,
const tDComplex obj 
)
friend

print Operators

Parameters
out: output stream
objobject to print
Returns
the output stream

◆ operator<< [20/20]

CORE_Out& operator<< ( CORE_Out out,
const tLDComplex obj 
)
friend

print Operators

Parameters
outoutput stream
objobject to print
Returns
the output stream

Member Data Documentation

◆ APPEND

const tFlag CORE_Out::APPEND =1
static

◆ COMMENT_MSG

const tFlag CORE_Out::COMMENT_MSG =8
static

◆ CREATE

const tFlag CORE_Out::CREATE =0
static

Referenced by CORE_Out(), CORE_Run::createIO(), and reset().

◆ DEBUG_MSG

const tFlag CORE_Out::DEBUG_MSG =4
static

◆ ERROR_MSG

const tFlag CORE_Out::ERROR_MSG =1
static

Referenced by MATH_ElementaryMultiLevelsToeplitzMatrix::buildSpectralVectorProjector(), EMM_Test::caseTest(), EMM_Test::caseTests(), MATH_MultiLevelsToeplitzMatrix::copy(), CORE_Exception::CORE_Exception(), EMM_ElementaryTest::defaultBackupTest(), EMM_ElementaryTest::defaultTest(), MATH_MultiLevelsFFTToeplitzMatrix::diagonalize(), EMM_4SymmetricTensors::doubleDot(), EMM_4Tensors::doubleDotCrossDoubleDotScalar(), EMM_TensorsTest::doubleDotCrossDoubleDotScalarTests(), EMM_4Tensors::doubleDotCrossProduct(), EMM_TensorsTest::doubleDotCrossProductTests(), EMM_4Tensors::doubleDotCrossSquaredScalar(), EMM_TensorsTest::doubleDotCrossSquaredScalarTests(), EMM_4Tensors::doubleDotProduct(), EMM_TensorsTest::doubleDotProductTests(), EMM_DisplacementWaveTest::elasticWaveTest(), EMM_Test::elementaryTests(), MATH_IntegrationTest::gaussLegendreTest(), EMM_DemagnetizedPeriodicalTest::HTest(), EMMH_HysteresisTest::hysteresisDefaultCycleTest(), EMM_TensorsTest::initializationTests(), EMM_MatterField::loadFromANIFile(), EMM_AnisotropyDirectionsField::loadFromFile(), EMM_Matter::loadFromFile(), EMM_MatterField::loadFromLOCFile(), EMM_Array< tCellFlag >::loadFromStream(), EMM_Matter::loadFromStream(), EMM_ElementaryTest::magnetostrictionBackupTest(), MATH_PolynomialTest::P4Tests(), EMM_Test::primaryTests(), EMM_2PackedSymmetricTensors::product(), EMM_DemagnetizedPeriodicalTest::relaxationTest(), EMM_AnisotropyDirectionsField::saveToFile(), EMM_MatterField::saveToFile(), CORE_IOTest::searchTest(), MATH_MultiLevelsToeplitzMatrix::setLevels(), EMM_4SymmetricTensors::squaredDoubleDot(), EMM_4Tensors::squaredDoubleDotCrossScalar(), EMM_TensorsTest::squaredDoubleDotCrossScalarTests(), EMM_4Tensors::squaredDoubleDotScalar(), EMM_TensorsTest::squaredDoubleDotScalarTests(), EMM_TensorsTest::squaredDoubleDotTests(), EMM_MatterTest::testAdimensionize(), EMM_MatterTest::testANIFile(), EMM_MatterTest::testIO(), EMM_ODETest::testODE(), EMM_FieldTest::testRealArray(), EMM_Grid3DTest::testSegment(), EMM_Grid3DTest::testThinSheet(), EMM_DemagnetizedPeriodicalTest::xyPeriodicalCubeSDGTest(), and EMM_DemagnetizedPeriodicalTest::xyPeriodicalSheetSDGTest().

◆ FILE_OUTPUT

const tFlag CORE_Out::FILE_OUTPUT =2
static

◆ IS_ERROR_MESSAGE_PRINTED_ON_SCREEN

tBoolean CORE_Out::IS_ERROR_MESSAGE_PRINTED_ON_SCREEN =true
static

◆ mIsAborting

tBoolean CORE_Out::mIsAborting
private

Referenced by CORE_Out(), isAborting(), and reset().

◆ mOutput

tFlag CORE_Out::mOutput
private

◆ mOutput_back

tFlag CORE_Out::mOutput_back
private

Referenced by backup(), and restore().

◆ mOutputFile

ofstream* CORE_Out::mOutputFile
private

◆ mOutputFileMode

tFlag CORE_Out::mOutputFileMode
private

◆ mOutputFileMode_back

tFlag CORE_Out::mOutputFileMode_back
private

Referenced by backup(), and restore().

◆ mOutputFileName

tString CORE_Out::mOutputFileName
private

◆ mOutputFileName_back

tString CORE_Out::mOutputFileName_back
private

Referenced by backup(), and restore().

◆ mOutputString

std::stringstream* CORE_Out::mOutputString
private

◆ mPrintedType

tFlag CORE_Out::mPrintedType =COMMENT_MSG
staticprivate

Referenced by getPrintedType().

◆ mVerbose

tFlag CORE_Out::mVerbose
private

◆ mVerbose_back

tFlag CORE_Out::mVerbose_back
private

Referenced by backup(), and restore().

◆ SCREEN_OUTPUT

const tFlag CORE_Out::SCREEN_OUTPUT =1
static

Referenced by CORE_Out(), CORE_Run::makeType(), and reset().

◆ STRING_OUTPUT

const tFlag CORE_Out::STRING_OUTPUT =4
static

◆ WARNING_MSG

const tFlag CORE_Out::WARNING_MSG =2
static

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