Struct Annotation
A handle to an annotation. Can be used to report metrics on the annotation.
Syntax
public struct Annotation : IEquatable<Annotation>
Fields
Id
The ID of the annotation which will be used in the json metadata.
Declaration
Field Value
SensorHandle
The SensorHandle on which the annotation was reported
Declaration
public readonly SensorHandle SensorHandle
Field Value
Step
The step on which the annotation was reported.
Declaration
Field Value
Properties
IsNil
Returns true if the annotation is nil (created using default instantiation).
Declaration
public bool IsNil { get; }
Property Value
Methods
Equals(Object)
Declaration
public override bool Equals(object obj)
Parameters
| Type |
Name |
Description |
| Object |
obj |
|
Returns
Overrides
Equals(Annotation)
Declaration
public bool Equals(Annotation other)
Parameters
Returns
Implements
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Overrides
ReportMetric(MetricDefinition, String)
Reports a metric on this annotation. May only be called in the same frame as the annotation was reported.
Declaration
public void ReportMetric(MetricDefinition metricDefinition, [NotNull] string valuesJsonArray)
Parameters
| Type |
Name |
Description |
| MetricDefinition |
metricDefinition |
|
| String |
valuesJsonArray |
A string-based JSON array to be placed in the "values" field of the metric
|
Exceptions
ReportMetric<T>(MetricDefinition, T[])
Reports a metric on this annotation. May only be called in the same frame as the annotation was reported.
Declaration
public void ReportMetric<T>(MetricDefinition metricDefinition, [NotNull] T[] values)
Parameters
Type Parameters
Exceptions
ReportMetricAsync(MetricDefinition)
Report a metric whose values will be supplied in a later frame.
Declaration
public AsyncMetric ReportMetricAsync(MetricDefinition metricDefinition)
Parameters
Returns
| Type |
Description |
| AsyncMetric |
A handle to an AsyncMetric, which can be used to report values for this metric in future frames.
|