Package com.inductiveautomation.ignition.common

Class DiagnosticsSample

java.lang.Object

com.inductiveautomation.ignition.common.DiagnosticsSample

All Implemented Interfaces:

Serializable

public abstract class DiagnosticsSample
extends Object
implements Serializable

DiagnosticSample is a tree of data about a target. To begin, create a sample wiht DiagnosticSample.newSample(). You can add messages, metrics, values, etc to a sample, and then use getSubSample() to get a deeper level of the tree.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DiagnosticsSample.Diagnostic
static enum	DiagnosticsSample.DiagnosticLevel

Method Summary

Modifier and Type	Method	Description
protected abstract void	add(StringPath path, DiagnosticsSample.Diagnostic value)
protected void	add(String name, Object value, DiagnosticsSample.DiagnosticLevel level)
void	addError(String name, Object value)
void	addInfo(String name, Object value)
void	addMessage(String name, String value, DiagnosticsSample.DiagnosticLevel level)
void	addMetric(String name, StatMetric metric, DiagnosticsSample.DiagnosticLevel level)
void	addValue(String name, QualifiedValue value)	Add the value, and sets the level based on whether or not the quality is good.
void	addValue(String name, QualifiedValue value, DiagnosticsSample.DiagnosticLevel level)
abstract PathTree<StringPath,DiagnosticsSample.Diagnostic>	getDiagnostics()
StringPath	getName()
DiagnosticsSample	getSubSample(String name)
static DiagnosticsSample	newSample()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

newSample

public static DiagnosticsSample newSample()

getName

public StringPath getName()

addMetric

public void addMetric(String name,
 StatMetric metric,
 DiagnosticsSample.DiagnosticLevel level)

addMessage

public void addMessage(String name,
 String value,
 DiagnosticsSample.DiagnosticLevel level)

addValue

public void addValue(String name,
 QualifiedValue value,
 DiagnosticsSample.DiagnosticLevel level)

addInfo

public void addInfo(String name,
 Object value)

addError

public void addError(String name,
 Object value)

addValue

public void addValue(String name,
 QualifiedValue value)

Add the value, and sets the level based on whether or not the quality is good. Good will be "info", and bad will be "error".

add

protected void add(String name,
 Object value,
 DiagnosticsSample.DiagnosticLevel level)

add

protected abstract void add(StringPath path,
 DiagnosticsSample.Diagnostic value)

getDiagnostics

public abstract PathTree<StringPath,DiagnosticsSample.Diagnostic> getDiagnostics()

getSubSample

public DiagnosticsSample getSubSample(String name)