oa::LogMetrics

LogMetrics class in the OA Core public surface.

ClC++ public headers

Public Methods

void oa::LogMetrics::close()

void oa::LogMetrics::flush()

const oa::String & oa::LogMetrics::getLogDir()

bool oa::LogMetrics::isOpen()

void oa::LogMetrics::logScalar(const oa::String & inTag, oa::I64 inStep, oa::F64 inValue)

void oa::LogMetrics::logScalars(const oa::String & inTag, oa::I64 inStep, const oa::HashMap<oa::String, oa::F64> & inValues)

oa::Status oa::LogMetrics::open(const oa::String & inLogDir)

void oa::LogMetrics::setFlushInterval(oa::I32 inN)

Constructor & Destructor Documentation

oa::LogMetrics::LogMetrics()

Constructors.

oa::LogMetrics::LogMetrics(
	const oa::String & inLogDir
)

No public source comment is attached to this declaration.

Parameters

inLogDir

const oa::String &

—

void oa::LogMetrics::~LogMetrics()

Destructors.

Public Method Documentation

void oa::LogMetrics::close()

No public source comment is attached to this declaration.

Returns

void

The declared return value.

void oa::LogMetrics::flush()

No public source comment is attached to this declaration.

Returns

void

The declared return value.

const oa::String & oa::LogMetrics::getLogDir()

No public source comment is attached to this declaration.

Returns

const oa::String &

The declared return value.

bool oa::LogMetrics::isOpen()

No public source comment is attached to this declaration.

Returns

bool

The declared return value.

void oa::LogMetrics::logScalar(
	const oa::String & inTag,
	oa::I64 inStep,
	oa::F64 inValue
)

No public source comment is attached to this declaration.

Parameters

inTag

const oa::String &

—

inStep

oa::I64

—

inValue

oa::F64

—

Returns

void

The declared return value.

void oa::LogMetrics::logScalars(
	const oa::String & inTag,
	oa::I64 inStep,
	const oa::HashMap<oa::String, oa::F64> & inValues
)

No public source comment is attached to this declaration.

Parameters

inTag

const oa::String &

—

inStep

oa::I64

—

inValues

const oa::HashMap<oa::String, oa::F64> &

—

Returns

void

The declared return value.

oa::Status oa::LogMetrics::open(
	const oa::String & inLogDir
)

Methods.

Parameters

inLogDir

const oa::String &

—

Returns

oa::Status

The declared return value.

void oa::LogMetrics::setFlushInterval(
	oa::I32 inN
)

No public source comment is attached to this declaration.

Parameters

inN

oa::I32

—

Returns

void

The declared return value.