Struct AnnotationHandle
A handle to an annotation. Can be used to report metrics on the annotation.
Syntax
public readonly struct AnnotationHandle : IDatasetHandle, IEquatable<AnnotationHandle>
Properties
Id
The ID of the annotation which will be used in the json metadata.
Declaration
public readonly string Id { get; }
Property Value
Implements
IsNil
Returns true if the annotation is nil (created using default instantiation).
Declaration
public readonly bool IsNil { get; }
Property Value
Methods
Equals(Object)
Declaration
public override readonly bool Equals(object obj)
Parameters
| Type |
Name |
Description |
| Object |
obj |
|
Returns
Equals(AnnotationHandle)
Declaration
public readonly bool Equals(AnnotationHandle other)
Parameters
Returns
GetHashCode()
Declaration
public override readonly int GetHashCode()
Returns
IsValid()
Declaration
public readonly bool IsValid()
Returns
Implements
ReportMetric(MetricDefinition, Metric)
Synchronously report a metric for the current simulation frame.
Declaration
public readonly void ReportMetric(MetricDefinition definition, Metric metric)
Parameters
| Type |
Name |
Description |
| MetricDefinition |
definition |
The definition of the metric to report
|
| Metric |
metric |
The metric value
|
ReportMetricAsync(MetricDefinition)
Report a metric whose values will be supplied in a later frame.
Declaration
public readonly AsyncFuture<Metric> ReportMetricAsync(MetricDefinition metricDefinition)
Parameters
Returns
| Type |
Description |
| AsyncFuture<Metric> |
A handle to an AsyncMetric, which can be used to report values for this metric in future frames.
|