sbol3.om_prefix
===============

.. py:module:: sbol3.om_prefix


Classes
-------

.. autoapisummary::

   sbol3.om_prefix.BinaryPrefix
   sbol3.om_prefix.Prefix
   sbol3.om_prefix.SIPrefix


Functions
---------

.. autoapisummary::

   sbol3.om_prefix.build_binary_prefix
   sbol3.om_prefix.build_si_prefix


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

.. py:class:: BinaryPrefix(identity: str, symbol: str, label: str, factor: float, *, 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[SBOLObject] = None, type_uri: str = OM_BINARY_PREFIX)

   Bases: :py:obj:`Prefix`


   The purpose of the om:BinaryPrefix class is to describe standard
   binary prefixes such as "kibi," "mebi," "gibi," etc.  These
   prefixes commonly precede units of information such as "bit" and
   "byte."



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

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

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




.. py:class:: Prefix(identity: str, symbol: str, label: str, factor: float, 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[SBOLObject] = None)

   Bases: :py:obj:`CustomTopLevel`, :py:obj:`abc.ABC`


   As adopted by SBOL, om:Prefix is an abstract class that is extended
   by other classes to describe factors that are commonly represented
   by standard unit prefixes. For example, the factor 10**−3 is
   represented by the standard unit prefix "milli".

   See Appendix A Section A.2 of the SBOL 3.0 specificiation.



   .. py:attribute:: alternative_labels


   .. py:attribute:: alternative_symbols


   .. py:attribute:: comment


   .. py:attribute:: factor


   .. py:attribute:: label


   .. py:attribute:: long_comment


   .. py:attribute:: symbol


   .. py:method:: validate(report: ValidationReport = None) -> ValidationReport


.. py:class:: SIPrefix(identity: str, symbol: str, label: str, factor: float, *, 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[SBOLObject] = None, type_uri: str = OM_SI_PREFIX)

   Bases: :py:obj:`Prefix`


   The purpose of the om:SIPrefix class is to describe standard SI
   prefixes such as "milli," "centi," "kilo," etc.



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

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

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




.. py:function:: build_binary_prefix(identity: str, *, type_uri: str = OM_BINARY_PREFIX) -> SBOLObject

.. py:function:: build_si_prefix(identity: str, *, type_uri: str = OM_SI_PREFIX) -> SBOLObject