///
/// Copyright (c) 2013-2015 Sensus Metering Systems
///
using System;
using System.Text;

namespace TBF.Boxes
{
	interface IBox
	{
		/// <summary>
		/// Box name
		/// </summary>
		string Name { get; }

		/// <summary>
		/// Validity flag: true = the box value is valid
		/// </summary>
		bool Valid { get; }

		/// <summary>
		/// Clear the box value and the valid flag
		/// </summary>
		void Clear();

		/// <summary>
		/// Convert the box value to a string representation
		/// </summary>
		string ToString();

		/// <summary>
		/// Validate the string representation of the box value
		/// </summary>
		/// <param name="strVal">String representation of the parameter</param>
		/// <returns>true = string is OK, false = string is wrong (see 'message')</returns>
		bool ValidateParam(string strVal);

		/// <summary>
		/// Update the parameter from a string
		/// </summary>
		/// <param name="strVal">String representation of the box value</param>
		void UpdateParam(string strVal);
	}
}