//----------------------------------------------------------------------------
//
// Copyright (c) Intel Corporation, 2003 - 2012  All Rights Reserved.
//
//  File:       CIM_ProtocolEndpoint.cs
//
//  Contents:   A communication point from which data can be sent or received. ProtocolEndpoints link system or computer interfaces to LogicalNetworks.
//              This file was automatically generated from CIM_ProtocolEndpoint.mof
//
//----------------------------------------------------------------------------

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Text;
using System.Globalization;
using System.Xml.Serialization;
using System.IO;
using Intel.Manageability.WSManagement;
using Intel.Manageability.Cim.Untyped;


namespace Intel.Manageability.Cim.Typed
{
	/// <summary>
	///A communication point from which data can be sent or received. ProtocolEndpoints link system or computer interfaces to LogicalNetworks.
	/// </summary>
	[System.SerializableAttribute()]
	[System.Xml.Serialization.XmlTypeAttribute(Namespace="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ProtocolEndpoint")]
	[System.Xml.Serialization.XmlRootAttribute("CIM_ProtocolEndpoint", Namespace="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ProtocolEndpoint", IsNullable=false)]
	public class CIM_ProtocolEndpoint : CIM_ServiceAccessPoint
	{
		/// <summary>
		/// Default constructor.
		/// </summary>
		public CIM_ProtocolEndpoint() :base()
		{
		}
		/// <summary>
		/// Constructor that recieves an xml string for deserialization.
		/// </summary>
		/// <param name="xml">xml string to deserialize</param>
		public CIM_ProtocolEndpoint(string xml): base((IWSManClient)null)
		{
			this.Deserialize(xml);
		}
		/// <summary>
		/// Constructor which recieves a Ws-Management client object.
		/// </summary>
		/// <param name="client">Ws-Management client</param>
		public CIM_ProtocolEndpoint(IWSManClient client): base(client)
		{
		}
		/// <summary>
		/// Remove Description field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public override void RemoveDescription()
		{
			RemoveField("Description");
		}

		/// <summary>
		/// Is true if the field Description exists in the current object,
		/// otherwise is false.
		/// </summary>
		public override bool DescriptionExist
		{
			get
			{
				return ContainsField("Description");
			}
		}

		/// <summary>
		/// Optional, 
		/// </summary>
		[CimField(false, false)]
		public override string Description
		{
			get
			{
				return this.GetField("Description")[0];
			}
			set
			{
			this.SetOrAddField("Description",value);
			}
		}
		/// <summary>
		/// Remove EnabledState field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public override void RemoveEnabledState()
		{
			RemoveField("EnabledState");
		}

		/// <summary>
		/// Is true if the field EnabledState exists in the current object,
		/// otherwise is false.
		/// </summary>
		public override bool EnabledStateExist
		{
			get
			{
				return ContainsField("EnabledState");
			}
		}

		/// <summary>
		/// Optional, 
		/// </summary>
		[CimField(false, false)]
		public override ushort EnabledState
		{
			get
			{
					return ushort.Parse(this["EnabledState"][0], CultureInfo.InvariantCulture);
			}
			set
			{
				this.SetOrAddField("EnabledState",value.ToString(CultureInfo.InvariantCulture));
			}
		}


		/// <summary>
		/// Required, A string that identifies this ProtocolEndpoint with either a port or an interface on a device. To ensure uniqueness, the Name property should be prepended or appended with information from the Type or OtherTypeDescription properties. The method selected is described in the NameFormat property of this class.
		/// </summary>
		[CimField(true, true)]
		public override string Name
		{
			get
			{
				return this.GetField("Name")[0];
			}
			set
			{
			this.SetOrAddField("Name",value);
			}
		}
		/// <summary>
		/// Remove NameFormat field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveNameFormat()
		{
			RemoveField("NameFormat");
		}

		/// <summary>
		/// Is true if the field NameFormat exists in the current object,
		/// otherwise is false.
		/// </summary>
		public virtual bool NameFormatExist
		{
			get
			{
				return ContainsField("NameFormat");
			}
		}

		/// <summary>
		/// Optional, NameFormat contains the naming heuristic that is selected to ensure that the value of the Name property is unique. For example, you might choose to prepend the name of the port or interface with the Type of ProtocolEndpoint (for example, IPv4) of this instance followed by an underscore.
		/// </summary>
		[CimField(false, false)]
		public virtual string NameFormat
		{
			get
			{
				return this.GetField("NameFormat")[0];
			}
			set
			{
			this.SetOrAddField("NameFormat",value);
			}
		}
		/// <summary>
		/// Remove OperationalStatus field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public override void RemoveOperationalStatus()
		{
			RemoveField("OperationalStatus");
		}

		/// <summary>
		/// Is true if the field OperationalStatus exists in the current object,
		/// otherwise is false.
		/// </summary>
		public override bool OperationalStatusExist
		{
			get
			{
				return ContainsField("OperationalStatus");
			}
		}

		/// <summary>
		/// Optional, 
		/// </summary>
		[CimField(false, false)]
		public override ushort[] OperationalStatus
		{
			get
			{
					return CimTypesUtils.StringArrayToArray<ushort>(this["OperationalStatus"]);
			}
			set
			{
				string[] arr = CimTypesUtils.ArrayToStringArray<ushort>(value);
				this.SetOrAddField("OperationalStatus", arr);
			}
		}
		/// <summary>
		/// Remove OtherTypeDescription field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveOtherTypeDescription()
		{
			RemoveField("OtherTypeDescription");
		}

		/// <summary>
		/// Is true if the field OtherTypeDescription exists in the current object,
		/// otherwise is false.
		/// </summary>
		public virtual bool OtherTypeDescriptionExist
		{
			get
			{
				return ContainsField("OtherTypeDescription");
			}
		}

		/// <summary>
		/// Optional, A string that describes the type of ProtocolEndpoint when the Type property of this class (or any of its subclasses) is set to 1 (Other). This property should be set to null when the Type property is any value other than 1.
		/// </summary>
		[CimField(false, false)]
		public virtual string OtherTypeDescription
		{
			get
			{
				return this.GetField("OtherTypeDescription")[0];
			}
			set
			{
			this.SetOrAddField("OtherTypeDescription",value);
			}
		}
		/// <summary>
		/// Remove ProtocolIFType field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveProtocolIFType()
		{
			RemoveField("ProtocolIFType");
		}

		/// <summary>
		/// Is true if the field ProtocolIFType exists in the current object,
		/// otherwise is false.
		/// </summary>
		public virtual bool ProtocolIFTypeExist
		{
			get
			{
				return ContainsField("ProtocolIFType");
			}
		}

		/// <summary>
		/// Optional, ProtocolIFType is an enumeration that is synchronized with the IANA ifType MIB. The ifType MIB is maintained at the URL, http://www.iana.org/assignments/ianaiftype-mib. Also, additional values defined by the DMTF are included. The property is used to categorize and classify instances of the ProtocolEndpoint class. Note that if the ProtocolIFType is set to 1 (Other), then the type information should be provided in the OtherTypeDescription string property.
		/// </summary>
		[CimField(false, false)]
		public virtual ushort ProtocolIFType
		{
			get
			{
					return ushort.Parse(this["ProtocolIFType"][0], CultureInfo.InvariantCulture);
			}
			set
			{
				this.SetOrAddField("ProtocolIFType",value.ToString(CultureInfo.InvariantCulture));
			}
		}
		/// <summary>
		/// Remove ProtocolType field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public virtual void RemoveProtocolType()
		{
			RemoveField("ProtocolType");
		}

		/// <summary>
		/// Is true if the field ProtocolType exists in the current object,
		/// otherwise is false.
		/// </summary>
		public virtual bool ProtocolTypeExist
		{
			get
			{
				return ContainsField("ProtocolType");
			}
		}

		/// <summary>
		/// Optional, Note: This property is deprecated in lieu of the ProtocolIFType enumeration. This deprecation was done to have better alignment between the IF-MIB of the IETF and this CIM class. 
		/// Deprecated description: ProtocolType is an enumeration that provides information to categorize and classify different instances of this class. For most instances, information in this enumeration and the definition of the subclass overlap. However, there are several cases where a specific subclass of ProtocolEndpoint is not required (for example, there is no Fibre Channel subclass of ProtocolEndpoint). Therefore, this property is needed to define the type of Endpoint.
		/// </summary>
		[CimField(false, false)]
		public virtual ushort ProtocolType
		{
			get
			{
					return ushort.Parse(this["ProtocolType"][0], CultureInfo.InvariantCulture);
			}
			set
			{
				this.SetOrAddField("ProtocolType",value.ToString(CultureInfo.InvariantCulture));
			}
		}
		/// <summary>
		/// Remove TimeOfLastStateChange field.
		/// Note: This method will succeed only if this field is optional in the concrete object.
		/// </summary>
		public override void RemoveTimeOfLastStateChange()
		{
			RemoveField("TimeOfLastStateChange");
		}

		/// <summary>
		/// Is true if the field TimeOfLastStateChange exists in the current object,
		/// otherwise is false.
		/// </summary>
		public override bool TimeOfLastStateChangeExist
		{
			get
			{
				return ContainsField("TimeOfLastStateChange");
			}
		}

		/// <summary>
		/// Optional, 
		/// </summary>
		[CimField(false, false)]
		public override CimDateTime TimeOfLastStateChange
		{
			get
			{
					return CimDateTime.Parse(this["TimeOfLastStateChange"][0]);
			}
			set
			{
				this.SetOrAddField("TimeOfLastStateChange",value.ToString());
			}
		}

		/// <summary>
		/// Enumerate instances of CIM_ProtocolEndpoint class at an endpoint.
		/// </summary>
		/// <param name="client">WS-Management client</param>
		/// <param name="cimKeys">Keys for selecting the instances</param>
		/// <returns>Collection of CIM_ProtocolEndpoint objects</returns>
		public static new Collection<CIM_ProtocolEndpoint> Enumerate(IWSManClient client, CimBase.CimKeys cimKeys)
		{
			List<CIM_ProtocolEndpoint> ret = CimBase.Enumerate<CIM_ProtocolEndpoint>(client, cimKeys);
			return new Collection<CIM_ProtocolEndpoint>(ret);
		}

		/// <summary>
		/// Enumerate instances of CIM_ProtocolEndpoint class at an endpoint.
		/// </summary>
		/// <param name="client">WS-Management client</param>
		/// <returns>Collection of CIM_ProtocolEndpoint objects</returns>
		public static new Collection<CIM_ProtocolEndpoint> Enumerate(IWSManClient client)
		{
			List<CIM_ProtocolEndpoint> ret = CimBase.Enumerate<CIM_ProtocolEndpoint>(client);
			return new Collection<CIM_ProtocolEndpoint>(ret);
		}


		/// <summary>
		/// Delete the instance of CIM_ProtocolEndpoint if it is singular.
		/// Note: This method will succeed only if a single instance of the class exists.
		/// </summary>
		/// <param name="client">WS-Management client</param>
		public static new void Delete(IWSManClient client)
		{
			CimBase.Delete<CIM_ProtocolEndpoint>(client);
		}


		/// <summary>
		/// Represents the keys of the CIM_ProtocolEndpoint class.
		/// </summary>

		public new class CimKeys : CIM_ServiceAccessPoint.CimKeys
		{
			/// <summary>
			/// Required, A string that identifies this ProtocolEndpoint with either a port or an interface on a device. To ensure uniqueness, the Name property should be prepended or appended with information from the Type or OtherTypeDescription properties. The method selected is described in the NameFormat property of this class.
			/// </summary>

			public virtual string Name
			{
				get
				{
					return GetKey("Name");
				}
				set
				{
					SetOrAddKey("Name", value);
				}
			}
		}

	}
}