Class: wsim.wecControllerFcnBased¶
Inheiritance Graph¶
Parent Class Properties and Methods¶
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.
wsim.wecController¶
Inheirited Properties¶
- sampleDelayInfo
- usingSampleDelays
- wecSimObj
Inheirited Methods¶
- wecController : wsim.wecController constructor
- advanceStep : wsim.wecController/advanceStep is a function.
- finish : wsim.wecController/finish is a function.
- loggingInfo : wsim.wecController/loggingInfo is a function.
- ptoControlOutput : wsim.wecController/ptoControlOutput is a function.
- start : wsim.wecController/start is a function.
Properties¶
- numControlParams
- outputFcns
- paramsMinMax
- ptoVarSampleDelays
- ptoVariableNames
- wecSimVarSampleDelays
- wecSimVariableNames
numControlParams¶
outputFcns¶
paramsMinMax¶
ptoVarSampleDelays¶
ptoVariableNames¶
wecSimVarSampleDelays¶
wecSimVariableNames¶
Methods¶
- wecControllerFcnBased
- ptoControlOutput
- setControlParameters
wecControllerFcnBased¶
Summary¶
wsim.wecControllerFcnBased constructor
Syntax¶
ctrlobj = wsim.wecControllerFcnBased ()
ctrlobj = wsim.wecControllerFcnBased ('Parameter', Value)
Description¶
The wsim.wecControllerFcnBased class is a base class for all
function based WEC controllers which can optionally include
sample delays in the signals.
Inputs¶
All arguments are supplied as parameter-value pairs:
PTOVarSampleDelays¶
empty matrix or structure containing
specification of sample delayed logged variables from the
PTO to be used by the controller to generate the control
outputs.
WECSimVarSampleDelays¶
empty matrix or structure
containing specification of sample delayed logged (non
PTO) variables to be used by the controller to generate
the control outputs
Outputs¶
ctrlobj¶
wsim.wecControllerFcnBased object
See Also¶
ptoControlOutput¶
Summary¶
returns the desired force based on the current damping value and pto velocity
Syntax¶
value = ptoControlOutput (ctrlobj, pto_id, pto_vars)
Inputs¶
pto_id¶
unused (but provided to match the standard syntax
of the ptoControlOutput method)
pto_vars¶
structure containing the field 'RelativeVelocity'
which contains the relative velocity of the two parts of
the linear PTO.
Outputs¶
value¶
the force to be applied based on the damping
coefficient and the relative velocity of the PTO components