Operating state
PartDraftv1.0.0-rc.2
An operating state: a 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.
https://opendevelopmentstandards.org/schema/1.0.0-rc.2/core/OperatingState.json
Fields
idtextnot emptyThe record's id: unique within the document.
nameRequiredtextThe name people use for the record.
descriptiontextWhat the record is, in words.
typeWhat sort of state it is, such as
full_loadoroff.propertiesList ofPartPropertyThe operating properties that set the state. A range gives the limits within which the state's emissions hold.
Links
Held by Records that embed this one, with their field that holds it.
Pointed at by Records that hold this one's id, with their field that holds it.
- AllocationPartStateShare.stateWhere and when an activity happens, and the operating states its sources run in there.
- AssumptionEntitystateA fact that an evaluation takes as true without evidence, such as an operating state or the weather, with the reason for it.
- EmissionPartstateWhat 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.
- EvidenceEntitystateOne observation, measured or calculated: what was observed, of which record, by which instrument or algorithm, over which interval, and the result. As in ISO 19156 (Observations and measurements).
Examples
An id that another example defines opens that record.
Example 2
{
"id": "state-loaded",
"name": "Loaded",
"type": "full_load",
"description": "Compressing at the licensed rate.",
"properties": [
{
"type": "rotational_speed",
"range": {
"minimum": 1500,
"maximum": 1800,
"unit": "1/min"
}
},
{
"type": "gas_flow_rate",
"value": {
"amount": 85,
"unit": "e3m3/d"
}
}
]
}Show 1 more exampleHide the other example
Example 1
{
"id": "state-idle",
"name": "Idle"
}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/OperatingState.json",
"title": "Operating state",
"description": "An operating state: a 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.",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"description": "The record's id: unique within the document."
},
"name": {
"type": "string",
"description": "The name people use for the record."
},
"description": {
"type": "string",
"description": "What the record is, in words."
},
"type": {
"type": "string",
"pattern": "^[a-z0-9]+(_[a-z0-9]+)*(\\.[a-z0-9]+(_[a-z0-9]+)*)*$",
"x-ods-vocabulary": "core/operating_state_types",
"description": "What sort of state it is, such as `full_load` or `off`."
},
"properties": {
"type": "array",
"items": {
"$ref": "Property.json"
},
"description": "The operating properties that set the state. A range gives the limits within which the state's emissions hold."
}
},
"required": [
"name"
],
"patternProperties": {
"^x-": {}
},
"unevaluatedProperties": false,
"examples": [
{
"id": "state-idle",
"name": "Idle"
},
{
"id": "state-loaded",
"name": "Loaded",
"type": "full_load",
"description": "Compressing at the licensed rate.",
"properties": [
{
"type": "rotational_speed",
"range": {
"minimum": 1500,
"maximum": 1800,
"unit": "1/min"
}
},
{
"type": "gas_flow_rate",
"value": {
"amount": 85,
"unit": "e3m3/d"
}
}
]
}
],
"x-ods-status": "draft",
"x-ods-kind": "part",
"x-ods-module": "core",
"x-ods-changes": {
"0.1.0": "First version."
}
}