Class DiagnosticsSample
- java.lang.Object
-
- com.inductiveautomation.ignition.common.DiagnosticsSample
-
- All Implemented Interfaces:
java.io.Serializable
public abstract class DiagnosticsSample extends java.lang.Object implements java.io.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 class
DiagnosticsSample.DiagnosticLevel
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract void
add(StringPath path, DiagnosticsSample.Diagnostic value)
protected void
add(java.lang.String name, java.lang.Object value, DiagnosticsSample.DiagnosticLevel level)
void
addError(java.lang.String name, java.lang.Object value)
void
addInfo(java.lang.String name, java.lang.Object value)
void
addMessage(java.lang.String name, java.lang.String value, DiagnosticsSample.DiagnosticLevel level)
void
addMetric(java.lang.String name, StatMetric metric, DiagnosticsSample.DiagnosticLevel level)
void
addValue(java.lang.String name, QualifiedValue value)
Add the value, and sets the level based on whether or not the quality is good.void
addValue(java.lang.String name, QualifiedValue value, DiagnosticsSample.DiagnosticLevel level)
abstract PathTree<StringPath,DiagnosticsSample.Diagnostic>
getDiagnostics()
StringPath
getName()
DiagnosticsSample
getSubSample(java.lang.String name)
static DiagnosticsSample
newSample()
-
-
-
Method Detail
-
newSample
public static DiagnosticsSample newSample()
-
getName
public StringPath getName()
-
addMetric
public void addMetric(java.lang.String name, StatMetric metric, DiagnosticsSample.DiagnosticLevel level)
-
addMessage
public void addMessage(java.lang.String name, java.lang.String value, DiagnosticsSample.DiagnosticLevel level)
-
addValue
public void addValue(java.lang.String name, QualifiedValue value, DiagnosticsSample.DiagnosticLevel level)
-
addInfo
public void addInfo(java.lang.String name, java.lang.Object value)
-
addError
public void addError(java.lang.String name, java.lang.Object value)
-
addValue
public void addValue(java.lang.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(java.lang.String name, java.lang.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(java.lang.String name)
-
-