Class NoOutputEndpoint
Output endpoint that ignores all incoming data
Inherited Members
Namespace: UnityEngine.Perception.GroundTruth.Consumers
Assembly: Unity.Perception.Runtime.dll
Syntax
public class NoOutputEndpoint : IConsumerEndpoint, ICloneableProperties
description
The human readable description of the endpoint
Declaration
public string description { get; }Property Value
| Type | Description |
|---|---|
| string |
Methods
AnnotationRegistered(AnnotationDefinition)
Called when an annotation is registered with the perception engine.
Declaration
public void AnnotationRegistered(AnnotationDefinition annotationDefinition)Parameters
| Type | Name | Description |
|---|---|---|
| AnnotationDefinition | annotationDefinition | The registered annotation definition |
Clone()
Returns current object
Declaration
public object Clone()Returns
| Type | Description |
|---|---|
| object |
FrameGenerated(Frame)
Called at the end of each frame. Contains all of the generated data for the frame. This method is called after the frame has entirely finished processing.
Declaration
public void FrameGenerated(Frame frame)Parameters
| Type | Name | Description |
|---|---|---|
| Frame | frame | The frame data. |
IsValid(out string)
Checks to see if an endpoint is configured properly. If an endpoint is invalid the endpoint will not be able to properly produce generated data.
Declaration
public bool IsValid(out string errorMessage)Parameters
| Type | Name | Description |
|---|---|---|
| string | errorMessage | If validation fails, this will be updated with an error message |
Returns
| Type | Description |
|---|---|
| bool | True if validation is successful |
MetricRegistered(MetricDefinition)
Called when a metric is registered with the perception engine.
Declaration
public void MetricRegistered(MetricDefinition metricDefinition)Parameters
| Type | Name | Description |
|---|---|---|
| MetricDefinition | metricDefinition | The registered metric definition |
ResumeSimulationFromCrash(int)
Placeholder for resume simulation after the crash
Declaration
public (string, int) ResumeSimulationFromCrash(int maxFrameCount)Parameters
| Type | Name | Description |
|---|---|---|
| int | maxFrameCount |
Returns
| Type | Description |
|---|---|
| (string, int) | nothing |
SensorRegistered(SensorDefinition)
Called when a sensor is registered with the perception engine.
Declaration
public void SensorRegistered(SensorDefinition sensor)Parameters
| Type | Name | Description |
|---|---|---|
| SensorDefinition | sensor | The registered sensor definition |
SimulationCompleted(SimulationMetadata)
Called at the end of the simulation. Contains metadata describing the entire simulation process.
Declaration
public void SimulationCompleted(SimulationMetadata metadata)Parameters
| Type | Name | Description |
|---|---|---|
| SimulationMetadata | metadata | Metadata describing the entire simulation process |
SimulationStarted(SimulationMetadata)
Called when the simulation begins. Provides simulation wide metadata to the consumer.
Declaration
public void SimulationStarted(SimulationMetadata metadata)Parameters
| Type | Name | Description |
|---|---|---|
| SimulationMetadata | metadata | Metadata describing the active simulation |