//----------------------------------------------------------------------------
//
// Copyright (c) Intel Corporation, 2003 - 2012 All Rights Reserved.
//
// File: CIM_PhysicalPackage.cs
//
// Contents: The PhysicalPackage class represents PhysicalElements that contain or host other components. Examples are a Rack enclosure or an adapter Card.
// This file was automatically generated from CIM_PhysicalPackage.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
{
///
///The PhysicalPackage class represents PhysicalElements that contain or host other components. Examples are a Rack enclosure or an adapter Card.
///
[System.SerializableAttribute()]
[System.Xml.Serialization.XmlTypeAttribute(Namespace="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PhysicalPackage")]
[System.Xml.Serialization.XmlRootAttribute("CIM_PhysicalPackage", Namespace="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PhysicalPackage", IsNullable=false)]
public class CIM_PhysicalPackage : CIM_PhysicalElement
{
///
/// Default constructor.
///
public CIM_PhysicalPackage() :base()
{
}
///
/// Constructor that recieves an xml string for deserialization.
///
/// xml string to deserialize
public CIM_PhysicalPackage(string xml): base((IWSManClient)null)
{
this.Deserialize(xml);
}
///
/// Constructor which recieves a Ws-Management client object.
///
/// Ws-Management client
public CIM_PhysicalPackage(IWSManClient client): base(client)
{
}
///
/// Remove Depth field.
/// Note: This method will succeed only if this field is optional in the concrete object.
///
public virtual void RemoveDepth()
{
RemoveField("Depth");
}
///
/// Is true if the field Depth exists in the current object,
/// otherwise is false.
///
public virtual bool DepthExist
{
get
{
return ContainsField("Depth");
}
}
///
/// Optional, The depth of the PhysicalPackage in inches.
///
[CimField(false, false)]
public virtual double Depth
{
get
{
return double.Parse(this["Depth"][0], CultureInfo.InvariantCulture);
}
set
{
this.SetOrAddField("Depth",value.ToString(CultureInfo.InvariantCulture));
}
}
///
/// Remove Height field.
/// Note: This method will succeed only if this field is optional in the concrete object.
///
public virtual void RemoveHeight()
{
RemoveField("Height");
}
///
/// Is true if the field Height exists in the current object,
/// otherwise is false.
///
public virtual bool HeightExist
{
get
{
return ContainsField("Height");
}
}
///
/// Optional, The height of the PhysicalPackage in inches.
///
[CimField(false, false)]
public virtual double Height
{
get
{
return double.Parse(this["Height"][0], CultureInfo.InvariantCulture);
}
set
{
this.SetOrAddField("Height",value.ToString(CultureInfo.InvariantCulture));
}
}
///
/// Remove HotSwappable field.
/// Note: This method will succeed only if this field is optional in the concrete object.
///
public virtual void RemoveHotSwappable()
{
RemoveField("HotSwappable");
}
///
/// Is true if the field HotSwappable exists in the current object,
/// otherwise is false.
///
public virtual bool HotSwappableExist
{
get
{
return ContainsField("HotSwappable");
}
}
///
/// Optional, The use of this property is being deprecated. Instead RemovalConditions should be used. The RemovalConditions property addresses whether a PhysicalPackage is removable with or without power being applied.
///
/// A PhysicalPackage is HotSwappable if it is possible to replace the Element with a physically different but equivalent one while the containing Package has power applied to it (ie, is 'on'). For example, a disk drive Package inserted using SCA connectors is both Removable and HotSwappable. All HotSwappable packages are inherently Removable and Replaceable.
///
[CimField(false, false)]
public virtual bool HotSwappable
{
get
{
return bool.Parse(this["HotSwappable"][0]);
}
set
{
this.SetOrAddField("HotSwappable",value.ToString().ToLower(CultureInfo.InvariantCulture));
}
}
///
/// Remove OtherPackageType field.
/// Note: This method will succeed only if this field is optional in the concrete object.
///
public virtual void RemoveOtherPackageType()
{
RemoveField("OtherPackageType");
}
///
/// Is true if the field OtherPackageType exists in the current object,
/// otherwise is false.
///
public virtual bool OtherPackageTypeExist
{
get
{
return ContainsField("OtherPackageType");
}
}
///
/// Optional, A string describing the package when the instance's PackageType property is 1 ("Other").
///
[CimField(false, false)]
public virtual string OtherPackageType
{
get
{
return this.GetField("OtherPackageType")[0];
}
set
{
this.SetOrAddField("OtherPackageType",value);
}
}
///
/// Remove PackageType field.
/// Note: This method will succeed only if this field is optional in the concrete object.
///
public virtual void RemovePackageType()
{
RemoveField("PackageType");
}
///
/// Is true if the field PackageType exists in the current object,
/// otherwise is false.
///
public virtual bool PackageTypeExist
{
get
{
return ContainsField("PackageType");
}
}
///
/// Optional, Enumeration defining the type of the PhysicalPackage. Note that this enumeration expands on the list in the Entity MIB (the attribute, entPhysicalClass). The numeric values are consistent with CIM's enum numbering guidelines, but are slightly different than the MIB's values.
/// Unknown - indicates that the package type is not known.
/// Other - The package type does not correspond to an existing enumerated value. The value is specified using the OtherPackageType property.
/// The values "Rack" through "Port/Connector" are defined per the Entity-MIB (where the semantics of rack are equivalent to the MIB's 'stack' value). The other values (for battery, processor, memory, power source/generator and storage media package) are self-explanatory.
/// A value of "Blade" should be used when the PhysicalPackage contains the operational hardware aspects of a ComputerSystem, without the supporting mechanicals such as power and cooling. For example, a Blade Server includes processor(s) and memory, and relies on the containing chassis to supply power and cooling. In many respects, a Blade can be considered a "Module/Card". However, it is tracked differently by inventory systems and differs in terms of service philosophy. For example, a Blade is intended to be hot-plugged into a hosting enclosure without requiring additional cabling, and does not require a cover to be removed from the enclosure for installation. Similarly, a "Blade Expansion" has characteristics of a "Blade" and a "Module/Card". However, it is distinct from both due to inventory tracking and service philosophy, and because of its hardware dependence on a Blade. A Blade Expansion must be attached to a Blade prior to inserting the resultant assembly into an enclosure.
///
[CimField(false, false)]
public virtual ushort PackageType
{
get
{
return ushort.Parse(this["PackageType"][0], CultureInfo.InvariantCulture);
}
set
{
this.SetOrAddField("PackageType",value.ToString(CultureInfo.InvariantCulture));
}
}
///
/// Remove Removable field.
/// Note: This method will succeed only if this field is optional in the concrete object.
///
public virtual void RemoveRemovable()
{
RemoveField("Removable");
}
///
/// Is true if the field Removable exists in the current object,
/// otherwise is false.
///
public virtual bool RemovableExist
{
get
{
return ContainsField("Removable");
}
}
///
/// Optional, The use of this property is being deprecated. Instead RemovalConditions should be used. The RemovalConditions property addresses whether a PhysicalPackage is removable with or without power being applied.
/// A PhysicalPackage is Removable if it is designed to be taken in and out of the physical container in which it is normally found, without impairing the function of the overall packaging. A Package can still be Removable if power must be 'off' in order to perform the removal. If power can be 'on' and the Package removed, then the Element is both Removable and HotSwappable. For example, an extra battery in a laptop is Removable, as is a disk drive Package inserted using SCA connectors. However, the latter is also HotSwappable. A laptop's display is not Removable, nor is a non-redundant power supply. Removing these components would impact the function of the overall packaging or is impossible due to the tight integration of the Package.
///
[CimField(false, false)]
public virtual bool Removable
{
get
{
return bool.Parse(this["Removable"][0]);
}
set
{
this.SetOrAddField("Removable",value.ToString().ToLower(CultureInfo.InvariantCulture));
}
}
///
/// Remove RemovalConditions field.
/// Note: This method will succeed only if this field is optional in the concrete object.
///
public virtual void RemoveRemovalConditions()
{
RemoveField("RemovalConditions");
}
///
/// Is true if the field RemovalConditions exists in the current object,
/// otherwise is false.
///
public virtual bool RemovalConditionsExist
{
get
{
return ContainsField("RemovalConditions");
}
}
///
/// Optional, The RemovalCapabilites property is used to describe the conditions under which a PhysicalPackage can be removed. Since all PhysicalPackages are not removable, this property defaults to 2, 'Not Applicable'.
///
[CimField(false, false)]
public virtual ushort RemovalConditions
{
get
{
return ushort.Parse(this["RemovalConditions"][0], CultureInfo.InvariantCulture);
}
set
{
this.SetOrAddField("RemovalConditions",value.ToString(CultureInfo.InvariantCulture));
}
}
///
/// Remove Replaceable field.
/// Note: This method will succeed only if this field is optional in the concrete object.
///
public virtual void RemoveReplaceable()
{
RemoveField("Replaceable");
}
///
/// Is true if the field Replaceable exists in the current object,
/// otherwise is false.
///
public virtual bool ReplaceableExist
{
get
{
return ContainsField("Replaceable");
}
}
///
/// Optional, The use of this property is being deprecated because it is redundant with the FRU class and its associations. A PhysicalPackage is Replaceable if it is possible to replace (FRU or upgrade) the Element with a physically different one. For example, some ComputerSystems allow the main Processor chip to be upgraded to one of a higher clock rating. In this case, the Processor is said to be Replaceable. Another example is a power supply Package mounted on sliding rails. All Removable packages are inherently Replaceable.
///
[CimField(false, false)]
public virtual bool Replaceable
{
get
{
return bool.Parse(this["Replaceable"][0]);
}
set
{
this.SetOrAddField("Replaceable",value.ToString().ToLower(CultureInfo.InvariantCulture));
}
}
///
/// Remove VendorCompatibilityStrings field.
/// Note: This method will succeed only if this field is optional in the concrete object.
///
public virtual void RemoveVendorCompatibilityStrings()
{
RemoveField("VendorCompatibilityStrings");
}
///
/// Is true if the field VendorCompatibilityStrings exists in the current object,
/// otherwise is false.
///
public virtual bool VendorCompatibilityStringsExist
{
get
{
return ContainsField("VendorCompatibilityStrings");
}
}
///
/// Optional, An array of strings that identify the component that is compatible with, and can be inserted in a slot that reports this string as one of the array element in the VendorCompatibilityStrings This allows system administrators to determine whether it is appropriateto insert a package into a slot
/// In order to ensure uniqueness within the NameSpace, each value defined by the vendor for use in the VendorCompatibilityStrings property SHOULD be constructed using the following 'preferred' algorithm:
/// <OrgID>:<LocalID>
/// Where <OrgID> and <LocalID> are separated by a colon ':', and where <OrgID> MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority (This is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness <OrgID> MUST NOT contain a colon (':'). When using this algorithm, the first colon to appear in InstanceID MUST appear between <OrgID> and <LocalID>.
/// <LocalID> is chosen by the business entity and SHOULD not be re-used to identify different underlying (real-world) elements.
///
[CimField(false, false)]
public virtual string[] VendorCompatibilityStrings
{
get
{
return CimTypesUtils.StringArrayToArray(this["VendorCompatibilityStrings"]);
}
set
{
string[] arr = CimTypesUtils.ArrayToStringArray(value);
this.SetOrAddField("VendorCompatibilityStrings", arr);
}
}
///
/// Remove Weight field.
/// Note: This method will succeed only if this field is optional in the concrete object.
///
public virtual void RemoveWeight()
{
RemoveField("Weight");
}
///
/// Is true if the field Weight exists in the current object,
/// otherwise is false.
///
public virtual bool WeightExist
{
get
{
return ContainsField("Weight");
}
}
///
/// Optional, The weight of the PhysicalPackage in pounds.
///
[CimField(false, false)]
public virtual double Weight
{
get
{
return double.Parse(this["Weight"][0], CultureInfo.InvariantCulture);
}
set
{
this.SetOrAddField("Weight",value.ToString(CultureInfo.InvariantCulture));
}
}
///
/// Remove Width field.
/// Note: This method will succeed only if this field is optional in the concrete object.
///
public virtual void RemoveWidth()
{
RemoveField("Width");
}
///
/// Is true if the field Width exists in the current object,
/// otherwise is false.
///
public virtual bool WidthExist
{
get
{
return ContainsField("Width");
}
}
///
/// Optional, The width of the PhysicalPackage in inches.
///
[CimField(false, false)]
public virtual double Width
{
get
{
return double.Parse(this["Width"][0], CultureInfo.InvariantCulture);
}
set
{
this.SetOrAddField("Width",value.ToString(CultureInfo.InvariantCulture));
}
}
///
/// Enumerate instances of CIM_PhysicalPackage class at an endpoint.
///
/// WS-Management client
/// Keys for selecting the instances
/// Collection of CIM_PhysicalPackage objects
public static new Collection Enumerate(IWSManClient client, CimBase.CimKeys cimKeys)
{
List ret = CimBase.Enumerate(client, cimKeys);
return new Collection(ret);
}
///
/// Enumerate instances of CIM_PhysicalPackage class at an endpoint.
///
/// WS-Management client
/// Collection of CIM_PhysicalPackage objects
public static new Collection Enumerate(IWSManClient client)
{
List ret = CimBase.Enumerate(client);
return new Collection(ret);
}
///
/// Delete the instance of CIM_PhysicalPackage if it is singular.
/// Note: This method will succeed only if a single instance of the class exists.
///
/// WS-Management client
public static new void Delete(IWSManClient client)
{
CimBase.Delete(client);
}
///
/// Represents the keys of the CIM_PhysicalPackage class.
///
public new class CimKeys : CIM_PhysicalElement.CimKeys
{
}
}
}