Class: wsim.wecController
=========================

Inheiritance Graph
--------------------------------------------------
.. raw:: html

   <hr>

.. graphviz::

   digraph graph_for_wecController {
      "handle" -> "wsim.wecController";
   }

Parent Class Properties and Methods
--------------------------------------------------
.. raw:: html

   <hr>

handle
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Inheirited Properties
""""""""""""""""""""""""""""""""""""""""""""""""""

None

Inheirited Methods
""""""""""""""""""""""""""""""""""""""""""""""""""

* addlistener : *ADDLISTENER  Add listener for event.*
* addlistener : *ADDLISTENER  Add listener for event.*
* addlistener : *ADDLISTENER  Add listener for event.*
* addlistener : *ADDLISTENER  Add listener for event.*
* addlistener : *ADDLISTENER  Add listener for event.*
* delete : *DELETE   Delete a handle object.*
* eq : *== (EQ)   Test handle equality.*
* findobj : *FINDOBJ   Find objects matching specified conditions.*
* findprop : *FINDPROP   Find property of MATLAB handle object.*
* ge : *>= (GE)   Greater than or equal relation for handles.*
* gt : *> (GT)   Greater than relation for handles.*
* isvalid : *ISVALID   Test handle validity.*
* le : *<= (LE)   Less than or equal relation for handles.*
* listener : *LISTENER  Add listener for event without binding the listener to the source object.*
* listener : *LISTENER  Add listener for event without binding the listener to the source object.*
* listener : *LISTENER  Add listener for event without binding the listener to the source object.*
* listener : *LISTENER  Add listener for event without binding the listener to the source object.*
* listener : *LISTENER  Add listener for event without binding the listener to the source object.*
* lt : *< (LT)   Less than relation for handles.*
* ne : *~= (NE)   Not equal relation for handles.*
* notify : *NOTIFY   Notify listeners of event.*
* notify : *NOTIFY   Notify listeners of event.*


Properties
----------
.. raw:: html

   <hr>

* sampleDelayInfo
* usingSampleDelays
* wecSimObj


sampleDelayInfo
^^^^^^^^^^^^^^^



usingSampleDelays
^^^^^^^^^^^^^^^^^



wecSimObj
^^^^^^^^^

the wsim.wecSim object running the simulation

Methods
-------
.. raw:: html

   <hr>

* wecController
* advanceStep
* finish
* loggingInfo
* ptoControlOutput
* start


wecController
^^^^^^^^^^^^^

.. raw:: html

   <hr>

Summary
""""""""""""""""""""

wsim.wecController constructor


Syntax
""""""""""""""""""""

.. code-block:: none

   ctrlobj = wsim.wecController ()
   ctrlobj = wsim.wecController ('Parameter', Value)
  

Description
""""""""""""""""""""

.. code-block:: none

   The wsim.wecController class is a base class for all
   WEC controllers
  

Inputs
""""""""""""""""""""

SampleDelays
""""""""""""

.. code-block:: none

   


InitialValues
"""""""""""""

.. code-block:: none

   


Additional arguments may be supplied as parameter-value pairs:


SampleDelays
""""""""""""

.. code-block:: none

   empty matrix or structure containing 
   specification of sample delayed logged variables to be
   used by the controller to generate the control outputs. If
   a structure it must contain at least the following fields:
   
   SampleDelays : 
   
   InitialValues : 
   


Outputs
""""""""""""""""""""

ctrlobj
"""""""

.. code-block:: none

   wsim.wecController object



See Also
""""""""""""""""""""

.. code-block:: none



advanceStep
^^^^^^^^^^^

.. raw:: html

   <hr>

Summary
""""""""""""""""""""

wsim.wecController/advanceStep is a function.
advanceStep(self)



finish
^^^^^^

.. raw:: html

   <hr>

Summary
""""""""""""""""""""

wsim.wecController/finish is a function.
finish(self)



loggingInfo
^^^^^^^^^^^

.. raw:: html

   <hr>

Summary
""""""""""""""""""""

wsim.wecController/loggingInfo is a function.
info = loggingInfo(self)



ptoControlOutput
^^^^^^^^^^^^^^^^

.. raw:: html

   <hr>

Summary
""""""""""""""""""""

wsim.wecController/ptoControlOutput is a function.
[value, info] = ptoControlOutput(self, id, pto_internal_variables)



start
^^^^^

.. raw:: html

   <hr>

Summary
""""""""""""""""""""

wsim.wecController/start is a function.
start(self)