sbol3.location
==============

.. py:module:: sbol3.location


Attributes
----------

.. autoapisummary::

   sbol3.location.int_property


Classes
-------

.. autoapisummary::

   sbol3.location.Cut
   sbol3.location.EntireSequence
   sbol3.location.Location
   sbol3.location.Range


Functions
---------

.. autoapisummary::

   sbol3.location.build_cut
   sbol3.location.build_entire_sequence
   sbol3.location.build_range


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

.. py:class:: Cut(sequence: Union[Sequence, str], at: int, *, orientation: str = None, order: int = None, identity: str = None, type_uri: str = SBOL_CUT)

   Bases: :py:obj:`Location`


   The Cut class has been introduced to enable the specification of a
   region between two discrete positions. This specification is
   accomplished using the at property, which specifies a discrete
   position that corresponds to the index of a character in the
   elements String of a Sequence (except in the case when at is equal
   to zero).



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

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

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



   .. py:attribute:: at
      :type:  int_property


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


.. py:class:: EntireSequence(sequence: Union[Sequence, str], *, orientation: str = None, order: int = None, identity: str = None, type_uri: str = SBOL_ENTIRE_SEQUENCE)

   Bases: :py:obj:`Location`


   The EntireSequence class does not have any additional
   properties. Use of this class indicates that the linked Sequence
   describes the entirety of the Component or Feature parent of this
   Location object.



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

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

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




.. py:class:: Location(sequence: Union[Sequence, str], identity: str, type_uri: str, *, orientation: Optional[str] = None, order: int = None)

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


   The Location class is used to represent the location of Features
   within Sequences. This class is extended by the Range, Cut, and
   EntireSequence classes



   .. py:attribute:: order


   .. py:attribute:: orientation
      :type:  sbol3.typing.uri_singleton


   .. py:attribute:: sequence


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


.. py:class:: Range(sequence: Union[Sequence, str], start: int, end: int, *, orientation: str = None, order: int = None, identity: str = None, type_uri: str = SBOL_RANGE)

   Bases: :py:obj:`Location`


   A Range object specifies a region via discrete, inclusive start and
   end positions that correspond to indices for characters in the
   elements String of a Sequence.

   Note that the index of the first location is 1, as is typical
   practice in biology, rather than 0, as is typical practice in
   computer science.



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

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

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




   .. py:attribute:: end
      :type:  int_property


   .. py:attribute:: start
      :type:  int_property


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


.. py:function:: build_cut(identity: str, type_uri: str = SBOL_CUT)

   Used by Document to construct a Cut when reading an SBOL file.
       


.. py:function:: build_entire_sequence(identity: str, type_uri: str = SBOL_ENTIRE_SEQUENCE)

   Used by Document to construct an EntireSequence when reading an SBOL file.
       


.. py:function:: build_range(identity: str, type_uri: str = SBOL_RANGE)

   Used by Document to construct a Range when reading an SBOL file.
       


.. py:data:: int_property