sbol3.varcomp
=============

.. py:module:: sbol3.varcomp


Classes
-------

.. autoapisummary::

   sbol3.varcomp.VariableFeature


Functions
---------

.. autoapisummary::

   sbol3.varcomp.build_variable_feature


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

.. py:class:: VariableFeature(cardinality: str, variable: Union[Identified, str], *, variants: List[Union[Identified, str]] = None, variant_collections: Union[Union[Identified, str], List[Union[Identified, str]]] = None, variant_derivations: List[Union[Identified, str]] = None, variant_measures: List[Union[Identified, str]] = None, name: str = None, description: str = None, derived_from: List[str] = None, generated_by: List[str] = None, measures: List[SBOLObject] = None, identity: str = None, type_uri: str = SBOL_VARIABLE_FEATURE)

   Bases: :py:obj:`Identified`


   As described above, the VariableComponent VariableFeature class
   specifies a variable and set of values that will replace one of
   the SubComponent Feature objects in the template of a
   CombinatorialDerivation. The variable is specified by the variable
   property, and the set of values is defined by the union of
   Component objects referred to by the variant, variantCollection,
   and variantDerivation properties.



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

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

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




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


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


   .. py:attribute:: variable


   .. py:attribute:: variant_collections


   .. py:attribute:: variant_derivations


   .. py:attribute:: variant_measures


   .. py:attribute:: variants


.. py:function:: build_variable_feature(identity: str, type_uri: str = SBOL_VARIABLE_FEATURE)

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