Class IDiagLog::OptionsInternal

Nested Relationships

This class is a nested type of Class IDiagLog.

Class Documentation

class OptionsInternal

Public Functions

OptionsInternal()
explicit OptionsInternal(const Options &options)
const char *getDiagLogMask() const

Gets DiagLogMask diagLogMask: Enables diag logging only on the specified area mask.

Returns

diagLogMask as a const char*

void setDiagLogMask(const char *diagLogMask)

Sets DiagLogMask diagLogMask: Enables diag logging only on the specified area mask.

Parameters

  • handle – [in] : Handle to access Options object

  • diagLogMask – [in] : specific area where logging needs to be enabed

const char *getLogFileDirectory() const

Gets logFileDirectory logFileDirectory: The path to the directory where log files will be written. The path may be relative or absolute. Relative paths are interpreted.

Returns

logFileDirectory as a const char*

void setLogFileDirectory(const char *logFileDirectory)

Sets logFileDirectory logFileDirectory: The path to the directory where log files will be written. The path may be relative or absolute. Relative paths are interpreted.

Parameters

logFileDirectory – [in] : path for saving the log files

const char *getLogFileName() const

Gets logFileName logFileName: The name used for log files. If this value is empty then BaseName will be used as the default file name.

Returns

logFileName as a const char*

void setLogFileName(const char *logFileName)

Sets logFileName logFileName: The name used for log files. If this value is empty then BaseName will be used as the default file name.

Parameters

logFileName – [in] : name of log file

uint32_t getLogFileRotateCount() const

Gets the maximum number of log files to create. If set to 0 no log rotation will be used and the log file name specified will be used each time, overwriting any existing log file that may exist.

Returns

max log files to create

void setLogFileRotateCount(uint32_t logFileRotateCount)

Sets the maximum number of log files to create. If set to 0 no log rotation will be used and the log file name specified will be used each time, overwriting any existing log file that may exist.

Parameters

logFileRotateCount – [in] : max log files to create

bool getLogFileReplace() const

If the log file already exists, control whether it will be replaced.

Returns

1 if log file will be replaced, 0 otherwise

void setLogFileReplace(bool logFileReplace)

If the log file already exists, control whether it will be replaced.

Parameters

logFileReplace – [in] : 1 if log file to be replaced, 0 otherwise

explicit operator Options() const