// -----------------------------------------------------------------------------
/// @file  PIDParameters.h
/// @brief File description
// -----------------------------------------------------------------------------
//  Micro-Key bv
//  Industrieweg 28, 9804 TG Noordhorn
//  Postbus 92, 9800 AB Zuidhorn
//  The Netherlands
//  Tel: +31 594 503020
//  Fax: +31 594 505825
//  Email: support@microkey.nl
//  Web: www.microkey.nl
// -----------------------------------------------------------------------------
/// $Revision: $
/// $Author: $
/// $Date: $
//  (c) 2015 Micro-Key bv
// -----------------------------------------------------------------------------

/// @defgroup {group_name} {group_description}
/// Description

/// @file PIDParameters.h
/// @ingroup {group_name}

#ifndef PIDPARAMETERS_H_
#define PIDPARAMETERS_H_


// -----------------------------------------------------------------------------
// Include files 
// -----------------------------------------------------------------------------


// -----------------------------------------------------------------------------
// Constant and macro definitions 
// -----------------------------------------------------------------------------

struct PIDParameters
{
   int Kp;                             // proportional constant
   int Ki;                             // integration constant
   int Kd;                             // differential constant
   int iMin;
   int iMax;
};

// -----------------------------------------------------------------------------
// Type definitions. 
// -----------------------------------------------------------------------------



// -----------------------------------------------------------------------------
// Function declarations 
// -----------------------------------------------------------------------------

/** ----------------------------------------------------------------------------
 * PIDParameters_generateDefaultParameters
 * Description of function
 *
 * @param	self
 * @param
 * @return	void
 *
 * @todo
 * -----------------------------------------------------------------------------
 */
extern void PIDParameters_generateDefaultParameters(struct PIDParameters* self);


/** ----------------------------------------------------------------------------
 * PIDParameters_setKp
 * Description of function
 *
 * @param	self
 * @param	Kp
 * @return	void
 *
 * @todo
 * -----------------------------------------------------------------------------
 */
extern void PIDParameters_setKp(struct PIDParameters* self, int Kp);


/** ----------------------------------------------------------------------------
 * PIDParameters_setKi
 * Description of function
 *
 * @param   self
 * @param   Ki
 * @return  void
 *
 * @todo
 * -----------------------------------------------------------------------------
 */
extern void PIDParameters_setKi(struct PIDParameters* self, int Ki);


/** ----------------------------------------------------------------------------
 * PIDParameters_setKd
 * Description of function
 *
 * @param   self
 * @param   Kd
 * @return  void
 *
 * @todo
 * -----------------------------------------------------------------------------
 */
extern void PIDParameters_setKd(struct PIDParameters* self, int Kd);


/** ----------------------------------------------------------------------------
 * PIDParameters_setiMin
 * Description of function
 *
 * @param   self
 * @param   Kp
 * @return  void
 *
 * @todo
 * -----------------------------------------------------------------------------
 */
extern void PIDParameters_setiMin(struct PIDParameters* self, int iMin);


/** ----------------------------------------------------------------------------
 * PIDParameters_setiMax
 * Description of function
 *
 * @param   self
 * @param   Kp
 * @return  void
 *
 * @todo
 * -----------------------------------------------------------------------------
 */
extern void PIDParameters_setiMax(struct PIDParameters* self, int iMax);
#endif /* PIDPARAMETERS_H_ */