TVOLogParameters Class Reference

Inherits from NSObject
Declared in TVOLogParameters.h

Overview

A struct used to pass logging parameters to the log method in TVOLogger.

  logModule

TVOLogModule for the logger.

@property (nonatomic, assign) TVOLogModule logModule

Discussion

TVOLogModule for the logger.

Declared In

TVOLogParameters.h

  logLevel

TVOLogLevel for the logger.

@property (nonatomic, assign) TVOLogLevel logLevel

Discussion

TVOLogLevel for the logger.

Declared In

TVOLogParameters.h

  timeStamp

Local Timestamp for the log statement in YY-MM-DD HH:MM:SS.MMM format

@property (nonatomic, copy, nullable) NSString *timeStamp

Discussion

Local Timestamp for the log statement in YY-MM-DD HH:MM:SS.MMM format

Declared In

TVOLogParameters.h

  fileName

File name for the log statement.

@property (nonatomic, copy, nullable) NSString *fileName

Discussion

File name for the log statement.

Declared In

TVOLogParameters.h

  functionName

Function name for the log statement.

@property (nonatomic, copy, nullable) NSString *functionName

Discussion

Function name for the log statement.

Declared In

TVOLogParameters.h

  lineNumber

Line number for the log statement.

@property (nonatomic, strong, nullable) NSNumber *lineNumber

Discussion

Line number for the log statement.

Declared In

TVOLogParameters.h

  tag

Tag for the log statement.

@property (nonatomic, copy, nullable) NSString *tag

Discussion

Tag for the log statement.

Declared In

TVOLogParameters.h

  thread

The thread name/id.

@property (nonatomic, copy, nonnull) NSString *thread

Discussion

The thread name/id.

Declared In

TVOLogParameters.h

  message

The log statement body.

@property (nonatomic, copy, nonnull) NSString *message

Discussion

The log statement body.

Declared In

TVOLogParameters.h

– initWithModule:logLevel:timeStamp:fileName:functionName:lineNumber:tag:thread:message:

Initialize the LogParameters.

- (null_unspecified instancetype)initWithModule:(TVOLogModule)logModule logLevel:(TVOLogLevel)logLevel timeStamp:(nullable NSString *)timeStamp fileName:(nullable NSString *)fileName functionName:(nullable NSString *)functionName lineNumber:(nullable NSNumber *)lineNumber tag:(nullable NSString *)tag thread:(nullable NSString *)thread message:(nonnull NSString *)message

Parameters

logModule

The TVOLogModule value for the log statement
logLevel

The TVOLogLevel for the log statement
timeStamp

Local Timestamp in YY-MM-DD HH:MM:SS.MMM format
fileName

A nullable string that shows the file name of the log statement
functionName

A nullable string that shows the function name of the log statement
lineNumber

A nullable number representing the line number of the log statement in the file
tag

A nullable string that can be used to specify any user defined tag in the log line
thread

A nullable string that can be used to specify the thread name or id
message

Nonnull string for the log statement

Return Value

An initialized LogParameters instance.

Declared In

TVOLogParameters.h

– initWithModule:logLevel:message:

Initialize the LogParameters.

- (null_unspecified instancetype)initWithModule:(TVOLogModule)logModule logLevel:(TVOLogLevel)logLevel message:(nonnull NSString *)message

Parameters

logModule

The TVOLogModule value for the log statement
logLevel

The TVOLogLevel for the log statement
message

Nonnull string for the log statement

Return Value

An initialized LogParameters instance.

Discussion

This initilizer only initializes required varriables for the log statement. All other parameters are set to nil

Declared In

TVOLogParameters.h