///
/// Copyright (c) 2013-2015 Sensus Metering Systems
///
namespace TBF.BenchControl.Generic
{
	public interface IParamsProvider
	{
		string ComponentName { get; }

		/// <summary>
		/// Number of parameters
		/// </summary>
		int ParamsCount();

		/// <summary>
		/// Parameter names
		/// </summary>
		/// <param name="ix">Zero based index of the parameter</param>
		string ParamName(int ix);

		/// <summary>
		/// Parameter values in string form
		/// </summary>
		/// <param name="ix">Zero based index of the parameter</param>
		string ToString(int ix);

		/// <summary>
		/// Initialize values of all parameters
		/// </summary>
		void InitializeAll();

		/// <summary>
		/// Validates the string representation of a parameter
		/// </summary>
		/// <param name="ix">Zero based index of the parameter</param>
		/// <param name="strValue">String representation of the parameter</param>
		/// <param name="message">Warning message in case the string is wrong or null</param>
		/// <returns>true = string is OK, false = string is wrong (see 'message')</returns>
		bool ValidateParam(int ix, string strValue, out string message);

		/// <summary>
		/// Update the parameter from a string
		/// </summary>
		/// <param name="ix">Zero based index of the parameter</param>
		/// <param name="strValue">String representation of the parameter</param>
		void UpdateParam(int ix, string strValue);

		void UpdateDbEntity();
	}
}