Vessel#

pydantic model pyenzyme.enzymeml.core.vessel.Vessel[source]#

Bases: EnzymeMLBase

Show JSON schema
{
   "title": "Vessel",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "description": "Name of the used vessel.",
         "template_alias": "Name",
         "type": "string"
      },
      "volume": {
         "title": "Volume",
         "description": "Volumetric value of the vessel.",
         "template_alias": "Volume value",
         "exclusiveMinimum": 0,
         "type": "number"
      },
      "unit": {
         "title": "Unit",
         "description": "Volumetric unit of the vessel.",
         "template_alias": "Volume unit",
         "type": "string"
      },
      "constant": {
         "title": "Constant",
         "description": "Whether the volume of the vessel is constant or not.",
         "default": true,
         "type": "boolean"
      },
      "meta_id": {
         "title": "Meta Id",
         "description": "Unique meta identifier of the vessel.",
         "type": "string"
      },
      "id": {
         "title": "Id",
         "description": "Unique identifier of the vessel.",
         "pattern": "v[\\d]+",
         "template_alias": "ID",
         "type": "string"
      },
      "uri": {
         "title": "Uri",
         "description": "URI of the vessel.",
         "type": "string"
      },
      "creator_id": {
         "title": "Creator Id",
         "description": "Unique identifier of the author.",
         "type": "string"
      }
   },
   "required": [
      "name"
   ]
}

Config
  • validate_all: bool = True

  • validate_assignment: bool = True

Fields
Validators
field constant: bool = True#

Whether the volume of the vessel is constant or not.

field creator_id: Optional[str] = None#

Unique identifier of the author.

field id: Optional[str] = None#

Unique identifier of the vessel.

Constraints
  • pattern = v[d]+

Validated by
field meta_id: Optional[str] = None#

Unique meta identifier of the vessel.

field name: str [Required]#

Name of the used vessel.

field unit: Optional[str] = None#

Volumetric unit of the vessel.

field uri: Optional[str] = None#

URI of the vessel.

field volume: Optional[PositiveFloat] = None#

Volumetric value of the vessel.

Constraints
  • exclusiveMinimum = 0

getConstant()[source]#

Deprecated since version Use: the attribute constant instead.

getId()[source]#

Deprecated since version Use: the attribute id instead.

getMetaid()[source]#

Deprecated since version Use: the attribute meta_id instead.

getName()[source]#

Deprecated since version Use: the attribute name instead.

getSize()[source]#

Deprecated since version Use: the attribute volume instead.

getUnit()[source]#

Deprecated since version Use: the attribute unit instead.

validator set_meta_id  »  id[source]#

Sets the meta ID when an ID is provided

unitdef()[source]#

Returns the appropriate unitdef if an enzmldoc is given