Class VariableMonitorBase

• Defined in File VariableMonitor.hpp

Nested Relationships

Nested Types

• Struct VariableMonitorBase::Csv

• Struct VariableMonitorBase::Json

• Struct VariableMonitorBase::SinkSpec

• Struct VariableMonitorBase::Yaml

Inheritance Relationships

Derived Types

• public GridKit::Model::VariableMonitor< eval_type< scalar_type, index_type >, model_data_type > (Template Class VariableMonitor< eval_type< scalar_type, index_type >, model_data_type >)

• public GridKit::Model::VariableMonitorController< scalar_type > (Template Class VariableMonitorController)

Class Documentation

class VariableMonitorBase

Abstract class for managing output of monitored variables.

This class is used for both the high-level control monitor and the individual component and bus monitors.

Subclassed by GridKit::Model::VariableMonitor< eval_type< scalar_type, index_type >, model_data_type >, GridKit::Model::VariableMonitorController< scalar_type >

Public Types

using Format = VariableMonitorFormat

Short alias for local use.

Public Functions

virtual bool empty() const = 0

Is there nothing to monitor?

struct Csv

Type used for dispatch.

Public Members

std::string delim = {","}

Delimiter for CSV line output.

struct Json

Type used for dispatch.

Public Members

mutable bool after_first = {false}

Implementation detail used to prevent a comma before the first block.

struct SinkSpec

Defines information necessary to create a monitor sink.

Public Members

Format format

Output format.

std::string file_name = {}

Output file name (empty for stdout)

std::string delim = {","}

Delimiter (used only with CSV format currently)

struct Yaml

Type used for dispatch.