Dtk_Log Class Reference

Inheritance diagram for Dtk_Log:

Public Member Functions
Dtk_ErrorStatus	AddComponentInfoAndReadingErrorStatus (const Dtk_ComponentPtr &inComponent, Dtk_ErrorStatus inStatus)
	Adds to log the info of a read component and its reading error status. More...
Dtk_ErrorStatus	AddErrorMessage (const Dtk_string &inMessage, const Dtk_string &inType, int inComponentID=-1)
	Adds to log an error message. More...
Dtk_ErrorStatus	AddFileInfoAndReadingErrorStatus (const Dtk_string &inInputFileName, Dtk_string inFileVersion, Dtk_bool inIsAssembly, Dtk_Double64 inUnitScale, Dtk_ErrorStatus inStatus)
	Adds to log the info of a read file and its reading error status (must only be called if Dtk_ComponentPtr is not used by reading) More...
Dtk_ErrorStatus	AddInfoMessage (const Dtk_string &inMessage, const Dtk_string &inType, int inComponentID=-1)
	Adds to log an info message. More...
Dtk_ErrorStatus	AddOutputFileNameWritten (const Dtk_string &inOutputFileName, Dtk_bool isRoot=DTK_FALSE)
	Adds to log the name of a written output file. More...
Dtk_ErrorStatus	AddOutputFileValidationProperty (const Dtk_string &inOutputFileName, const Dtk_string &inEntityID, const Dtk_string &inEntityType, const Dtk_string &inValPropName, const Dtk_string &inWrite)
	Add to log the validation property of an output file from its name. More...
Dtk_ErrorStatus	AddReadingEntity (Dtk_ID inComponentID, const char *inName, int inCount=1)
	Adds to log a reading inventory and associates it to a component from its ID More...
Dtk_ErrorStatus	AddReadingInventory (Dtk_ID inComponentID, int inNum, const int *inCount, const char **inEntitiesName)
	Adds to log a reading inventory and associates it to a component from its ID More...
Dtk_ErrorStatus	AddSyntheticReadingInventory (Dtk_ID inComponentID, int inNum, int *inCount, char **inEntitiesName)
	Adds to log a synthetic reading inventory and associates it to a component from its ID More...
Dtk_ErrorStatus	AddSyntheticWritingInventory (const Dtk_string &inOutputFileName, int inNum, int *inCount, char **inEntitiesName)
	Adds to log a synthetic writing inventory and associates it to an output file from its name More...
Dtk_ErrorStatus	AddValidationProperty (Dtk_Size_t inComponentID, const Dtk_string &inEntityID, const Dtk_string &inEntityType, const Dtk_string &inValPropName, const Dtk_string &inRead, const Dtk_string &inComputed, const Dtk_string &inGap, const Dtk_string &inStatus)
	Add to log the validation property of a component from its ID. More...
Dtk_ErrorStatus	AddWarningMessage (const Dtk_string &inMessage, const Dtk_string &inType, int inComponentID=-1)
	Adds to log a warning message. More...
Dtk_ErrorStatus	AddWritingInventory (const Dtk_string &inOutputFileName, int inNum, int *inCount, char **inEntitiesName)
	Adds to log a writing inventory and associates it to an output file from its name More...
Dtk_ErrorStatus	AssociateFileNames (const Dtk_string &inTemporaryFile, const Dtk_string &inFileName)
	Associates temporary file to another file (used for writing when using temporary file to create another one) More...
	Dtk_Log ()
int	DtkDynamicType (const int &inId)
	downcasting More...
virtual void	dump (FILE *file=stdout)
Dtk_ErrorStatus	FillConfig ()
	Fill log with config information (must be called after config initialization) More...
virtual Dtk_ErrorStatus	Flush ()
	Flush the content of the log. More...
int	GetAPIVersion () const
	Get API version. More...
Dtk_ErrorStatus	GetComponentErrorMessages (Dtk_Size_t inComponentID, Dtk_tab< Dtk_Log_Message > &outMessages)
	Get error messages associated to a component from its ID. More...
Dtk_ErrorStatus	GetComponentInfo (Dtk_Size_t inComponentID, Dtk_Log_Component_Info &outComponentInfo)
	Get component information from component ID. More...
Dtk_ErrorStatus	GetComponentInfoMessages (Dtk_Size_t inComponentID, Dtk_tab< Dtk_Log_Message > &outMessages)
	Get info messages associated to a component from its ID. More...
Dtk_ErrorStatus	GetComponentInventory (Dtk_Size_t inComponentID, Dtk_Log_Inventory &outInventory)
	Get inventory of component from its ID. More...
Dtk_ErrorStatus	GetComponentReadingErrorStatus (Dtk_Size_t inComponentID, Dtk_ErrorStatus &outReadingErrorStatus)
	Get reading error status of component from component ID. More...
Dtk_ErrorStatus	GetComponentSyntheticInventory (Dtk_Size_t inComponentID, Dtk_Log_Inventory &outInventory)
	Get synthetic inventory of component from its ID. More...
Dtk_ErrorStatus	GetComponentWarningMessages (Dtk_Size_t inComponentID, Dtk_tab< Dtk_Log_Message > &outMessages)
	Get warning messages associated to a component from its ID. More...
const Dtk_string &	GetConfigFileName () const
	Get config file name. More...
Dtk_ErrorStatus	GetConfigSection (Dtk_Size_t inIndex, Dtk_string &outName, Dtk_tab< Dtk_string > &outParameters, Dtk_tab< Dtk_string > &outValues)
	Get configuration section information (section name, parameters and values) from index. More...
double	GetCPUTime () const
	Get CPU time of process More...
Dtk_ErrorStatus	GetGlobalErrorMessages (Dtk_tab< Dtk_Log_Message > &outMessages)
	Get global error messages. More...
Dtk_ErrorStatus	GetGlobalInfoMessages (Dtk_tab< Dtk_Log_Message > &outMessages)
	Get global info messages. More...
Dtk_ErrorStatus	GetGlobalWarningMessages (Dtk_tab< Dtk_Log_Message > &outMessages)
	Get global warning messages. More...
int	GetHealingFlag () const
	Get healing flag. More...
const Dtk_string &	GetInputFileName () const
	Get input file name. More...
const Dtk_string &	GetInputFileVersion () const
	Get file version of input file More...
const Dtk_string &	GetInputFormat () const
	Get input format name. More...
Dtk_bool	GetIsCrash ()
	Get if there was a crash or not More...
Dtk_ErrorStatus	GetListComponentID (Dtk_tab< Dtk_ID > &outListID)
	Get list of ID of read components. More...
Dtk_tab< Dtk_ID >	GetListMissingComponents ()
	Get List of ID of missing components. More...
const Dtk_string &	GetLogFileName () const
	Get log file name (with .xml extension) More...
Dtk_Size_t	GetNbConfigSections ()
	Get number of sections of the configuration More...
Dtk_Size_t	GetNbOutputFileValidationProperties (const Dtk_string &inOutputFileName)
	Get number of validation properties of an output file from its name. More...
Dtk_Size_t	GetNbValidationProperties (Dtk_Size_t inComponentID)
	Get number of validation properties of a component from its ID. More...
Dtk_ErrorStatus	GetOutputFileInventory (Dtk_string inFileName, Dtk_Log_Inventory &outInventory)
	Get inventory of written output file from its name. More...
const Dtk_string &	GetOutputFileName () const
	Get output file name. More...
const Dtk_tab< Dtk_string > &	GetOutputFileNamesWritten () const
	Get list of names of written output files. More...
long	GetOutputFileSize () const
	Get size of output file More...
Dtk_ErrorStatus	GetOutputFileSyntheticInventory (Dtk_string inFileName, Dtk_Log_Inventory &outInventory)
	Get synthetic inventory of written output file from its name. More...
Dtk_ErrorStatus	GetOutputFileValidationProperty (const Dtk_string &inOutputFileName, Dtk_Size_t inIndex, Dtk_string &outEntityID, Dtk_string &outEntityType, Dtk_string &outValPropName, Dtk_string &outRead, Dtk_string &outComputed, Dtk_string &outGap, Dtk_string &outStatus)
	Get validation property of an output file from its name and index. More...
const Dtk_string &	GetOutputFormat () const
	Get output format name. More...
Dtk_UInt64	GetPeakWorkingSetSize () const
	Get peak working set size of process More...
const Dtk_string &	GetProductMode () const
	Get product mode. More...
virtual Dtk_Size_t	GetSize () const
const Dtk_string &	GetStartHour () const
	Get start hour of process More...
time_t	GetStartTime () const
	Get start time of process More...
const Dtk_string &	GetStopHour () const
	Get stop hour of process More...
time_t	GetStopTime () const
	Get stop time of process More...
double	GetUnitScale () const
	Get unit scale. More...
Dtk_ErrorStatus	GetValidationProperty (Dtk_Size_t inComponentID, Dtk_Size_t inIndex, Dtk_string &outEntityID, Dtk_string &outEntityType, Dtk_string &outValPropName, Dtk_string &outRead, Dtk_string &outComputed, Dtk_string &outGap, Dtk_string &outStatus)
	Get validation property of a component from its ID and index. More...
double	GetWallTime () const
	Get wall time of process More...
Dtk_UInt64	GetWorkingSetSize () const
	Get working set size of process More...
Dtk_string	GetXslFilePath () const
	Get full file path of the .xsl schema file used in .xml log file More...
const Dtk_string &	GetXslFolder () const
	Get Folder that contains .xsl schema file used in .xml log file More...
const Dtk_string &	GetXslSchemaName () const
	Get Xsl schema name used in the .xml log file. More...
void	SetConfigFileName (const Dtk_string &inVal)
	Set config file name. More...
void	SetCPUTime (double inVal)
	Set CPU time. More...
void	SetHealingFlag (int inVal)
	Set healing flag. More...
void	SetInputFileName (const Dtk_string &inVal)
	Set input file name. More...
void	SetInputFileVersion (const Dtk_string &inVal)
	Set input file version. More...
void	SetInputFormat (const Dtk_string &inVal)
	Set input format name. More...
void	SetIsCrash (Dtk_bool inVal)
	Tells if there was a crash or not. More...
void	SetIsXslEmbedded (Dtk_bool inVal)
	Tells if .xsl must be embedded in the .xml log file. More...
void	SetLogFileName (const Dtk_string &inVal)
	Set log file name. More...
void	SetOutputFileName (const Dtk_string &inVal)
	Set output file name. More...
void	SetOutputFormat (const Dtk_string &inVal)
	Set output format name. More...
void	SetPeakWorkingSetSize (Dtk_UInt64 inVal)
	Set Peak working set size. More...
void	SetProductMode (const Dtk_string &inVal)
	Set product mode. More...
void	SetStartHour (Dtk_string inVal)
	Set start hour. More...
void	SetStartTime (time_t inVal)
	Set start time. More...
void	SetStopHour (Dtk_string inVal)
	Set stop hour. More...
void	SetStopTime (time_t inVal)
	Set stop time. More...
void	SetUnitScale (double inVal)
	Set unit scale. More...
void	SetWallTime (double inVal)
	Set wall time. More...
void	SetWorkingSetSize (Dtk_UInt64 inVal)
	Set working set size. More...
void	SetXslFolder (const Dtk_string &inVal)
	Set Folder that contains .xsl schema file to use in .xml log file. More...
virtual Dtk_ErrorStatus	Write ()
	Write the content of the log into the .xml file (SetLogFileName() must be called for that) More...
virtual	~Dtk_Log ()

Static Public Member Functions
static Dtk_LogPtr	Create ()
	Calls default constructor to allocate a new object. More...
static Dtk_Log *	DtkDynamicCast (Dtk_Object *inObject)

Protected Types
enum	{ _typeID = DTK_TYPE_LOG }

Protected Attributes
Dtk_Handle *	_Private
unsigned long	count_

Member Enumeration Documentation

anonymous enum

anonymous enum

protected

Enumerator
_typeID

{ _typeID = DTK_TYPE_LOG };

Constructor & Destructor Documentation

Dtk_Log()

Dtk_Log::Dtk_Log

(

)

~Dtk_Log()

virtual Dtk_Log::~Dtk_Log ( )

virtual

Member Function Documentation

AddComponentInfoAndReadingErrorStatus()

Dtk_ErrorStatus Dtk_Log::AddComponentInfoAndReadingErrorStatus	(	const Dtk_ComponentPtr &	inComponent,
		Dtk_ErrorStatus	inStatus
	)

Adds to log the info of a read component and its reading error status.

Parameters

[in]	inComponent	: Dtk_ComponentPtr pointer to the read component
[in]	inStatus	: Reading error status (Dtk_ErrorStatus)

Returns

dtkNoError if OK

AddErrorMessage()

Dtk_ErrorStatus Dtk_Log::AddErrorMessage	(	const Dtk_string &	inMessage,
		const Dtk_string &	inType,
		int	inComponentID = -1
	)

Adds to log an error message.

Parameters

[in]	inMessage	: Message
[in]	inType	: Type
[in]	inComponentID	: -1 if message is global, component ID otherwise

Returns

dtkNoError if OK

AddFileInfoAndReadingErrorStatus()

Dtk_ErrorStatus Dtk_Log::AddFileInfoAndReadingErrorStatus	(	const Dtk_string &	inInputFileName,
		Dtk_string	inFileVersion,
		Dtk_bool	inIsAssembly,
		Dtk_Double64	inUnitScale,
		Dtk_ErrorStatus	inStatus
	)

Adds to log the info of a read file and its reading error status (must only be called if Dtk_ComponentPtr is not used by reading)

Parameters

[in]	inInputFileName	: Input file name
[in]	inFileVersion	: Input file version
[in]	inIsAssembly	: 1 if root component of the file is an assembly, 0 if it is a part
[in]	inUnitScale	: Dtk_Double64 in millimeters
[in]	inStatus	: Reading error status (Dtk_ErrorStatus)

Returns

dtkNoError if OK

AddInfoMessage()

Dtk_ErrorStatus Dtk_Log::AddInfoMessage	(	const Dtk_string &	inMessage,
		const Dtk_string &	inType,
		int	inComponentID = -1
	)

Adds to log an info message.

Parameters

[in]	inMessage	: Message
[in]	inType	: Type
[in]	inComponentID	: -1 if message is global, component ID otherwise

Returns

dtkNoError if OK

AddOutputFileNameWritten()

Dtk_ErrorStatus Dtk_Log::AddOutputFileNameWritten	(	const Dtk_string &	inOutputFileName,
		Dtk_bool	isRoot = DTK_FALSE
	)

Adds to log the name of a written output file.

Parameters

[in]	inOutputFileName	: Name of written output file
[in]	isRoot	: DTK_TRUE if output file is root, DTK_FALSE otherwise

Returns

dtkNoError if OK

AddOutputFileValidationProperty()

Dtk_ErrorStatus Dtk_Log::AddOutputFileValidationProperty	(	const Dtk_string &	inOutputFileName,
		const Dtk_string &	inEntityID,
		const Dtk_string &	inEntityType,
		const Dtk_string &	inValPropName,
		const Dtk_string &	inWrite
	)

Add to log the validation property of an output file from its name.

Parameters

[in]	inOutputFileName	: Name of written output file
[in]	inEntityID	: Entity ID
[in]	inEntityType	: Entity type
[in]	inValPropName	: Validation property name
[in]	inWrite	: Write value

Returns

dtkNoError if OK

AddReadingEntity()

Dtk_ErrorStatus Dtk_Log::AddReadingEntity	(	Dtk_ID	inComponentID,
		const char *	inName,
		int	inCount = 1
	)

Adds to log a reading inventory and associates it to a component from its ID

Parameters

[in]	inComponentID	: Component ID
[in]	inName	: entity name
[in]	inCount	: Number to add (default = 1)

Returns

dtkNoError if OK

AddReadingInventory()

Dtk_ErrorStatus Dtk_Log::AddReadingInventory	(	Dtk_ID	inComponentID,
		int	inNum,
		const int *	inCount,
		const char **	inEntitiesName
	)

Adds to log a reading inventory and associates it to a component from its ID

Parameters

[in]	inComponentID	: Component ID
[in]	inNum	: Number of entity types
[in]	inCount	: Array of count of entities (size of array must be inNum)
[in]	inEntitiesName	: Array of entity names (size of array must be inNum)

Returns

dtkNoError if OK

AddSyntheticReadingInventory()

Dtk_ErrorStatus Dtk_Log::AddSyntheticReadingInventory	(	Dtk_ID	inComponentID,
		int	inNum,
		int *	inCount,
		char **	inEntitiesName
	)

Adds to log a synthetic reading inventory and associates it to a component from its ID

Parameters

[in]	inComponentID	: Component ID
[in]	inNum	: Number of entity types
[in]	inCount	: Array of count of entities (size of array must be inNum)
[in]	inEntitiesName	: Array of entity names (size of array must be inNum)

Returns

dtkNoError if OK

AddSyntheticWritingInventory()

Dtk_ErrorStatus Dtk_Log::AddSyntheticWritingInventory	(	const Dtk_string &	inOutputFileName,
		int	inNum,
		int *	inCount,
		char **	inEntitiesName
	)

Adds to log a synthetic writing inventory and associates it to an output file from its name

Parameters

[in]	inOutputFileName	: Output file name
[in]	inNum	: Number of entity types
[in]	inCount	: Array of count of entities (size of array must be inNum)
[in]	inEntitiesName	: Array of entity names (size of array must be inNum)

Returns

dtkNoError if OK

AddValidationProperty()

Dtk_ErrorStatus Dtk_Log::AddValidationProperty	(	Dtk_Size_t	inComponentID,
		const Dtk_string &	inEntityID,
		const Dtk_string &	inEntityType,
		const Dtk_string &	inValPropName,
		const Dtk_string &	inRead,
		const Dtk_string &	inComputed,
		const Dtk_string &	inGap,
		const Dtk_string &	inStatus
	)

Add to log the validation property of a component from its ID.

Parameters

[in]	inComponentID	: Component ID
[in]	inEntityID	: Entity ID
[in]	inEntityType	: Entity type
[in]	inValPropName	: Validation property name
[in]	inRead	: Read value
[in]	inComputed	: Computed value
[in]	inGap	: Gap value
[in]	inStatus	: Status

Returns

dtkNoError if OK

AddWarningMessage()

Dtk_ErrorStatus Dtk_Log::AddWarningMessage	(	const Dtk_string &	inMessage,
		const Dtk_string &	inType,
		int	inComponentID = -1
	)

Adds to log a warning message.

Parameters

[in]	inMessage	: Message
[in]	inType	: Type
[in]	inComponentID	: -1 if message is global, component ID otherwise

Returns

dtkNoError if OK

AddWritingInventory()

Dtk_ErrorStatus Dtk_Log::AddWritingInventory	(	const Dtk_string &	inOutputFileName,
		int	inNum,
		int *	inCount,
		char **	inEntitiesName
	)

Adds to log a writing inventory and associates it to an output file from its name

Parameters

[in]	inOutputFileName	: Output file name
[in]	inNum	: Number of entity types
[in]	inCount	: Array of count of entities (size of array must be inNum)
[in]	inEntitiesName	: Array of entity names (size of array must be inNum)

Returns

dtkNoError if OK

AssociateFileNames()

Dtk_ErrorStatus Dtk_Log::AssociateFileNames	(	const Dtk_string &	inTemporaryFile,
		const Dtk_string &	inFileName
	)

Associates temporary file to another file (used for writing when using temporary file to create another one)

Parameters

[in]	inTemporaryFile	: Name of temporary file to associate
[out]	inFileName	: Name of file to be associated to the temporary file

Returns

dtkNoError if OK

Create()

static Dtk_LogPtr Dtk_Log::Create ( )

static

Calls default constructor to allocate a new object.

DtkDynamicCast()

static Dtk_Log* Dtk_Log::DtkDynamicCast ( Dtk_Object *  inObject )

static

DtkDynamicType()

int Dtk_Log::DtkDynamicType ( const int &  inId )

virtual

downcasting

Implements Dtk_Object.

dump()

virtual void Dtk_Object::dump ( FILE *  file = stdout )

virtualinherited

FillConfig()

Dtk_ErrorStatus Dtk_Log::FillConfig

(

)

Fill log with config information (must be called after config initialization)

Returns

dtkNoError if OK

Flush()

virtual Dtk_ErrorStatus Dtk_Log::Flush ( )

virtual

Flush the content of the log.

Returns

dtkNoError if OK

GetAPIVersion()

int Dtk_Log::GetAPIVersion

(

)

const

Get API version.

Returns

API version

GetComponentErrorMessages()

Dtk_ErrorStatus Dtk_Log::GetComponentErrorMessages	(	Dtk_Size_t	inComponentID,
		Dtk_tab< Dtk_Log_Message > &	outMessages
	)

Get error messages associated to a component from its ID.

Parameters

[in]	inComponentID	: Component ID
[out]	outMessages	: Array of Dtk_Log_Message

Returns

dtkNoError if OK

GetComponentInfo()

Dtk_ErrorStatus Dtk_Log::GetComponentInfo	(	Dtk_Size_t	inComponentID,
		Dtk_Log_Component_Info &	outComponentInfo
	)

Get component information from component ID.

Parameters

[in]	inComponentID	: Component ID
[out]	outComponentInfo	: Dtk_Log_Component_Info that contains component information

Returns

dtkNoError if OK

GetComponentInfoMessages()

Dtk_ErrorStatus Dtk_Log::GetComponentInfoMessages	(	Dtk_Size_t	inComponentID,
		Dtk_tab< Dtk_Log_Message > &	outMessages
	)

Get info messages associated to a component from its ID.

Parameters

[in]	inComponentID	: Component ID
[out]	outMessages	: Array of Dtk_Log_Message

Returns

dtkNoError if OK

GetComponentInventory()

Dtk_ErrorStatus Dtk_Log::GetComponentInventory	(	Dtk_Size_t	inComponentID,
		Dtk_Log_Inventory &	outInventory
	)

Get inventory of component from its ID.

Parameters

[in]	inComponentID	: Component ID
[out]	outInventory	: Dtk_Log_Inventory that contains component inventory

Returns

dtkNoError if OK

GetComponentReadingErrorStatus()

Dtk_ErrorStatus Dtk_Log::GetComponentReadingErrorStatus	(	Dtk_Size_t	inComponentID,
		Dtk_ErrorStatus &	outReadingErrorStatus
	)

Get reading error status of component from component ID.

Parameters

[in]	inComponentID	: Component ID
[out]	outReadingErrorStatus	: Reading error status (Dtk_ErrorStatus)

Returns

dtkNoError if OK

GetComponentSyntheticInventory()

Dtk_ErrorStatus Dtk_Log::GetComponentSyntheticInventory	(	Dtk_Size_t	inComponentID,
		Dtk_Log_Inventory &	outInventory
	)

Get synthetic inventory of component from its ID.

Parameters

[in]	inComponentID	: Component ID
[out]	outInventory	: Dtk_Log_Inventory that contains component inventory

Returns

dtkNoError if OK

GetComponentWarningMessages()

Dtk_ErrorStatus Dtk_Log::GetComponentWarningMessages	(	Dtk_Size_t	inComponentID,
		Dtk_tab< Dtk_Log_Message > &	outMessages
	)

Get warning messages associated to a component from its ID.

Parameters

[in]	inComponentID	: Component ID
[out]	outMessages	: Array of Dtk_Log_Message

Returns

dtkNoError if OK

GetConfigFileName()

const Dtk_string& Dtk_Log::GetConfigFileName

(

)

const

Get config file name.

Returns

Config file name

GetConfigSection()

Dtk_ErrorStatus Dtk_Log::GetConfigSection	(	Dtk_Size_t	inIndex,
		Dtk_string &	outName,
		Dtk_tab< Dtk_string > &	outParameters,
		Dtk_tab< Dtk_string > &	outValues
	)

Get configuration section information (section name, parameters and values) from index.

Parameters

[in]	inIndex	: Index (with range [0..GetNbConfigSections()-1])
[out]	outName	: Section name
[out]	outParameters	: Array of parameters
[out]	outValues	: Array of values

Returns

dtkNoError if OK

GetCPUTime()

double Dtk_Log::GetCPUTime

(

)

const

Get CPU time of process

Returns

CPU time of process

GetGlobalErrorMessages()

Dtk_ErrorStatus Dtk_Log::GetGlobalErrorMessages

(

Dtk_tab< Dtk_Log_Message > &

outMessages

)

Get global error messages.

Parameters

[out]

outMessages

: Array of Dtk_Log_Message

Returns

dtkNoError if OK

GetGlobalInfoMessages()

Dtk_ErrorStatus Dtk_Log::GetGlobalInfoMessages

(

Dtk_tab< Dtk_Log_Message > &

outMessages

)

Get global info messages.

Parameters

[out]

outMessages

: Array of Dtk_Log_Message

Returns

dtkNoError if OK

GetGlobalWarningMessages()

Dtk_ErrorStatus Dtk_Log::GetGlobalWarningMessages

(

Dtk_tab< Dtk_Log_Message > &

outMessages

)

Get global warning messages.

Parameters

[out]

outMessages

: Array of Dtk_Log_Message

Returns

dtkNoError if OK

GetHealingFlag()

int Dtk_Log::GetHealingFlag

(

)

const

Get healing flag.

Returns

-1 if not set, 1 if healing is used, 0 if not

GetInputFileName()

const Dtk_string& Dtk_Log::GetInputFileName

(

)

const

Get input file name.

Returns

Input file name (an empty string is returned if reading is not used)

GetInputFileVersion()

const Dtk_string& Dtk_Log::GetInputFileVersion

(

)

const

Get file version of input file

Returns

File version of input file

GetInputFormat()

const Dtk_string& Dtk_Log::GetInputFormat

(

)

const

Get input format name.

Returns

Input format name (an empty string is returned if reading is not used)

GetIsCrash()

Dtk_bool Dtk_Log::GetIsCrash

(

)

Get if there was a crash or not

Returns

DTK_TRUE if yes, DTK_FALSE otherwise

GetListComponentID()

Dtk_ErrorStatus Dtk_Log::GetListComponentID

(

Dtk_tab< Dtk_ID > &

outListID

)

Get list of ID of read components.

Parameters

[in]

outListID

: Array of component ID (it is empty if reading is not used)

GetListMissingComponents()

Dtk_tab<Dtk_ID> Dtk_Log::GetListMissingComponents

(

)

Get List of ID of missing components.

Returns

Array of Dtk_ID

GetLogFileName()

const Dtk_string& Dtk_Log::GetLogFileName

(

)

const

Get log file name (with .xml extension)

Returns

Log file name

GetNbConfigSections()

Dtk_Size_t Dtk_Log::GetNbConfigSections

(

)

Get number of sections of the configuration

Returns

Number of sections of the configuration

GetNbOutputFileValidationProperties()

Dtk_Size_t Dtk_Log::GetNbOutputFileValidationProperties

(

const Dtk_string &

inOutputFileName

)

Get number of validation properties of an output file from its name.

Parameters

[in]

inOutputFileName

: Name of written output file

Returns

Number of validation properties

GetNbValidationProperties()

Dtk_Size_t Dtk_Log::GetNbValidationProperties

(

Dtk_Size_t

inComponentID

)

Get number of validation properties of a component from its ID.

Parameters

[in]

inComponentID

: Component ID

Returns

Number of validation properties

GetOutputFileInventory()

Dtk_ErrorStatus Dtk_Log::GetOutputFileInventory	(	Dtk_string	inFileName,
		Dtk_Log_Inventory &	outInventory
	)

Get inventory of written output file from its name.

Parameters

[in]	inFileName	: Name of output file
[out]	outInventory	: Dtk_Log_Inventory that contains output file inventory

Returns

dtkNoError if OK

GetOutputFileName()

const Dtk_string& Dtk_Log::GetOutputFileName

(

)

const

Get output file name.

Returns

Output file name (an empty string is returned if writing is not used)

GetOutputFileNamesWritten()

const Dtk_tab<Dtk_string>& Dtk_Log::GetOutputFileNamesWritten

(

)

const

Get list of names of written output files.

Returns

Array of output file names

GetOutputFileSize()

long Dtk_Log::GetOutputFileSize

(

)

const

Get size of output file

Returns

-1 if not set, size of output file otherwise

GetOutputFileSyntheticInventory()

Dtk_ErrorStatus Dtk_Log::GetOutputFileSyntheticInventory	(	Dtk_string	inFileName,
		Dtk_Log_Inventory &	outInventory
	)

Get synthetic inventory of written output file from its name.

Parameters

[in]	inFileName	: Name of output file
[out]	outInventory	: Dtk_Log_Inventory that contains output file inventory

Returns

dtkNoError if OK

GetOutputFileValidationProperty()

Dtk_ErrorStatus Dtk_Log::GetOutputFileValidationProperty	(	const Dtk_string &	inOutputFileName,
		Dtk_Size_t	inIndex,
		Dtk_string &	outEntityID,
		Dtk_string &	outEntityType,
		Dtk_string &	outValPropName,
		Dtk_string &	outRead,
		Dtk_string &	outComputed,
		Dtk_string &	outGap,
		Dtk_string &	outStatus
	)

Get validation property of an output file from its name and index.

Parameters

[in]	inOutputFileName	: Name of written output file
[in]	inIndex	: Index (with range [0..GetNbOutputFileValidationProperties()-1])
[out]	outEntityID	: Entity ID
[out]	outEntityType	: Entity type
[out]	outValPropName	: Validation property name
[out]	outRead	: Read value
[out]	outComputed	: Computed value
[out]	outGap	: Gap value
[out]	outStatus	: Status

Returns

dtkNoError if OK

GetOutputFormat()

const Dtk_string& Dtk_Log::GetOutputFormat

(

)

const

Get output format name.

Returns

Output format name (an empty string is returned if writing is not used)

GetPeakWorkingSetSize()

Dtk_UInt64 Dtk_Log::GetPeakWorkingSetSize

(

)

const

Get peak working set size of process

Returns

CPU time of process

GetProductMode()

const Dtk_string& Dtk_Log::GetProductMode

(

)

const

Get product mode.

Returns

"Psk" if it uses Pskernel, "Dtk" if not

GetSize()

virtual Dtk_Size_t Dtk_Object::GetSize ( ) const

virtualinherited

Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_mesh_face, Dtk_mesh, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, Dtk_Point, Dtk_Entity, and Dtk_Info.

GetStartHour()

const Dtk_string& Dtk_Log::GetStartHour

(

)

const

Get start hour of process

Returns

Start hour of process

GetStartTime()

time_t Dtk_Log::GetStartTime

(

)

const

Get start time of process

Returns

Start time of process

GetStopHour()

const Dtk_string& Dtk_Log::GetStopHour

(

)

const

Get stop hour of process

Returns

stop hour of process

GetStopTime()

time_t Dtk_Log::GetStopTime

(

)

const

Get stop time of process

Returns

stop time of process

GetUnitScale()

double Dtk_Log::GetUnitScale

(

)

const

Get unit scale.

Returns

double in millimeters

GetValidationProperty()

Dtk_ErrorStatus Dtk_Log::GetValidationProperty	(	Dtk_Size_t	inComponentID,
		Dtk_Size_t	inIndex,
		Dtk_string &	outEntityID,
		Dtk_string &	outEntityType,
		Dtk_string &	outValPropName,
		Dtk_string &	outRead,
		Dtk_string &	outComputed,
		Dtk_string &	outGap,
		Dtk_string &	outStatus
	)

Get validation property of a component from its ID and index.

Parameters

[in]	inComponentID	: Component ID
[in]	inIndex	: Index (with range [0..GetNbValidationProperties()-1])
[out]	outEntityID	: Entity ID
[out]	outEntityType	: Entity type
[out]	outValPropName	: Validation property name
[out]	outRead	: Read value
[out]	outComputed	: Computed value
[out]	outGap	: Gap value
[out]	outStatus	: Status

Returns

dtkNoError if OK

GetWallTime()

double Dtk_Log::GetWallTime

(

)

const

Get wall time of process

Returns

Wall time of process

GetWorkingSetSize()

Dtk_UInt64 Dtk_Log::GetWorkingSetSize

(

)

const

Get working set size of process

Returns

Wall time of process

GetXslFilePath()

Dtk_string Dtk_Log::GetXslFilePath

(

)

const

Get full file path of the .xsl schema file used in .xml log file

Returns

File path of the .xsl schema file

GetXslFolder()

const Dtk_string& Dtk_Log::GetXslFolder

(

)

const

Get Folder that contains .xsl schema file used in .xml log file

Returns

Folder name that contains .xsl schema file

GetXslSchemaName()

const Dtk_string& Dtk_Log::GetXslSchemaName

(

)

const

Get Xsl schema name used in the .xml log file.

Returns

Xsl schema name ("dtk_versionxxx.xsl")

SetConfigFileName()

void Dtk_Log::SetConfigFileName

(

const Dtk_string &

inVal

)

Set config file name.

Parameters

[in]

inVal

: Config file name with .dtk extension

SetCPUTime()

void Dtk_Log::SetCPUTime

(

double

inVal

)

Set CPU time.

Parameters

[in]

inVal

: CPU time

SetHealingFlag()

void Dtk_Log::SetHealingFlag

(

int

inVal

)

Set healing flag.

Parameters

[in]

inVal

: 1 if healing is used, 0 if not

SetInputFileName()

void Dtk_Log::SetInputFileName

(

const Dtk_string &

inVal

)

Set input file name.

Parameters

[in]

inVal

: Input file name

SetInputFileVersion()

void Dtk_Log::SetInputFileVersion

(

const Dtk_string &

inVal

)

Set input file version.

Parameters

[in]

inVal

: Input file version

SetInputFormat()

void Dtk_Log::SetInputFormat

(

const Dtk_string &

inVal

)

Set input format name.

Parameters

[in]

inVal

: Input format name

SetIsCrash()

void Dtk_Log::SetIsCrash

(

Dtk_bool

inVal

)

Tells if there was a crash or not.

Parameters

[in]

inVal

: DTK_TRUE if yes, DTK_FALSE otherwise

SetIsXslEmbedded()

void Dtk_Log::SetIsXslEmbedded

(

Dtk_bool

inVal

)

Tells if .xsl must be embedded in the .xml log file.

Parameters

[in]

inVal

: DTK_TRUE if .xsl must be embedded in the .xml log file, DTK_FALSE otherwise

SetLogFileName()

void Dtk_Log::SetLogFileName

(

const Dtk_string &

inVal

)

Set log file name.

Parameters

[in]

inVal

: Log file name with .xml extension

SetOutputFileName()

void Dtk_Log::SetOutputFileName

(

const Dtk_string &

inVal

)

Set output file name.

Parameters

[in]

inVal

: Output file name

SetOutputFormat()

void Dtk_Log::SetOutputFormat

(

const Dtk_string &

inVal

)

Set output format name.

Parameters

[in]

inVal

: Output format name

SetPeakWorkingSetSize()

void Dtk_Log::SetPeakWorkingSetSize

(

Dtk_UInt64

inVal

)

Set Peak working set size.

Parameters

[in]

inVal

: CPU time

SetProductMode()

void Dtk_Log::SetProductMode

(

const Dtk_string &

inVal

)

Set product mode.

Parameters

[in]

inVal

: "Psk" if it uses Pskernel, "Dtk" if not

SetStartHour()

void Dtk_Log::SetStartHour

(

Dtk_string

inVal

)

Set start hour.

Parameters

[in]

inVal

: Start hour

SetStartTime()

void Dtk_Log::SetStartTime

(

time_t

inVal

)

Set start time.

Parameters

[in]

inVal

: Start time

SetStopHour()

void Dtk_Log::SetStopHour

(

Dtk_string

inVal

)

Set stop hour.

Parameters

[in]

inVal

: Stop hour

SetStopTime()

void Dtk_Log::SetStopTime

(

time_t

inVal

)

Set stop time.

Parameters

[in]

inVal

: Stop time

SetUnitScale()

void Dtk_Log::SetUnitScale

(

double

inVal

)

Set unit scale.

Parameters

[in]

inVal

: double in millimeters

SetWallTime()

void Dtk_Log::SetWallTime

(

double

inVal

)

Set wall time.

Parameters

[in]

inVal

: Wall time

SetWorkingSetSize()

void Dtk_Log::SetWorkingSetSize

(

Dtk_UInt64

inVal

)

Set working set size.

Parameters

[in]

inVal

: Wall time

SetXslFolder()

void Dtk_Log::SetXslFolder

(

const Dtk_string &

inVal

)

Set Folder that contains .xsl schema file to use in .xml log file.

Parameters

[in]

inVal

: Folder name that contains .xsl schema file

Write()

virtual Dtk_ErrorStatus Dtk_Log::Write ( )

virtual

Write the content of the log into the .xml file (SetLogFileName() must be called for that)

Returns

dtkNoError if OK

Field Documentation

_Private

Dtk_Handle* Dtk_Log::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited