// -----------------------------------------------------------------------------
/// @file  CalibrationSetpoints.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 CalibrationSetpoints.h
/// @ingroup {group_name}

#ifndef CALIBRATIONSETPOINTS_H_
#define CALIBRATIONSETPOINTS_H_


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

#include "CalibrationSetpoint.h"

enum CALIBRATION_SETPOINT_ID
{
   CALIBRATION_SETPOINT_CATHODE,
   CALIBRATION_SETPOINT_MCP,
   CALIBRATION_SETPOINT_TESLA,
   CALIBRATION_SETPOINT_ANODE,
   CALIBRATION_SETPOINT_LAST
};

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

struct CalibrationSetpoints
{
   struct CalibrationSetpoint setpoints[CALIBRATION_SETPOINT_LAST];
   enum CALIBRATION_SETPOINT_ID currentActiveSetpointSet;
};

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



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

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


/** ----------------------------------------------------------------------------
 * CalibrationSetpoints_getSetpoint
 * Description of function
 *
 * @param	self
 * @param	setpointIdentifier
 * @return	struct CalibrationSetpoint*
 *
 * @todo
 * -----------------------------------------------------------------------------
 */
extern struct CalibrationSetpoint* CalibrationSetpoints_getSetpoint(struct CalibrationSetpoints* self, enum CALIBRATION_SETPOINT_ID setpointIdentifier);


/** ----------------------------------------------------------------------------
 * CalibrationSetpoints_setActiveSetpointSet
 * Description of function
 *
 * @param	para1_name
 * @param	para2_name
 * @return	return_type
 *
 * @todo
 * -----------------------------------------------------------------------------
 */
extern void CalibrationSetpoints_setActiveSetpointSet(struct CalibrationSetpoints* self,  enum CALIBRATION_SETPOINT_ID setpointIdentifier);


/** ----------------------------------------------------------------------------
 * CalibrationSetpoints_getActiveSetpointSet
 * Description of function
 *
 * @param   self
 * @param   setpointIdentifier
 * @return  struct CalibrationSetpoint*
 *
 * @todo
 * -----------------------------------------------------------------------------
 */
extern struct CalibrationSetpoint* CalibrationSetpoints_getActiveSetpointSet(struct CalibrationSetpoints* self);



#endif /* CALIBRATIONSETPOINTS_H_ */