Property
PartDraftv1.0.0-rc.2
A property: one fact about a record, such as a source's rotational speed, a terrain's ground type or the air temperature of a weather condition. Its type comes from a quantities vocabulary, which gives the unit and the valid range.
https://opendevelopmentstandards.org/schema/1.0.0-rc.2/core/Property.json
Fields
idtextnot emptyThe record's id: unique within the document.
typeRequiredCode fromcore/quantities or acoustics/quantitiesWhat the property is, as a code from a quantities vocabulary.
nametextA readable name, when the code's own name is not enough.
descriptiontextWhat the property means, in words.
valuerangeheightnumberThe height above the ground that the property applies at, in metres, such as wind speed at 120 m. Leave it out for the quantity's standard height.
geometryWhere the property applies, when only part of the record.
- Exactly one of
valueorrange.
Range
A range of amounts, when the property holds over a range, such as the speeds an operating state covers.
minimumnumberThe lowest amount, inclusive.
maximumnumberThe highest amount, inclusive.
unitThe unit of both bounds.
- At least one of
minimumormaximum.
Links
Held by Records that embed this one, with their field that holds it.
- AssumptionEntitypropertiesA fact that an evaluation takes as true without evidence, such as an operating state or the weather, with the reason for it.
- ConditionEntitypropertiesA state of the surroundings over an area and a time, such as the ambient sound, the terrain, the weather or the water. Its properties come from a quantities vocabulary; which list holds it (ambient, terrain, weather or hydrology) says what sort it is.
- EmissionPartpropertiesWhat a source gives off in one operating state, such as sound power, a pollutant rate or a discharge. A module schema can require more of it for its domain.
- FeatureEntitypropertiesA natural or built object with a place and properties, such as a wellsite, a dwelling or a road. As in ISO 19101. A feature where a framework judges effects is a receptor and has a receptor class.
- InstrumentEntitypropertiesA device that measures, such as a sound level meter, a microphone or a weather station, with its calibrations.
- Operating statePartpropertiesA named way that a source runs, set by its operating properties, such as speed, load, flow rate or mode. Off is an operating state. Each emission names the state it holds for.
- PathPartpropertiesA route from one place to another, with its line and the ordered events along it, such as a sound path from a source to a receptor or a plume's trajectory.
- SourcePartpropertiesA part of a feature that emits, such as a compressor, an engine, a stack or an outfall. As in ISO 14224:2016, levels 6 to 8. A source can hold smaller sources, such as a compressor's engine and cooler.
- StructurePartpropertiesA built form, such as a building, a wall or a barrier. As in IFC (ISO 16739).
Examples
An id that another example defines opens that record.
Example 4
{
"type": "rotational_speed",
"range": {
"minimum": 1500,
"maximum": 1800,
"unit": "1/min"
}
}Show 3 more examplesHide the other examples
Example 1
{
"id": "p1",
"type": "ground_type",
"value": {
"amount": "grass"
}
}Example 2
{
"type": "rotational_speed",
"value": {
"amount": 1800,
"unit": "1/min"
}
}Example 3
{
"type": "wind_speed",
"height": 120,
"value": {
"amount": 7.4,
"unit": "m/s"
}
}Changes and file
Changes
- 0.1.0 First version.
Schema file
Show the JSON SchemaHide the JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://opendevelopmentstandards.org/schema/1.0.0-rc.2/core/Property.json",
"title": "Property",
"description": "A property: one fact about a record, such as a source's rotational speed, a terrain's ground type or the air temperature of a weather condition. Its `type` comes from a quantities vocabulary, which gives the unit and the valid range.",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"description": "The record's id: unique within the document."
},
"type": {
"type": "string",
"pattern": "^[a-z0-9]+(_[a-z0-9]+)*(\\.[a-z0-9]+(_[a-z0-9]+)*)*$",
"x-ods-vocabulary": "*/quantities",
"description": "What the property is, as a code from a quantities vocabulary."
},
"name": {
"type": "string",
"description": "A readable name, when the code's own name is not enough."
},
"description": {
"type": "string",
"description": "What the property means, in words."
},
"value": {
"$ref": "Value.json"
},
"range": {
"$ref": "#/$defs/Range"
},
"height": {
"type": "number",
"description": "The height above the ground that the property applies at, in metres, such as wind speed at 120 m. Leave it out for the quantity's standard height."
},
"geometry": {
"$ref": "Geometry.json",
"description": "Where the property applies, when only part of the record."
}
},
"required": [
"type"
],
"oneOf": [
{
"properties": {
"value": true
},
"required": [
"value"
]
},
{
"properties": {
"range": true
},
"required": [
"range"
]
}
],
"patternProperties": {
"^x-": {}
},
"unevaluatedProperties": false,
"$defs": {
"Range": {
"type": "object",
"properties": {
"minimum": {
"type": "number",
"description": "The lowest amount, inclusive."
},
"maximum": {
"type": "number",
"description": "The highest amount, inclusive."
},
"unit": {
"type": "string",
"x-ods-vocabulary": "*/units",
"description": "The unit of both bounds."
}
},
"anyOf": [
{
"properties": {
"minimum": true
},
"required": [
"minimum"
]
},
{
"properties": {
"maximum": true
},
"required": [
"maximum"
]
}
],
"description": "A range of amounts, when the property holds over a range, such as the speeds an operating state covers.",
"patternProperties": {
"^x-": {}
},
"unevaluatedProperties": false
}
},
"examples": [
{
"id": "p1",
"type": "ground_type",
"value": {
"amount": "grass"
}
},
{
"type": "rotational_speed",
"value": {
"amount": 1800,
"unit": "1/min"
}
},
{
"type": "wind_speed",
"height": 120,
"value": {
"amount": 7.4,
"unit": "m/s"
}
},
{
"type": "rotational_speed",
"range": {
"minimum": 1500,
"maximum": 1800,
"unit": "1/min"
}
}
],
"x-ods-status": "draft",
"x-ods-kind": "part",
"x-ods-module": "core",
"x-ods-changes": {
"0.1.0": "First version."
}
}