NEML2 2.0.0
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
TracingInterface Class Reference

Detailed Description

Interface for classes that support event tracing

This class provides a common interface for classes that support event tracing. It provides a mechanism for writing trace data to a file in the Chrome tracing format.

See also
https://www.chromium.org/developers/how-tos/trace-event-profiling-tool
https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU

#include <TracingInterface.h>

Inheritance diagram for TracingInterface:

Public Member Functions

 TracingInterface (std::string)
 
 TracingInterface (const OptionSet &)
 
virtual ~TracingInterface ()=default
 
 TracingInterface (const TracingInterface &)=default
 
 TracingInterface (TracingInterface &&)=default
 
TracingInterfaceoperator= (const TracingInterface &)=delete
 
TracingInterfaceoperator= (TracingInterface &&)=delete
 
bool event_tracing_enabled () const
 
TraceWriterevent_trace_writer () const
 Get the event trace writer.
 

Static Public Member Functions

static OptionSet expected_options ()
 

Constructor & Destructor Documentation

◆ TracingInterface() [1/4]

TracingInterface ( std::string trace_file)

◆ TracingInterface() [2/4]

TracingInterface ( const OptionSet & options)

◆ ~TracingInterface()

virtual ~TracingInterface ( )
virtualdefault

◆ TracingInterface() [3/4]

TracingInterface ( const TracingInterface & )
default

◆ TracingInterface() [4/4]

Member Function Documentation

◆ event_trace_writer()

TraceWriter & event_trace_writer ( ) const

Get the event trace writer.

◆ event_tracing_enabled()

bool event_tracing_enabled ( ) const
inline

◆ expected_options()

OptionSet expected_options ( )
static

◆ operator=() [1/2]

TracingInterface & operator= ( const TracingInterface & )
delete

◆ operator=() [2/2]

TracingInterface & operator= ( TracingInterface && )
delete