SMIDataType.cs

// This file is part of SNMP#NET.
// 
// SNMP#NET is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// SNMP#NET is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with SNMP#NET.  If not, see <http://www.gnu.org/licenses/>.
// 
using System;

namespace SnmpSharpNet
{
	/// <summary>
	/// Collection of static helper methods making operations with SMI data types simpler and easier.
	/// </summary>
	public sealed class SMIDataType
	{

		private SMIDataType ()
		{
		}
		/// <summary>
		/// Get class instance for the SMI value type with the specific TLV encoding type code.
		/// </summary>
		/// <param name="asnType">SMI type code</param>
		/// <returns>Correct SMI type class instance for the data type or null if type is not recognized</returns>
		public static AsnType GetSyntaxObject (byte asnType)
		{
			if (!SMIDataType.IsValidType (asnType))
				return null;
			return SMIDataType.GetSyntaxObject ((SMIDataTypeCode)asnType);
		}
		/// <summary>Used to create correct variable type object for the specified encoded type</summary>
		/// <param name="asnType">ASN.1 type code</param>
		/// <returns>A new object matching type supplied or null if type was not recognized.</returns>
		public static AsnType GetSyntaxObject (SMIDataTypeCode asnType)
		{
			AsnType obj = null;
			if (asnType == SMIDataTypeCode.Integer)
				obj = new Integer32 ();
			else if (asnType == SMIDataTypeCode.Counter32)
				obj = new Counter32 ();
			else if (asnType == SMIDataTypeCode.Gauge32)
				obj = new Gauge32 ();
			else if (asnType == SMIDataTypeCode.Counter64)
				obj = new Counter64 ();
			else if (asnType == SMIDataTypeCode.TimeTicks)
				obj = new TimeTicks ();
			else if (asnType == SMIDataTypeCode.OctetString)
				obj = new OctetString ();
			else if (asnType == SMIDataTypeCode.Opaque)
				obj = new Opaque ();
			else if (asnType == SMIDataTypeCode.IPAddress)
				obj = new IpAddress ();
			else if (asnType == SMIDataTypeCode.ObjectId)
				obj = new Oid ();
			else if (asnType == SMIDataTypeCode.PartyClock)
				obj = new V2PartyClock ();
			else if (asnType == SMIDataTypeCode.NoSuchInstance)
				obj = new NoSuchInstance ();
			else if (asnType == SMIDataTypeCode.NoSuchObject)
				obj = new NoSuchObject ();
			else if (asnType == SMIDataTypeCode.EndOfMibView)
				obj = new EndOfMibView ();
			else if (asnType == SMIDataTypeCode.Null)
			{
				obj = new Null ();
			}

			return obj;
		}
		/// <summary>
		/// Return SNMP type object of the type specified by name. Supported variable types are:
		/// <see cref="Integer32"/>, <see cref="Counter32"/>, <see cref="Gauge32"/>, <see cref="Counter64"/>,
		/// <see cref="TimeTicks"/>, <see cref="OctetString"/>, <see cref="IpAddress"/>, <see cref="Oid"/>, and
		/// <see cref="Null"/>.
		/// 
		/// Type names are the same as support class names compared without case sensitivity (e.g. Integer == INTEGER).
		/// </summary>
		/// <param name="name">Name of the object type (not case sensitive)</param>
		/// <returns>New <see cref="AsnType"/> object.</returns>
		public static AsnType GetSyntaxObject (string name)
		{
			AsnType obj = null;
			if (name.ToUpper ().Equals ("INTEGER32") || name.ToUpper ().Equals ("INTEGER"))
				obj = new Integer32 ();
			else if (name.ToUpper ().Equals ("COUNTER32"))
				obj = new Counter32 ();
			else if (name.ToUpper ().Equals ("GAUGE32"))
				obj = new Gauge32 ();
			else if (name.ToUpper ().Equals ("COUNTER64"))
				obj = new Counter64 ();
			else if (name.ToUpper ().Equals ("TIMETICKS"))
				obj = new TimeTicks ();
			else if (name.ToUpper ().Equals ("OCTETSTRING"))
				obj = new OctetString ();
			else if (name.ToUpper ().Equals ("IPADDRESS"))
				obj = new IpAddress ();
			else if (name.ToUpper ().Equals ("OID"))
				obj = new Oid ();
			else if (name.ToUpper ().Equals ("NULL"))
				obj = new Null ();
			else
				throw new ArgumentException ("Invalid value type name");

			return obj;
		}
		/// <summary>
		/// Return string representation of the SMI value type.
		/// </summary>
		/// <param name="type">AsnType class Type member function value.</param>
		/// <returns>String formatted name of the SMI type.</returns>
		public static string GetTypeName (SMIDataTypeCode type)
		{
			return SMIDataTypeCode.GetName (typeof(SMIDataTypeCode), type);
		}
		/// <summary>
		/// Check if byte code is a valid SMI data type code
		/// </summary>
		/// <param name="smiType">SMI data type code to test</param>
		/// <returns>true if valid SMI data type, otherwise false</returns>
		public static bool IsValidType (byte smiType)
		{
			byte[] validSMITypes = (byte[])Enum.GetValues (typeof(SMIDataTypeCode));
			foreach (int type in validSMITypes) {
				if (type == smiType)
					return true;
			}
			return false;
		}
	}
}