omnipy.components.isa.models.process_parameter_value_schema

ISA model representing a process parameter value in an investigation.

These types model ISA-JSON Investigation/Study/Assay metadata and its JSON-LD field structure.

Returned by:

• Reference Code reference omnipy components
  •  isa  IsaProcessOrProtocolApplicationSchema  parameterValues
  • isa models  process_schema  IsaProcessOrProtocolApplicationSchema  parameterValues

CLASS	DESCRIPTION
FieldType	JSON-LD type labels used for ISA process parameter values.
IsaProcessParameterValueModel	Omnipy model wrapper for ISA process parameter values.
IsaProcessParameterValueSchema	Schema for protocol parameter values applied in process steps.

FieldType

Bases: Enum

              flowchart BT
              omnipy.components.isa.models.process_parameter_value_schema.FieldType[FieldType]

              

              click omnipy.components.isa.models.process_parameter_value_schema.FieldType href "" "omnipy.components.isa.models.process_parameter_value_schema.FieldType"
            

JSON-LD type labels used for ISA process parameter values.

ATTRIBUTE	DESCRIPTION
ParameterValue	Marks a JSON object as an ISA process parameter value.

Returned by:

• Reference Code reference omnipy components
  •  isa  IsaProcessParameterValueSchema  field_type
  • isa models  process_parameter_value_schema  IsaProcessParameterValueSchema  field_type

Source code in src/omnipy/components/isa/models/process_parameter_value_schema.py

class FieldType(Enum):
    """JSON-LD type labels used for ISA process parameter values.

    Attributes:
        ParameterValue: Marks a JSON object as an ISA process parameter value.
    """

    ParameterValue = 'ParameterValue'

ParameterValue class-attribute instance-attribute

ParameterValue = 'ParameterValue'

IsaProcessParameterValueModel

Bases: Model[IsaProcessParameterValueSchema]

              flowchart BT
              omnipy.components.isa.models.process_parameter_value_schema.IsaProcessParameterValueModel[IsaProcessParameterValueModel]
              omnipy.data.model.Model[Model]
              omnipy.data._mixins.display.ModelDisplayMixin[ModelDisplayMixin]
              omnipy.data._mixins.display.BaseDisplayMixin[BaseDisplayMixin]
              omnipy.data._data_class_creator.DataClassBase[DataClassBase]

                              omnipy.data.model.Model --> omnipy.components.isa.models.process_parameter_value_schema.IsaProcessParameterValueModel
                                omnipy.data._mixins.display.ModelDisplayMixin --> omnipy.data.model.Model
                                omnipy.data._mixins.display.BaseDisplayMixin --> omnipy.data._mixins.display.ModelDisplayMixin
                

                omnipy.data._data_class_creator.DataClassBase --> omnipy.data.model.Model
                
                omnipy.util.pydantic.GenericModel --> omnipy.data.model.Model
                



              click omnipy.components.isa.models.process_parameter_value_schema.IsaProcessParameterValueModel href "" "omnipy.components.isa.models.process_parameter_value_schema.IsaProcessParameterValueModel"
              click omnipy.data.model.Model href "" "omnipy.data.model.Model"
              click omnipy.data._mixins.display.ModelDisplayMixin href "" "omnipy.data._mixins.display.ModelDisplayMixin"
              click omnipy.data._mixins.display.BaseDisplayMixin href "" "omnipy.data._mixins.display.BaseDisplayMixin"
              click omnipy.data._data_class_creator.DataClassBase href "" "omnipy.data._data_class_creator.DataClassBase"
            

Omnipy model wrapper for ISA process parameter values.

Wraps :class:IsaProcessParameterValueSchema for typed use in ISA process model structures.

Returned by:

• Reference Code reference omnipy components
  •  isa  IsaProcessOrProtocolApplicationSchema  parameterValues
  • isa models  process_schema  IsaProcessOrProtocolApplicationSchema  parameterValues

Source code in src/omnipy/components/isa/models/process_parameter_value_schema.py

class IsaProcessParameterValueModel(Model[IsaProcessParameterValueSchema]):
    """Omnipy model wrapper for ISA process parameter values.

    Wraps :class:`IsaProcessParameterValueSchema` for typed use in ISA process
    model structures.
    """

    ...

IsaProcessParameterValueSchema

Bases: pyd.BaseModel

              flowchart BT
              omnipy.components.isa.models.process_parameter_value_schema.IsaProcessParameterValueSchema[IsaProcessParameterValueSchema]

                              omnipy.util.pydantic.BaseModel --> omnipy.components.isa.models.process_parameter_value_schema.IsaProcessParameterValueSchema
                


              click omnipy.components.isa.models.process_parameter_value_schema.IsaProcessParameterValueSchema href "" "omnipy.components.isa.models.process_parameter_value_schema.IsaProcessParameterValueSchema"
            

Schema for protocol parameter values applied in process steps.

ATTRIBUTE	DESCRIPTION
category	Protocol parameter definition this value belongs to. TYPE: protocol_parameter_schema.IsaProtocolParameterModel | None
value	Scalar or ontology-backed assigned value. TYPE: ontology_annotation_schema.IsaOntologyReferenceModel | str | float | None
unit	Unit ontology annotation for quantitative values. TYPE: ontology_annotation_schema.IsaOntologyReferenceModel | None
comments	Optional comments attached to the value. TYPE: list[comment_schema.IsaCommentModel] | None

Subclassed by:

• Reference Code reference
  •  omnipy  IsaProcessParameterValueModel
  • omnipy components isa models  process_parameter_value_schema  IsaProcessParameterValueModel

CLASS	DESCRIPTION
Config	Validation settings for ISA process-parameter schema parsing.

Source code in src/omnipy/components/isa/models/process_parameter_value_schema.py

class IsaProcessParameterValueSchema(pyd.BaseModel):
    """Schema for protocol parameter values applied in process steps.

    Attributes:
        category: Protocol parameter definition this value belongs to.
        value: Scalar or ontology-backed assigned value.
        unit: Unit ontology annotation for quantitative values.
        comments: Optional comments attached to the value.
    """
    class Config:
        """Validation settings for ISA process-parameter schema parsing.

        Attributes:
            extra: Rejects unknown keys in input payloads.
            use_enum_values: Emits enum members by value string.
        """

        extra = pyd.Extra.forbid
        use_enum_values = True

    field_id: Optional[str] = pyd.Field(None, alias='@id')
    field_context: Optional[str] = pyd.Field(None, alias='@context')
    field_type: Optional[FieldType] = pyd.Field(None, alias='@type')
    category: Optional[protocol_parameter_schema.IsaProtocolParameterModel] = None
    value: Optional[Union[ontology_annotation_schema.IsaOntologyReferenceModel, str, float]] = None
    unit: Optional[ontology_annotation_schema.IsaOntologyReferenceModel] = None
    comments: Optional[List[comment_schema.IsaCommentModel]] = None

category class-attribute instance-attribute

category: protocol_parameter_schema.IsaProtocolParameterModel | None = None

comments class-attribute instance-attribute

comments: list[comment_schema.IsaCommentModel] | None = None

field_context class-attribute instance-attribute

field_context: str | None = pyd.Field(None, alias='@context')

field_id class-attribute instance-attribute

field_id: str | None = pyd.Field(None, alias='@id')

field_type class-attribute instance-attribute

field_type: FieldType | None = pyd.Field(None, alias='@type')

unit class-attribute instance-attribute

unit: ontology_annotation_schema.IsaOntologyReferenceModel | None = None

value class-attribute instance-attribute

value: ontology_annotation_schema.IsaOntologyReferenceModel | str | float | None = None

Config

Validation settings for ISA process-parameter schema parsing.

ATTRIBUTE	DESCRIPTION
extra	Rejects unknown keys in input payloads.
use_enum_values	Emits enum members by value string.

Source code in src/omnipy/components/isa/models/process_parameter_value_schema.py

class Config:
    """Validation settings for ISA process-parameter schema parsing.

    Attributes:
        extra: Rejects unknown keys in input payloads.
        use_enum_values: Emits enum members by value string.
    """

    extra = pyd.Extra.forbid
    use_enum_values = True

extra class-attribute instance-attribute

extra = pyd.Extra.forbid

use_enum_values class-attribute instance-attribute

use_enum_values = True