nl::Weave::Profiles::DataManagement_Current::EventOptions

#include <src/lib/profiles/data-management/Current/EventLoggingTypes.h>

The structure that provides options for the different event fields.

Summary

Constructors and Destructors
EventOptions(void)
EventOptions(bool)
EventOptions(timestamp_t)
EventOptions(utc_timestamp_t)
EventOptions(timestamp_t, bool)
EventOptions(utc_timestamp_t, bool)
EventOptions(utc_timestamp_t, DetailedRootSection *, event_id_t, ImportanceType, bool)
EventOptions(timestamp_t, DetailedRootSection *, event_id_t, ImportanceType, bool)

Public attributes
eventSource
A pointer to the detailed resolution of the trait instance.
relatedEventID
The Event ID from the same Event Source that this event is related to.
relatedImportance
EventImportance of the Related Event ID.
timestamp
A union holding either system or UTC timestamp.
timestampType
An enum indicating if the timestamp is valid and its type.
urgent
bool
A flag denoting that the event is time sensitive.

Public attributes

eventSource

DetailedRootSection * nl::Weave::Profiles::DataManagement_Current::EventOptions::eventSource

A pointer to the detailed resolution of the trait instance.

When NULL, the event source is assumed to come from the resource equal to the local node ID, and from the default instance of the trait.

relatedEventID

event_id_t nl::Weave::Profiles::DataManagement_Current::EventOptions::relatedEventID

The Event ID from the same Event Source that this event is related to.

When the event is not related to any other events, Related Event ID is shall be equal to Event ID, and may be omitted. A value of 0 implies the absence of any related event.

relatedImportance

ImportanceType nl::Weave::Profiles::DataManagement_Current::EventOptions::relatedImportance

EventImportance of the Related Event ID.

When this event and the related event are of the same importance, the field may be omitted. A value of kImportanceType_Invalid implies the absence of any related event.

timestamp

Timestamp nl::Weave::Profiles::DataManagement_Current::EventOptions::timestamp

A union holding either system or UTC timestamp.

timestampType

TimestampType nl::Weave::Profiles::DataManagement_Current::EventOptions::timestampType

An enum indicating if the timestamp is valid and its type.

urgent

bool nl::Weave::Profiles::DataManagement_Current::EventOptions::urgent

A flag denoting that the event is time sensitive.

When set, it causes the event log to be flushed.

Public functions

EventOptions

 nl::Weave::Profiles::DataManagement_Current::EventOptions::EventOptions(
  void
)

EventOptions

 nl::Weave::Profiles::DataManagement_Current::EventOptions::EventOptions(
  bool
)

EventOptions

 nl::Weave::Profiles::DataManagement_Current::EventOptions::EventOptions(
  timestamp_t
)

EventOptions

 nl::Weave::Profiles::DataManagement_Current::EventOptions::EventOptions(
  utc_timestamp_t
)

EventOptions

 nl::Weave::Profiles::DataManagement_Current::EventOptions::EventOptions(
  timestamp_t,
  bool
)

EventOptions

 nl::Weave::Profiles::DataManagement_Current::EventOptions::EventOptions(
  utc_timestamp_t,
  bool
)

EventOptions

 nl::Weave::Profiles::DataManagement_Current::EventOptions::EventOptions(
  utc_timestamp_t,
  DetailedRootSection *,
  event_id_t,
  ImportanceType,
  bool
)

EventOptions

 nl::Weave::Profiles::DataManagement_Current::EventOptions::EventOptions(
  timestamp_t,
  DetailedRootSection *,
  event_id_t,
  ImportanceType,
  bool
)