CALPOLY MECHATRONICS
Documentation for all Mechatronics Labs
ME405_FP_FSC.FSC Class Reference

The FSC class uses a state space representation of a system to calculate a SINGLE output given a set of gains and a current state. More...

Public Member Functions

def __init__ (self, numStateVariables, gains=None)
 A mehtod to initialise an FSC object. More...
 
def update (self, state)
 A method used to calculate the output based on a new state. More...
 
def setGains (self, gains)
 A method to change the controller gains. More...
 

Public Attributes

 numStateVars
 
 gains
 

Detailed Description

The FSC class uses a state space representation of a system to calculate a SINGLE output given a set of gains and a current state.

To control a multiple output system an FSC object will need to be created for each output.

Constructor & Destructor Documentation

◆ __init__()

def ME405_FP_FSC.FSC.__init__ (   self,
  numStateVariables,
  gains = None 
)

A mehtod to initialise an FSC object.

Parameters
numStateVariablesThe number of state variables used to represent the system (integer).
gainsAn itterable (such as list, array, tuple, etc.) containing the numerical gains of the controler. If no gains are passed in gains will default to zero.

Member Function Documentation

◆ setGains()

def ME405_FP_FSC.FSC.setGains (   self,
  gains 
)

A method to change the controller gains.

Parameters
gainsAn itterable (such as list, array, tuple, etc.) containing the new numerical gains of the controler. If no gains are passed in gains will default to zero.

◆ update()

def ME405_FP_FSC.FSC.update (   self,
  state 
)

A method used to calculate the output based on a new state.

The state vector must be the same length as the number of states.

Parameters
stateAn itterable (such as list, array, tuple, etc.) containing the numerical state vector of the system.
Returns
The calculated output.

The documentation for this class was generated from the following file: