Class MetricDefinition

The metric definition holds of the associated metadata for a metric.

Inheritance
Object
DataModelElement
MetricDefinition
ObjectCountMetricDefinition
RenderedObjectInfoMetricDefinition
Inherited Members
Namespace: UnityEngine.Perception.GroundTruth.DataModel
Syntax
public class MetricDefinition : DataModelElement, IMessageProducer

Constructors

MetricDefinition(String, String)

Creates a new metric definition.

Declaration
public MetricDefinition(string id, string description)
Parameters
Type Name Description
String id

The ID of the metric definition.
String description

The description of the metric.

MetricDefinition(String, String, String)

Creates a new metric definition.

Declaration
public MetricDefinition(string modelType, string id, string description)
Parameters
Type Name Description
String modelType

The type of the metric.
String id

The ID of the metric definition.
String description

The description of the metric.

Properties

description

The description of the metric.

Declaration
public string description { get; }
Property Value
Type Description
String

modelType

Declaration
public override string modelType { get; }
Property Value
Type Description
String
Overrides

Methods

IsValid()

Is the component valid?

Declaration
public override bool IsValid()
Returns
Type Description
Boolean

Is the component valid?
Overrides

ToMessage(IMessageBuilder)

Convert contents int a message.

Declaration
public override void ToMessage(IMessageBuilder builder)
Parameters
Type Name Description
IMessageBuilder builder

The message builder that will convert the class's contents into a message
Overrides