• Logging
  • Logging Class

    (nymeaserver::Logging)

    The logging class provides enums and flags for the LogEngine. More...

    Header: #include <Logging>

    Public Types

    enum LoggingError { LoggingErrorNoError, LoggingErrorLogEntryNotFound, LoggingErrorInvalidFilterParameter }
    enum LoggingEventType { LoggingEventTypeTrigger, LoggingEventTypeActiveChange, LoggingEventTypeActionsExecuted, LoggingEventTypeExitActionsExecuted, LoggingEventTypeEnabledChange }
    enum LoggingLevel { LoggingLevelInfo, LoggingLevelAlert }
    enum LoggingSource { LoggingSourceSystem, LoggingSourceEvents, LoggingSourceActions, LoggingSourceStates, LoggingSourceRules }
    flags LoggingSources

    Public Functions

    Logging(QObject * parent = 0)

    Detailed Description

    The logging class provides enums and flags for the LogEngine.

    See also LogEngine, LogEntry, and LogFilter.

    Member Type Documentation

    enum Logging::LoggingError

    Represents the possible errors from the LogEngine.

    ConstantValueDescription
    nymeaserver::Logging::LoggingErrorNoError0No error happened. Everything is fine.
    nymeaserver::Logging::LoggingErrorLogEntryNotFound1The requested LogEntry could not be found.
    nymeaserver::Logging::LoggingErrorInvalidFilterParameter2The given LogFilter contains an invalid parameter.

    enum Logging::LoggingEventType

    Represents the event type of this LogEntry.

    ConstantValueDescription
    nymeaserver::Logging::LoggingEventTypeTrigger0This event type describes an Event which has triggered.
    nymeaserver::Logging::LoggingEventTypeActiveChange1This event type describes a Rule which has changed its active status.
    nymeaserver::Logging::LoggingEventTypeActionsExecuted3This event type describes the actions execution of a Rule.
    nymeaserver::Logging::LoggingEventTypeExitActionsExecuted4This event type describes the exit actions execution of a Rule.
    nymeaserver::Logging::LoggingEventTypeEnabledChange2 

    enum Logging::LoggingLevel

    Indicates if the corresponding LogEntry is an information or an alert.

    ConstantValueDescription
    nymeaserver::Logging::LoggingLevelInfo0This LogEntry represents an information.
    nymeaserver::Logging::LoggingLevelAlert1This LogEntry represents an alert. Something is not ok.

    enum Logging::LoggingSource
    flags Logging::LoggingSources

    Indicates from where the LogEntry was created. Can be used as flag.

    ConstantValueDescription
    nymeaserver::Logging::LoggingSourceSystem0This LogEntry was created from the nymea system (server).
    nymeaserver::Logging::LoggingSourceEvents1This LogEntry was created from an Event which trigged.
    nymeaserver::Logging::LoggingSourceActions2This LogEntry was created from an Action which was executed.
    nymeaserver::Logging::LoggingSourceStates3This LogEntry was created from an State which hase changed.
    nymeaserver::Logging::LoggingSourceRules4This LogEntry represents the enable/disable event from an Rule.

    The LoggingSources type is a typedef for QFlags<LoggingSource>. It stores an OR combination of LoggingSource values.

    Member Function Documentation

    Logging::Logging(QObject * parent = 0)

    Constructs the Logging object with the given parent.