Struct AsyncAnnotation

A handle to an async annotation, used to report values for an annotation after the frame for the annotation has past. See ReportAnnotationAsync(AnnotationDefinition)

Inherited Members

ValueType.Equals(Object)

ValueType.GetHashCode()

ValueType.ToString()

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Namespace: UnityEngine.Perception.GroundTruth

Syntax

public struct AsyncAnnotation

Fields

Annotation

The annotation associated with this AsyncAnnotation. Can be used to report metrics on the annotation.

Declaration

public readonly Annotation Annotation

Field Value

Type	Description
Annotation

Properties

IsPending

True if neither ReportValues<T>(IEnumerable<T>) nor ReportFile(String) have been called.

Declaration

public bool IsPending { get; }

Property Value

Type	Description
Boolean

IsValid

True if the annotation is generated by the currently running simulation.

Declaration

public bool IsValid { get; }

Property Value

Type	Description
Boolean

Methods

ReportFile(String)

Report a file-based data for this annotation.

Declaration

public void ReportFile(string path)

Parameters

Type	Name	Description
String	path	The path to the file containing the annotation data.

Exceptions

Type	Condition
ArgumentNullException	Thrown if path is null

ReportValues<T>(IEnumerable<T>)

Report a value-based data for this annotation.

Declaration

public void ReportValues<T>(IEnumerable<T> values)

Parameters

Type	Name	Description
IEnumerable<T>	values	The annotation data.

Type Parameters

Name	Description
T	The type of the data.

Exceptions

Type	Condition
ArgumentNullException	Thrown if values is null

ReportValues<T>(NativeSlice<T>)

Report a value-based data for this annotation.

Declaration

public void ReportValues<T>(NativeSlice<T> values)
    where T : struct

Parameters

Type	Name	Description
NativeSlice<T>	values	The annotation data.

Type Parameters

Name	Description
T	The type of the data.

Exceptions

Type	Condition
ArgumentNullException	Thrown if values is null