sbol3.om_compound
=================

.. py:module:: sbol3.om_compound


Classes
-------

.. autoapisummary::

   sbol3.om_compound.CompoundUnit
   sbol3.om_compound.UnitDivision
   sbol3.om_compound.UnitExponentiation
   sbol3.om_compound.UnitMultiplication


Functions
---------

.. autoapisummary::

   sbol3.om_compound.build_unit_division
   sbol3.om_compound.build_unit_exponentiation
   sbol3.om_compound.build_unit_multiplication


Module Contents
---------------

.. py:class:: CompoundUnit(identity: str, symbol: str, label: str, type_uri: str, *, alternative_symbols: List[str] = None, alternative_labels: List[str] = None, comment: str = None, long_comment: str = None, namespace: str = None, attachments: List[str] = None, name: str = None, description: str = None, derived_from: List[str] = None, generated_by: List[str] = None, measures: List[sbol3.SBOLObject] = None)

   Bases: :py:obj:`sbol3.om_unit.Unit`, :py:obj:`abc.ABC`


   As adopted by SBOL, om:CompoundUnit is an abstract class that is
   extended by other classes to describe units of measure that can be
   represented as combinations of multiple other units of measure.



.. py:class:: UnitDivision(identity: str, symbol: str, label: str, numerator: Union[sbol3.om_unit.Unit, str], denominator: Union[sbol3.om_unit.Unit, str], *, alternative_symbols: List[str] = None, alternative_labels: List[str] = None, comment: str = None, long_comment: str = None, namespace: str = None, attachments: List[str] = None, name: str = None, description: str = None, derived_from: List[str] = None, generated_by: List[str] = None, measures: List[sbol3.SBOLObject] = None, type_uri: str = OM_UNIT_DIVISION)

   Bases: :py:obj:`CompoundUnit`


   The purpose of the om:UnitDivision class is to describe a unit of
   measure that is the division of one unit of measure by another.



   .. py:method:: accept(visitor: Any) -> Any

      Invokes `visit_unit_division` on `visitor` with `self` as the only
      argument.

      :param visitor: The visitor instance
      :type visitor: Any
      :raises AttributeError: If visitor lacks a visit_unit_division method
      :return: Whatever `visitor.visit_unit_division` returns
      :rtype: Any




   .. py:attribute:: denominator


   .. py:attribute:: numerator


.. py:class:: UnitExponentiation(identity: str, symbol: str, label: str, base: Union[sbol3.om_unit.Unit, str], exponent: int, *, alternative_symbols: List[str] = None, alternative_labels: List[str] = None, comment: str = None, long_comment: str = None, namespace: str = None, attachments: List[str] = None, name: str = None, description: str = None, derived_from: List[str] = None, generated_by: List[str] = None, measures: List[sbol3.SBOLObject] = None, type_uri: str = OM_UNIT_EXPONENTIATION)

   Bases: :py:obj:`CompoundUnit`


   The purpose of the om:UnitExponentiation class is to describe a
   unit of measure that is raised to an integer power.



   .. py:method:: accept(visitor: Any) -> Any

      Invokes `visit_unit_exponentiation` on `visitor` with `self` as the
      only argument.

      :param visitor: The visitor instance
      :type visitor: Any
      :raises AttributeError: If visitor lacks a visit_unit_exponentiation
                              method
      :return: Whatever `visitor.visit_unit_exponentiation` returns
      :rtype: Any




   .. py:attribute:: base


   .. py:attribute:: exponent


.. py:class:: UnitMultiplication(identity: str, symbol: str, label: str, term1: Union[sbol3.om_unit.Unit, str], term2: Union[sbol3.om_unit.Unit, str], *, alternative_symbols: List[str] = None, alternative_labels: List[str] = None, comment: str = None, long_comment: str = None, namespace: str = None, attachments: List[str] = None, name: str = None, description: str = None, derived_from: List[str] = None, generated_by: List[str] = None, measures: List[sbol3.SBOLObject] = None, type_uri: str = OM_UNIT_MULTIPLICATION)

   Bases: :py:obj:`CompoundUnit`


   The purpose of the om:UnitMultiplication class is to describe a
   unit of measure that is the multiplication of two other units of
   measure.



   .. py:method:: accept(visitor: Any) -> Any

      Invokes `visit_unit_multiplication` on `visitor` with `self` as the
      only argument.

      :param visitor: The visitor instance
      :type visitor: Any
      :raises AttributeError: If visitor lacks a visit_unit_multiplication
                              method
      :return: Whatever `visitor.visit_unit_multiplication` returns
      :rtype: Any




   .. py:attribute:: term1


   .. py:attribute:: term2


.. py:function:: build_unit_division(identity: str, *, type_uri: str = OM_UNIT_DIVISION) -> sbol3.SBOLObject

.. py:function:: build_unit_exponentiation(identity: str, *, type_uri: str = OM_UNIT_EXPONENTIATION) -> sbol3.SBOLObject

.. py:function:: build_unit_multiplication(identity: str, *, type_uri: str = OM_UNIT_MULTIPLICATION) -> sbol3.SBOLObject