ocs4R (version 0.3)

ocs4RLogger: ocs4RLogger

Description

ocs4RLogger

ocs4RLogger

Value

Object of R6Class for modelling a simple logger

Format

R6Class object.

Public fields

verbose.info

is info logger active?

verbose.debug

is debug logger active?

loggerType

logger type

Methods

Public methods

• ocs4RLogger$new()

• ocs4RLogger$logger()

• ocs4RLogger$INFO()

• ocs4RLogger$WARN()

• ocs4RLogger$ERROR()

• ocs4RLogger$getClassName()

• ocs4RLogger$getClass()

• ocs4RLogger$clone()

---

Method new()

Initializes the logger

Usage

ocs4RLogger$new(logger = NULL)

Arguments

logger

the type of logger. Default is NULL, accepts INFO or DEBUG

---

Method logger()

Logger function

Usage

ocs4RLogger$logger(type, text)

Arguments

type

type of log

text

text

---

Method INFO()

Logger to report information. Used internally

Usage

ocs4RLogger$INFO(text)

Arguments

text

text

---

Method WARN()

Logger to report warnings. Used internally

Usage

ocs4RLogger$WARN(text)

Arguments

text

text

---

Method ERROR()

Logger to report errors Used internally

Usage

ocs4RLogger$ERROR(text)

Arguments

text

text

---

Method getClassName()

Get class name

Usage

ocs4RLogger$getClassName()

Returns

the class name

---

Method getClass()

Get class

Usage

ocs4RLogger$getClass()

Returns

the class

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ocs4RLogger$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.