Skip to content

Commit

Permalink
Add dataset template mode
Browse files Browse the repository at this point in the history
  • Loading branch information
franzpoeschel committed Mar 26, 2024
1 parent dbfe6e8 commit 785dae7
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 13 deletions.
76 changes: 64 additions & 12 deletions share/openPMD/json_schema/dataset_defs.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,15 @@
[["$defs".any_type_recursive_array.anyOf]]
title = "A numeric type"
type = "array"
items.anyOf = [{"type" = "number"}, {"type" = "null"}]
items.anyOf = [{ "type" = "number" }, { "type" = "null" }]

[["$defs".any_type_recursive_array.anyOf]]
title = "A recursive array of numeric types"
type = "array"
items."$ref" = "#/$defs/any_type_recursive_array"

["$defs".any_type_dataset]
title = "A dataset of any numeric type"
required = ["data", "datatype"]

["$defs".any_type_dataset.properties]

["$defs".any_type_dataset_properties.properties]
datatype.enum = [
"CHAR",
"UCHAR",
Expand All @@ -41,6 +37,36 @@ datatype.enum = [
"BOOL",
]
data."$ref" = "#/$defs/any_type_recursive_array"
extent = { type = "array", items = { type = "integer" } }


###################################################
# Either `datatype` and `data` must be defined... #
###################################################

[["$defs".any_type_dataset.anyOf]]
title = "A dataset of any numeric type"
allOf = [
{ required = [
"datatype",
"data",
], title = "Required properties" },
{ "$ref" = "#/$defs/any_type_dataset_properties", title = "Property definitions" },
]

#########################################################
# ...or `datatype` and `extent` must be (template form) #
#########################################################

[["$defs".any_type_dataset.anyOf]]
title = "A template dataset of any numeric type"
allOf = [
{ required = [
"datatype",
"extent",
], title = "Required properties" },
{ "$ref" = "#/$defs/any_type_dataset_properties", title = "Property definitions" },
]

######################################
# n-dimensional datasets of int type #
Expand All @@ -49,19 +75,15 @@ data."$ref" = "#/$defs/any_type_recursive_array"
[["$defs".int_type_recursive_array.anyOf]]
title = "An integer type"
type = "array"
items.anyOf = [{"type" = "integer"}, {"type" = "null"}]
items.anyOf = [{ "type" = "integer" }, { "type" = "null" }]

[["$defs".int_type_recursive_array.anyOf]]
title = "A recursive array of integer types"
type = "array"
items."$ref" = "#/$defs/int_type_recursive_array"

["$defs".int_type_dataset]
title = "A dataset of integer type"
required = ["data", "datatype"]

["$defs".int_type_dataset.properties]

["$defs".int_type_dataset_properties.properties]
datatype.enum = [
"CHAR",
"UCHAR",
Expand All @@ -77,3 +99,33 @@ datatype.enum = [
"BOOL",
]
data."$ref" = "#/$defs/int_type_recursive_array"
extent = { type = "array", items = { type = "integer" } }


###################################################
# Either `datatype` and `data` must be defined... #
###################################################

[["$defs".int_type_dataset.anyOf]]
title = "A dataset of integer type"
allOf = [
{ required = [
"datatype",
"data",
], title = "Required properties" },
{ "$ref" = "#/$defs/int_type_dataset_properties", title = "Property definitions" },
]

#########################################################
# ...or `datatype` and `extent` must be (template form) #
#########################################################

[["$defs".int_type_dataset.anyOf]]
title = "A dataset template of integer type"
allOf = [
{ required = [
"datatype",
"extent",
], title = "Required properties" },
{ "$ref" = "#/$defs/int_type_dataset_properties", title = "Property definitions" },
]
1 change: 0 additions & 1 deletion share/openPMD/json_schema/record_component.toml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ title = "Either array or constant"
#####################

[[allOf.oneOf]]
required = ["data", "datatype"]
description = "An n-dimensional dataset containing the payload."
title = "Array dataset"

Expand Down

0 comments on commit 785dae7

Please sign in to comment.