Class CIM_PrintSupply
extends CIM_PrinterElement

This class represents a PrintSupply for a PrintMarker or PrintFinisher component of a Printer (print device). It contains a property that specifies if this instance represents a PrintSupply represents a container (for a supply that is consumed) or a receptacle (for waste that is produced). It also contains properties that describe the PrintSupply type, capacity, and remaining capacity. For PrintMarker colorants, it also contains properties that describe colorant role (spot or process), name, and tonality. Note: A PrintSupply shall be associated with exactly one Printer via an instance of the ConcreteComponent class. A PrintSupply shall be associated with exactly one PrintMarker or PrintFinisher via an instance of AssociatedPrintSupply class. See: Model in section 2 of Printer MIB (RFC 3805) and section 3 of Finisher MIB (RFC 3806).

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


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_PrinterElement
   |
   +--CIM_PrintSupply

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringThis class represents a PrintSupply for a PrintMarker or PrintFinisher component of a Printer (print device). It contains a property that specifies if this instance represents a PrintSupply represents a container (for a supply that is consumed) or a receptacle (for waste that is produced). It also contains properties that describe the PrintSupply type, capacity, and remaining capacity. For PrintMarker colorants, it also contains properties that describe colorant role (spot or process), name, and tonality. Note: A PrintSupply shall be associated with exactly one Printer via an instance of the ConcreteComponent class. A PrintSupply shall be associated with exactly one PrintMarker or PrintFinisher via an instance of AssociatedPrintSupply class. See: Model in section 2 of Printer MIB (RFC 3805) and section 3 of Finisher MIB (RFC 3806).
Experimentalbooleantrue
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerSuppliesEntry, MIB.IETF|Printer-MIB.prtMarkerColorantEntry, MIB.IETF|Finisher-MIB.finSupplyEntry
UMLPackagePathstringCIM::Device::Printing
Versionstring2.19.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
Classificationuint32
DescriptionstringIndicates whether this PrintSupply instance represents a PrintSupply that is consumed or a receptacle that is filled.
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerSuppliesClass, MIB.IETF|Finisher-MIB.finSupplyClass, MIB.IETF|Printer-MIB.PrtMarkerSuppliesClassTC
ModelCorrespondencestringCIM_PrintSupply.OtherClassification
ValueMapstring1, 3, 4, ..
ValuesstringOther, SupplyThatIsConsumed, ReceptacleThatIsFilled, DMTF Reserved
ColorantNameuint16
DescriptionstringIf this PrintSupply does not represent a PrintMarker colorant, then this property shall be null. If this PrintSupply does represent a PrintMarker colorant, then this property shall be present and shall denote the colorant name using the standardized names from ISO 10175 (DPA) and ISO 10180 (SPDL). Vendors and administrators may specify other colorant names in the OtherColorantName property.
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerColorantValue
ModelCorrespondencestringCIM_PrintSupply.OtherColorantName
ValueMapstring1, 2, 3, 4, 5, 6, 7, 8, 9, 10, ..
ValuesstringOther, Unknown, White, Red, Green, Blue, Cyan, Magenta, Yellow, Black, DMTF Reserved
ColorantRoleuint32
DescriptionstringIf this PrintSupply does not represent a PrintMarker colorant, then this property shall be null. If this PrintSupply does represent a PrintMarker colorant, then this property shall be present and shall denote the role played by this PrintMarker colorant.
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerColorantRole, MIB.IETF|Printer-MIB.PrtMarkerColorantRoleTC
ModelCorrespondencestringCIM_PrintMarker.OtherColorantRole, CIM_PrintMarker.ProcessColorants, CIM_PrintMarker.SpotColorants
ValueMapstring1, 3, 4, ..
ValuesstringOther, Process, Spot, DMTF Reserved
ColorantTonalityuint32
DescriptionstringIf this PrintSupply does not represent a PrintMarker colorant, then this property shall be null. If this PrintSupply does represent a PrintMarker colorant, then this property shall be present and shall denote the distinct levels of tonality realizable by a PrintMarker when using this colorant. This value does not include the number of levels of tonal difference that an interpreter can obtain by techniques such as half toning. This value must be at least 2.
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerColorantTonality
MaxValuesint642147483647
MinValuesint642
LocalizedDescriptionstring
DescriptionstringA free-form text description of this PrintSupply in the localization specified by CIM_Printer.CurrentNaturalLanguage.
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerSuppliesDescription, MIB.IETF|Finisher-MIB.finSupplyDescription, MIB.IETF|Printer-MIB.PrtLocalizedDescriptionStringTC
MaxLenuint32255
MinLenuint320
ModelCorrespondencestringCIM_Printer.CurrentNaturalLanguage
MaxCapacityuint32
DescriptionstringThe maximum capacity of this PrintSupply container (for a supply that is consumed) or receptacle (for waste that is produced) in units specified by CIM_PrintSupply.SupplyUnit. If this Printer can reliably sense this value, the value is sensed by the Printer 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.prtMarkerSuppliesMaxCapacity, MIB.IETF|Finisher-MIB.finSuppyMaxCapacity, MIB.IETF|Printer-MIB.prtMarkerSuppliesSupplyUnit, MIB.IETF|Finisher-MIB.finSupplyUnit, MIB.IETF|Printer-MIB.PrtMarkerSuppliesSupplyUnitTC
MaxValuesint642147483647
MinValuesint640
ModelCorrespondencestringCIM_PrintSupply.MaxCapacityBasis
MaxCapacityBasisuint16
DescriptionstringThe basis for the limit property MaxCapacity, that specifies whether a meaningful value is available. 1 (Other) means the Printer places no restrictions on capacity and MaxCapacity shall be null. 2 (Unknown) means the Printer cannot sense a meaningful value and MaxCapacity shall be null. 3 (Actual) means the Printer can sense a meaningful value and MaxCapacity shall be present.
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerSuppliesMaxCapacity, MIB.IETF|Finisher-MIB.finSuppyMaxCapacity
ModelCorrespondencestringCIM_PrintSupply.MaxCapacity
ValueMapstring1, 2, 3, ..
ValuesstringOther, Unknown, Actual, DMTF Reserved
OtherClassificationstring
DescriptionstringA free-form string that describes the PrintSupply classification when the value of the Classification property is equal to 1 (Other).
MaxLenuint32255
MinLenuint320
ModelCorrespondencestringCIM_PrintSupply.Classification
OtherColorantNamestring
DescriptionstringIf this PrintSupply does not represent a PrintMarker colorant, then this property shall be null. If this PrintSupply does represent a PrintMarker colorant and the value of the ColorantName property is equal to 1 (Other), then this property shall be present and shall contain a vendor or administrator defined value. The naming conventions in ISO 9070 are recommended in order to avoid potential name clashes.
MaxLenuint32255
MinLenuint320
ModelCorrespondencestringCIM_PrintSupply.ColorantName
OtherColorantRolestring
DescriptionstringIf this PrintSupply does not represent a PrintMarker colorant, then this property shall be null. If this PrintSupply does represent a PrintMarker colorant and the value of the ColorantRole property is equal to 1 (Other), then this property shall be present and shall contain a free-form string that describes the role of the colorant.
MaxLenuint32255
MinLenuint320
ModelCorrespondencestringCIM_PrintMarker.ColorantRole
OtherSupplyUnitstring
DescriptionstringA free-form string that describes the PrintSupply unit when the value of the SupplyUnit property is equal to 1 (Other).
MaxLenuint32255
MinLenuint320
ModelCorrespondencestringCIM_PrintSupply.SupplyUnit
OtherTypeDescriptionstring
DescriptionstringA free-form string that describes the PrintSupply type when the value of the Type property is equal to 1 (Other).
MaxLenuint32255
MinLenuint320
ModelCorrespondencestringCIM_PrintSupply.Type
RemainingCapacityuint32
DescriptionstringThe current remaining level of the supply if this PrintSupply is a container (for a supply that is consumed) or the remaining capacity if this PrintSupply is a receptacle (for waste that is produced), in units specified by CIM_PrintSupply.SupplyUnit. If this Printer can reliably sense this value, the value is sensed by the Printer 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.prtMarkerSuppliesLevel, MIB.IETF|Finisher-MIB.finSuppyCurrentLevel, MIB.IETF|Printer-MIB.prtMarkerSuppliesSupplyUnit, MIB.IETF|Finisher-MIB.finSupplyUnit, MIB.IETF|Printer-MIB.PrtMarkerSuppliesSupplyUnitTC
MaxValuesint642147483647
MinValuesint640
ModelCorrespondencestringCIM_PrintSupply.RemainingCapacityBasis
RemainingCapacityBasisuint16
DescriptionstringThe basis for the gauge property RemainingCapacity, that specifies whether a meaningful value is available. 1 (Other) means the Printer places no restrictions on capacity and RemainingCapacity shall be null. 2 (Unknown) means the Printer cannot sense a meaningful value and RemainingCapacity shall be null. 3 (Actual) means the Printer can sense a meaningful value and RemainingCapacity shall be present. 4 (AtLeastOne) means that the Printer can only sense that at least one capacity unit remains and RemainingCapacity shall be present and shall contain the value zero or one.
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerSuppliesLevel, MIB.IETF|Finisher-MIB.finSuppyCurrentLevel
ModelCorrespondencestringCIM_PrintSupply.RemainingCapacity
ValueMapstring1, 2, 3, 4, ..
ValuesstringOther, Unknown, Actual, AtLeastOne, DMTF Reserved
SupplyUnituint32
DescriptionstringUnit of measure for this PrintSupply container (for a supply that is consumed) or receptacle (for waste that is produced).
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerSuppliesSupplyUnit, MIB.IETF|Finisher-MIB.finSupplyUnit, MIB.IETF|Printer-MIB.PrtMarkerSuppliesSupplyUnitTC
ModelCorrespondencestringCIM_PrintSupply.OtherSupplyUnit
ValueMapstring1, 2, 3, 4, 7, 8, 11, 12, 13, 14, 15, 16, 17, 18, 19, ..
ValuesstringOther, Unknown, TenThousandthsOfInches, Micrometers, Impressions, Sheets, Hours, ThousandthsOfOunces, TenthsOfGrams, HundrethsOfFluidOunces, TenthsOfMilliliters, Feet, Meters, Items, Percent, DMTF Reserved
Typeuint32
DescriptionstringThe type of this PrintSupply.
MappingStringsstringMIB.IETF|Printer-MIB.prtMarkerSuppliesType, MIB.IETF|Finisher-MIB.finSupplyType, MIB.IETF|IANA-PRINTER-MIB.PrtMarkerSuppliesTypeTC
ModelCorrespondencestringCIM_PrintSupply.OtherTypeDescription
ValueMapstring1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, ..
ValuesstringOther, Unknown, Toner, WasteToner, Ink, InkCartridge, InkRibbon, WasteInk, Opc, Developer, FuserOil, SolidWax, RibbonWax, WasteWax, Fuser, CoronaWire, FuserOilWick, CleanerUnit, FuserCleaningPad, TransferUnit, TonerCartridge, FuserOiler, Water, WasteWater, GlueWaterAdditive, WastePaper, BindingSupply, BandingSupply, StitchingWire, ShrinkWrap, PaperWrap, Staples, Inserts, Covers, DMTF Reserved

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
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