AnalysisResultSchema class
Information about a registered analysis function. Schema of one field a function puts in its result map.
A function that declares only its parameters is half typed: an author is told what to pass in and left to guess what comes back. Outputs bind to a result field by name, so the names have to be published.
Constructors
- AnalysisResultSchema({required String name, required String type, String? itemType, String? unit, String? description})
-
const
-
AnalysisResultSchema.fromJson(Map<
String, dynamic> json) -
factory
Properties
- description → String?
-
Description.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- itemType → String?
-
Element type when type is
array(number, object, string).final - name → String
-
Result field name, as it appears as a key of
AnalysisFunctionResult.results.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- type → String
-
Field type (number, array, object, string, boolean).
final
- unit → String?
-
Unit of the value, when it has one (
mm/s,Hz,dB).final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited