Reference·Classes

Class: ToolUnit

One TVBO unit as a single tool writes it.

A tool’s unit vocabulary is a fact about that tool, not about the unit — LEMS calls Hz a per_time quantity and writes it per_s, and no other backend need agree. Keyed by the UnitEnum value so a record states only the units its tool knows.

URI: tvbo_sw:class/ToolUnit

 classDiagram
    class ToolUnit
    click ToolUnit href "./ToolUnit.html"
      ToolUnit : dimension
        
          
    
        
        
        ToolUnit --> "0..1" String : dimension
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      ToolUnit : symbol
        
          
    
        
        
        ToolUnit --> "0..1" String : symbol
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      ToolUnit : unit
        
          
    
        
        
        ToolUnit --> "1" String : unit
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      

Slots

Name	Cardinality and Range	Description	Inheritance
unit	1 xsd:string	The UnitEnum value this entry translates	direct
dimension	0..1 xsd:string	The tool’s name for the physical dimension of this unit	direct
symbol	0..1 xsd:string	The tool’s spelling of the unit itself, appended to numeric values	direct

Usages

used by	used in	type	used
SimulationTool	units	range	ToolUnit

Identifier and Mapping Information

Schema Source

• from schema: https://w3id.org/tvbo/software

Mappings

Mapping Type	Mapped Value
self	tvbo_sw:ToolUnit
native	tvbo_sw:ToolUnit

LinkML Source

Direct

name: ToolUnit
description: 'One TVBO unit as a single tool writes it.

  A tool''s unit vocabulary is a fact about that tool, not about the unit — LEMS calls
  `Hz` a `per_time` quantity and writes it `per_s`, and no other backend need agree.
  Keyed by the `UnitEnum` value so a record states only the units its tool knows.'
from_schema: https://w3id.org/tvbo/software
attributes:
  unit:
    name: unit
    annotations:
      collection_key:
        tag: collection_key
        value: true
    description: The `UnitEnum` value this entry translates.
    from_schema: https://w3id.org/tvbo/software
    key: true
    domain_of:
    - CommonCoordinateSpace
    - ToolUnit
    - MeasureSpec
    - NamedArray
    - Edge
    - Observation
    - StateVariable
    - Parameter
    - Argument
    - DerivedParameter
    - DerivedVariable
    - ExplorationAxis
    - Integrator
    - TimeSeries
    - NDArray
    - SpatialField
    range: string
  dimension:
    name: dimension
    description: The tool's name for the physical dimension of this unit. Absent where
      the tool has no dimension for it.
    from_schema: https://w3id.org/tvbo/software
    rank: 1000
    domain_of:
    - ToolUnit
    - CouplingInput
    range: string
  symbol:
    name: symbol
    description: The tool's spelling of the unit itself, appended to numeric values.
      Absent where the tool writes the value bare.
    from_schema: https://w3id.org/tvbo/software
    domain_of:
    - ToolUnit
    - StateVariable
    - Parameter
    - CouplingInput
    - DerivedParameter
    - DerivedVariable
    range: string

Induced

name: ToolUnit
description: 'One TVBO unit as a single tool writes it.

  A tool''s unit vocabulary is a fact about that tool, not about the unit — LEMS calls
  `Hz` a `per_time` quantity and writes it `per_s`, and no other backend need agree.
  Keyed by the `UnitEnum` value so a record states only the units its tool knows.'
from_schema: https://w3id.org/tvbo/software
attributes:
  unit:
    name: unit
    annotations:
      collection_key:
        tag: collection_key
        value: true
    description: The `UnitEnum` value this entry translates.
    from_schema: https://w3id.org/tvbo/software
    key: true
    owner: ToolUnit
    domain_of:
    - CommonCoordinateSpace
    - ToolUnit
    - MeasureSpec
    - NamedArray
    - Edge
    - Observation
    - StateVariable
    - Parameter
    - Argument
    - DerivedParameter
    - DerivedVariable
    - ExplorationAxis
    - Integrator
    - TimeSeries
    - NDArray
    - SpatialField
    range: string
    required: true
  dimension:
    name: dimension
    description: The tool's name for the physical dimension of this unit. Absent where
      the tool has no dimension for it.
    from_schema: https://w3id.org/tvbo/software
    rank: 1000
    owner: ToolUnit
    domain_of:
    - ToolUnit
    - CouplingInput
    range: string
  symbol:
    name: symbol
    description: The tool's spelling of the unit itself, appended to numeric values.
      Absent where the tool writes the value bare.
    from_schema: https://w3id.org/tvbo/software
    owner: ToolUnit
    domain_of:
    - ToolUnit
    - StateVariable
    - Parameter
    - CouplingInput
    - DerivedParameter
    - DerivedVariable
    range: string