BooleanVar
==========

(class from :py:mod:`pyomo.core.base.boolean_var`)

.. testsetup:: *

   # import everything from the module containing this class so that
   # doctests for the class docstrings see the correct environment
   from pyomo.core.base.boolean_var import *
   try:
       from pyomo.core.base.boolean_var import _autosummary_doctest_setup
       _autosummary_doctest_setup()
   except ImportError:
       pass

.. currentmodule:: pyomo.core.base.boolean_var



.. autoclass:: pyomo.core.base.boolean_var::BooleanVar
   :members:
   :show-inheritance:
   :inherited-members:

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~BooleanVar.__init__
      ~BooleanVar.add
      ~BooleanVar.clear
      ~BooleanVar.clear_suffix_value
      ~BooleanVar.cname
      ~BooleanVar.construct
      ~BooleanVar.dim
      ~BooleanVar.display
      ~BooleanVar.extract_values
      ~BooleanVar.flag_as_stale
      ~BooleanVar.get_suffix_value
      ~BooleanVar.get_values
      ~BooleanVar.getname
      ~BooleanVar.id_index_map
      ~BooleanVar.index_set
      ~BooleanVar.is_component_type
      ~BooleanVar.is_constructed
      ~BooleanVar.is_expression_type
      ~BooleanVar.is_indexed
      ~BooleanVar.is_logical_type
      ~BooleanVar.is_named_expression_type
      ~BooleanVar.is_numeric_type
      ~BooleanVar.is_parameter_type
      ~BooleanVar.is_reference
      ~BooleanVar.is_variable_type
      ~BooleanVar.items
      ~BooleanVar.iteritems
      ~BooleanVar.iterkeys
      ~BooleanVar.itervalues
      ~BooleanVar.keys
      ~BooleanVar.model
      ~BooleanVar.parent_block
      ~BooleanVar.parent_component
      ~BooleanVar.pprint
      ~BooleanVar.reconstruct
      ~BooleanVar.root_block
      ~BooleanVar.set_suffix_value
      ~BooleanVar.set_value
      ~BooleanVar.set_values
      ~BooleanVar.to_dense_data
      ~BooleanVar.type
      ~BooleanVar.valid_model_component
      ~BooleanVar.values
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~BooleanVar.active
      ~BooleanVar.ctype
      ~BooleanVar.local_name
      ~BooleanVar.name
   
   

   .. rubric:: Member Documentation