Class CIM_PrintInputTray
extends CIM_PrinterElement

This class represents the PrintInputTray component of a Printer (print device). It contains properties that describe a device capable of providing media for input to the printing process. Note: A PrintInputTray shall be associated with exactly one Printer via an instance of the PrinterComponent class. See: Model in section 2 of Printer MIB (RFC 3805).

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_PrinterElement
   |
   +--CIM_PrintInputTray

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringThis class represents the PrintInputTray component of a Printer (print device). It contains properties that describe a device capable of providing media for input to the printing process. Note: A PrintInputTray shall be associated with exactly one Printer via an instance of the PrinterComponent class. See: Model in section 2 of Printer MIB (RFC 3805).
MappingStringsstringMIB.IETF|Printer-MIB.prtInputEntry
UMLPackagePathstringCIM::Device::Printing
Versionstring2.31.1

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
AvailabilityStatusuint32
DescriptionstringThis property contains detailed availability information for this PrintInputTray, as follows: 1 (Other) means other detailed availability information is present in the OtherAvailabilityStatus property. 2 (Unknown) means detailed availability information for this PrintInputTray is unknown. 3 (AvailableIdle) means this PrintInputTray is available and idle, i.e., not currently in use. 4 (AvailableStandy) means this PrintInputTray is available but on standby, e.g., in a power saving mode. 5 (AvailableActive) means this PrintInputTray is available and active, i.e., currently in use. 6 (AvailableBusy) means this PrintInputTray is available but busy, i.e., not immediately available for its primary function. 7 (UnavailableOnRequest) means this PrintInputTray is not available and is on request, i.e., needs human intervention. 8 (UnavailableBroken) means this PrintInputTray is not available and is broken, e.g., needs repair/replacement.
MappingStringsstringMIB.IETF|Printer-MIB.PrtSubUnitStatusTC
ModelCorrespondencestringCIM_ManagedSystemElement.OperatingStatus, CIM_PrintInputTray.OtherAvailabilityStatus
ValueMapstring1, 2, 3, 4, 5, 6, 7, 8, ..
ValuesstringOther, Unknown, AvailableIdle, AvailableStandby, AvailableActive, AvailableBusy, UnavailableOnRequest, UnavailableBroken, DMTF Reserved
CapacityUnituint32
DescriptionstringThe unit of measurement for use in calculating and relaying capacity values for this input tray.
MappingStringsstringMIB.IETF|Printer-MIB.prtInputCapacityUnit, MIB.IETF|Printer-MIB.PrtCapacityUnitTC
ModelCorrespondencestringCIM_PrintInputTray.OtherCapacityUnit
ValueMapstring1, 2, 3, 4, 8, 16, 17, 18, 19, ..
ValuesstringOther, Unknown, TenThousandthsOfInches, Micrometers, Sheets, Feet, Meters, Items, Percent, DMTF Reserved
CriticalAlertsPresentboolean
DescriptionstringIf true, there are currently critical alerts on this input tray.
MappingStringsstringMIB.IETF|Printer-MIB.PrtSubUnitStatusTC
ModelCorrespondencestringCIM_ManagedSystemElement.DetailedStatus
CurrentLeveluint32
DescriptionstringThe current level of the input tray in units specified by CIM_PrintInputTray.CapacityUnit. If this input tray can reliably sense this value, the value is sensed by the input tray and cannot be changed by the system administrator; otherwise, the value may be changed out-of-band by the system administrator.
MappingStringsstringMIB.IETF|Printer-MIB.prtInputCurrentLevel, MIB.IETF|Printer-MIB.prtInputCapacityUnit, MIB.IETF|Printer-MIB.PrtCapacityUnitTC
MaxValuesint642147483647
MinValuesint640
ModelCorrespondencestringCIM_PrintInputTray.CurrentLevelBasis
CurrentLevelBasisuint16
DescriptionstringThe basis for the gauge property CurrentLevel, that specifies whether a meaningful value is available. 1 (Other) means the input tray places no restrictions on capacity and CurrentLevel shall be null. 2 (Unknown) means the input tray cannot sense a meaningful value and CurrentLevel shall be null. 3 (Actual) means the input tray can sense a meaningful value and CurrentLevel shall be present. 4 (AtLeastOne) means that the input tray can only sense that at least one capacity unit remains (i.e., not empty) and CurrentLevel shall be present and shall contain the value zero or one.
MappingStringsstringMIB.IETF|Printer-MIB.prtInputCurrentLevel
ModelCorrespondencestringCIM_PrintInputTray.CurrentLevel
ValueMapstring1, 2, 3, 4, ..
ValuesstringOther, Unknown, Actual, AtLeastOne, DMTF Reserved
ElementNamestring
DescriptionstringThe user-friendly name for this instance of PrintInputTray. In addition, the user-friendly name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.) This name shall be generated as a factory default by the manufacturer and may be changed out-of-band to a site-specific name by the system administrator.
MappingStringsstringMIB.IETF|Printer-MIB.prtInputName
ModelCorrespondencestringCIM_ManagedElement.ElementName
OverridestringElementName
Requiredbooleantrue
IsDefaultboolean
DescriptionstringDenotes whether or not this PrintInputTray is the default PrintInputTray for this Printer. If the default PrintInputTray feature is not supported for this Printer, then this property shall be null. If the default PrintInputTray feature is supported for this Printer, then this property shall be true for at most one instance of CIM_PrintInputTray on this Printer, i.e., the default may not be currently configured.
MappingStringsstringMIB.IETF|Printer-MIB.prtInputDefaultIndex
LocalizedDescriptionstring
DescriptionstringA free-form text description of this input tray in the localization specified by CIM_Printer.CurrentNaturalLanguage.
MappingStringsstringMIB.IETF|Printer-MIB.prtInputDescription, MIB.IETF|Printer-MIB.PrtLocalizedDescriptionStringTC
MaxLenuint32255
ModelCorrespondencestringCIM_Printer.CurrentNaturalLanguage
MaxCapacityuint32
DescriptionstringThe maximum capacity of the input tray in units specified by CIM_PrintInputTray.CapacityUnit. There is no convention associated with the media itself so this value reflects claimed capacity. If this input tray can reliably sense this value, the value is sensed by the input tray and cannot be changed by the system administrator; otherwise, the value may be changed out-of-band by the system administrator.
MappingStringsstringMIB.IETF|Printer-MIB.prtInputMaxCapacity, MIB.IETF|Printer-MIB.prtInputCapacityUnit, MIB.IETF|Printer-MIB.PrtCapacityUnitTC
MaxValuesint642147483647
MinValuesint640
ModelCorrespondencestringCIM_PrintInputTray.MaxCapacityBasis
MaxCapacityBasisuint16
DescriptionstringThe basis for the limit property MaxCapacity, that specifies whether a meaningful value is available. 1 (Other) means the input tray places no restrictions on capacity and MaxCapacity shall be null. 2 (Unknown) means the input tray cannot sense a meaningful value and MaxCapacity shall be null. 3 (Actual) means the input tray can sense a meaningful value and MaxCapacity shall be present.
MappingStringsstringMIB.IETF|Printer-MIB.prtInputMaxCapacity
ModelCorrespondencestringCIM_PrintInputTray.MaxCapacity
ValueMapstring1, 2, 3, ..
ValuesstringOther, Unknown, Actual, DMTF Reserved
MediaColorstring
DescriptionstringThe name of the color of the media associated with this input tray. The values of this property should conform to the requirements of the PWG Media Standardized Names specification [PWG5101.1], which defines the normative values for this property.
MappingStringsstringPWG5101-1.PWG|Media Standardized Names, MIB.IETF|Printer-MIB.prtInputMediaColor
MaxLenuint3263
MediaNamestring
DescriptionstringThe descriptive name of the media contained in this input tray. This media name is to be used by a client to format and localize a string for display to a human operator. This media name is not processed by the printer. It is used to provide information not expressible in terms of the other media attributes (e.g., CIM_PrintInputTray.MediaWeight and CIM_PrintInputTray.MediaType).
MappingStringsstringMIB.IETF|Printer-MIB.prtInputMediaName
MaxLenuint3263
MediaSizeNamestring
DescriptionstringThis property provides the value of the PWG standard or custom media size name of the media that is (or, if empty, was or will be) in this input tray. The values of this property shall conform to the requirements of the PWG Media Standardized Names specification [PWG5101.1], which defines the normative values for this property. If this input tray can reliably sense this value, the value is sensed by the input tray and cannot be changed by the system administrator; otherwise, the value may be changed out-of-band by the system administrator. The empty value means unknown.
MappingStringsstringPWG5101-1.PWG|Media Standardized Names, MIB.IETF|Printer-MIB.prtInputMediaDimFeedDirDeclared, MIB.IETF|Printer-MIB.prtInputMediaDimXFeedDirDeclared
MaxLenuint3263
MediaTypestring
DescriptionstringThe name of the type of media associated with this input tray. The values of this property should conform to the requirements of the PWG Media Standardized Names specification [PWG5101.1], which defines the normative values for this property. This media type name need not be processed by the printer; it might simply be displayed to an operator.
MappingStringsstringPWG5101-1.PWG|Media Standardized Names, MIB.IETF|Printer-MIB.prtInputMediaType
MaxLenuint3263
MediaWeightuint32
DescriptionstringThe weight of the media associated with this input tray in grams per square meter.
MappingStringsstringMIB.IETF|Printer-MIB.prtInputMediaWeight
MaxValuesint642147483647
MinValuesint640
ModelCorrespondencestringCIM_PrintInputTray.MediaWeightBasis
Punitstringgram / (meter * meter)
MediaWeightBasisuint16
DescriptionstringThe basis for the media property MediaWeight, that specifies whether a meaningful value is available. 2 (Unknown) means the input tray cannot sense a meaningful value and MediaWeight shall be null. 3 (Actual) means the input tray can sense a meaningful value and MediaWeight shall be present.
MappingStringsstringMIB.IETF|Printer-MIB.prtInputMediaWeight
ModelCorrespondencestringCIM_PrintInputTray.MediaWeight
ValueMapstring2, 3, ..
ValuesstringUnknown, Actual, DMTF Reserved
NonCriticalAlertsPresentboolean
DescriptionstringIf true, there are currently non-critical alerts on this input tray.
MappingStringsstringMIB.IETF|Printer-MIB.PrtSubUnitStatusTC
ModelCorrespondencestringCIM_ManagedSystemElement.DetailedStatus
OtherAvailabilityStatusstring
DescriptionstringA free-form string that describes the detailed availability of this PrintInputTray when the value of the AvailabilityStatus property is equal to 1 (Other).
MaxLenuint32255
ModelCorrespondencestringCIM_PrintInputTray.AvailabilityStatus
OtherCapacityUnitstring
DescriptionstringA free-form string that describes the capacity unit when the value of the CapacityUnit property is equal to 1 (Other).
MaxLenuint32255
ModelCorrespondencestringCIM_PrintInputTray.CapacityUnit
OtherTypeDescriptionstring
DescriptionstringA free-form string that describes the type of technology when the value of the Type property is equal to 1 (Other).
MaxLenuint32255
ModelCorrespondencestringCIM_PrintInputTray.Type
Typeuint32
DescriptionstringThe type of technology (discriminated primarily according to feeder mechanism type) employed by the input tray.
MappingStringsstringMIB.IETF|Printer-MIB.prtInputType, MIB.IETF|IANA-PRINTER-MIB.PrtInputTypeTC
ModelCorrespondencestringCIM_PrintInputTray.OtherTypeDescription
ValueMapstring1, 2, 3, 4, 5, 6, 7, ..
ValuesstringOther, Unknown, SheetFeedAutoRemovableTray, SheetFeedAutoNonRemovableTray, SheetFeedManual, ContinuousRoll, ContinuousFanFold, DMTF Reserved

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_PrinterElement
NamestringCIM_ManagedSystemElement
OperatingStatusuint16CIM_ManagedSystemElement
PrimaryStatusuint16CIM_ManagedSystemElement
SNMPRowIduint32CIM_PrinterElement
StatusstringCIM_ManagedSystemElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods