# Class CIM_CallBasedModem
extends CIM_Modem

CIM_CallBasedModem is the superclass for grouping the numerous types of call-based modems. The POTSModem is a type of call- based Modem.

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

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_ManagedSystemElement
|
+--CIM_LogicalElement
|
+--CIM_EnabledLogicalElement
|
+--CIM_AllocatedLogicalElement
|
+--CIM_LogicalDevice
|
+--CIM_Modem
|
+--CIM_CallBasedModem

## Direct Known Subclasses

CIM_ISDNModem
CIM_POTSModem

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Abstract | boolean | true
Description | string | CIM_CallBasedModem is the superclass for grouping the numerous types of call-based modems. The POTSModem is a type of call- based Modem.
UMLPackagePath | string | CIM::Device::Modems
Version | string | 2.10.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
BlockErrors | uint32 |
Counter | boolean | true
Description | string | Total number of block errors seen by the Device on the last or current call. A call in-progress is indicated by the CallStatus property.
BlocksReceived | uint32 |
Counter | boolean | true
Description | string | Total number of blocks received by the Device on the last or current call. A call in-progress is indicated by the CallStatus property.
BlocksResent | uint32 |
Counter | boolean | true
Description | string | Total number of blocks resent by the Device on the last or current call. A call in-progress is indicated by the CallStatus property.
BlocksSent | uint32 |
Counter | boolean | true
Description | string | Total number of blocks sent by the Device on the last or current call. A call in-progress is indicated by the CallStatus property.
CallLength | datetime |
Description | string | Length of the last or current call. A call in-progress is indicated by the CallStatus property. The 'interval' format of the datetime data type should be used for the property value.
CallSpeed | uint32 |
Description | string | The rate at which the receiver and transmitter are or were last cooperating, on a call, before disconnection.
PUnit | string | bit / second
Units | string | Bits per Second
CallStatus | uint16 |
Description | string | Status of the Modem. For example, information regarding modem negotiation or whether the modem is connected (values 8 and 9, respectively) can be conveyed in this property.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10
Values | string | Unknown, Other, Offline, On Hook, Dialing, Waiting for Answer, Ringing, Modem Detected, Negotiating, Online, Error
CharsLost | uint32 |
Counter | boolean | true
Description | string | Total number of characters lost by the Device on the last or current call. A call in-progress is indicated by the CallStatus property.
CharsReceived | uint32 |
Counter | boolean | true
Description | string | Total number of characters received by the Device on the last or current call. A call in-progress is indicated by the CallStatus property.
CharsSent | uint32 |
Counter | boolean | true
Description | string | Total number of characters sent by the Device on the last or current call. A call in-progress is indicated by the CallStatus property.
CompressionInfo | uint16 |
Description | string | Describes the current data compression characteristics of the Modem.
ModelCorrespondence | string | CIM_CallBasedModem.CompressionSupported, CIM_CallBasedModem.OtherCompressionInfoDescription
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
Values | string | Unknown, Other, No Compression, MNP 5, V.42bis, MNP 3, MNP 4, V.58, PEP, HST
ErrorControlInfo | uint16 |
Description | string | Describes the current error correction characteristics of the Modem.
ModelCorrespondence | string | CIM_CallBasedModem.ErrorControlSupported, CIM_CallBasedModem.OtherErrorControlInfoDescription
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
Values | string | Unknown, Other, No Error Correction, MNP 4, LAPM, V.58, ECP Enhanced Cellular Protocol, ETC Enhanced Throughput Cellular, MNP 1, MNP 2, MNP 3, MNP10, PEP, HST
FallbackEnabled | boolean |
Description | string | Indicates whether online fallback is enabled so that it can be negotiated by the Modem.
ModulationScheme | uint16 |
Description | string | Describes the current modulation scheme of the Modem.
ModelCorrespondence | string | CIM_CallBasedModem.ModulationSupported, CIM_CallBasedModem.OtherSchemeDescription
ValueMap | string | 0, 1, 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
Values | string | Unknown, Other, Not Supported, Bell 103, Bell 212A, V.22bis, V.32, V.32bis, V.terbo, V.FC, V.34, V.34bis, V.17 (G3 Fax Call), V.21, V.22, V.23 Constant Carrier (1200/75), V.23 Switched Carrier (Half Duplex), V.26bis, V.26ter, V.27ter (G3 Fax Call), V.29 HD (G3 Fax Call), V.34 HD (G3 Fax Call), V.90 Issue 1 (Asymmetric), V.90 Issue 2 (Symmetric), V.58, X2, K56FLEX, V.Fast, PEP, HST
NumberDialed | string |
Description | string | Last or current number dialed to which the statistics apply, or NULL if the call was incoming.
OtherCompressionDescription | string |
Description | string | Description of the compression type when "Other " (value=1) is defined in the CompressionSupported array. If there are multiple "Other" types, then combine their descriptions into a single string.
ModelCorrespondence | string | CIM_CallBasedModem.CompressionSupported
OtherCompressionInfoDescription | string |
Description | string | Description of the current compression type when "Other" (value=1) is specified in the CompressionInfo property.
ModelCorrespondence | string | CIM_CallBasedModem.CompressionInfo
OtherErrorControlDescription | string |
Description | string | Description of the error control type when "Other" (value= 1) is specified in the ErrorControlSupported property. If there are multiple "Other" types, then combine their descriptions into a single string.
ModelCorrespondence | string | CIM_CallBasedModem.ErrorControlSupported
OtherErrorControlInfoDescription | string |
Description | string | Description of the error control when "Other" (value=1) is defined as the value of the ErrorControlInfo property.
ModelCorrespondence | string | CIM_CallBasedModem.ErrorControlInfo
OtherModulationDescription | string |
Description | string | Description of the current modulation type when "Other" (value=1) is specified in the ModulationSupported property. If there are multiple "Other" types, then combine their descriptions into a single string.
ModelCorrespondence | string | CIM_CallBasedModem.ModulationSupported
OtherSchemeDescription | string |
Description | string | Description of the current modulation type when "Other" (value=1) is specified in the ModulationScheme property.
ModelCorrespondence | string | CIM_CallBasedModem.ModulationScheme
TimeOfLastReset | datetime |
Description | string | Time of the last reset of the Modem.
CompressionSupported | uint16[] |
Description | string | An array that enumerates all the compression protocols that are supported by the Modem.
ModelCorrespondence | string | CIM_CallBasedModem.OtherCompressionDescription
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
Values | string | Unknown, Other, No Compression, MNP 5, V.42bis, MNP 3, MNP 4, V.58, PEP, HST
ErrorControlSupported | uint16[] |
Description | string | An array that enumerates the error control protocols that are supported by the Modem. The beginning entries in the Values qualifier array are mapped from the CIM_POTSModem ErrorControlInfo property.
ModelCorrespondence | string | CIM_CallBasedModem.OtherErrorControlDescription
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
Values | string | Unknown, Other, No Error Correction, MNP 4, LAPM, V.58, ECP Enhanced Cellular Protocol, ETC Enhanced Throughput Cellular, MNP 1, MNP 2, MNP 3, MNP10, PEP, HST
ModulationSupported | uint16[] |
Description | string | An array that enumerates all the modulation protocols that are supported by the Modem. The beginning entries in the Values qualifier array are mapped from the CIM_POTSModem ModulationScheme property.
ModelCorrespondence | string | CIM_CallBasedModem.OtherModulationDescription
ValueMap | string | 0, 1, 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
Values | string | Unknown, Other, Not Supported, Bell 103, Bell 212A, V.22bis, V.32, V.32bis, V.terbo, V.FC, V.34, V.34bis, V.17 (G3 Fax Call), V.21, V.22, V.23 Constant Carrier (1200/75), V.23 Switched Carrier (Half Duplex), V.26bis, V.26ter, V.27ter (G3 Fax Call), V.29 HD (G3 Fax Call), V.34 HD (G3 Fax Call), V.90 Issue 1 (Asymmetric), V.90 Issue 2 (Symmetric), V.58, X2, K56FLEX, V.Fast, PEP, HST

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
AllocationState | string | CIM_LogicalDevice
Availability | uint16 | CIM_LogicalDevice
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_LogicalDevice
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
DeviceID | string | CIM_LogicalDevice
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_EnabledLogicalElement
ErrorCleared | boolean | CIM_LogicalDevice
ErrorDescription | string | CIM_LogicalDevice
Generation | uint64 | CIM_ManagedElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
LastErrorCode | uint32 | CIM_LogicalDevice
LocationIndicator | uint16 | CIM_LogicalDevice
MaxQuiesceTime | uint64 | CIM_LogicalDevice
Name | string | CIM_ManagedSystemElement
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
PowerManagementSupported | boolean | CIM_LogicalDevice
PowerOnHours | uint64 | CIM_LogicalDevice
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RequestedState | uint16 | CIM_EnabledLogicalElement
Status | string | CIM_ManagedSystemElement
StatusInfo | uint16 | CIM_LogicalDevice
SystemCreationClassName | string | CIM_LogicalDevice
SystemName | string | CIM_LogicalDevice
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TotalPowerOnHours | uint64 | CIM_LogicalDevice
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AdditionalAvailability | uint16[] | CIM_LogicalDevice
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
IdentifyingDescriptions | string[] | CIM_LogicalDevice
OperationalStatus | uint16[] | CIM_ManagedSystemElement
OtherIdentifyingInfo | string[] | CIM_LogicalDevice
PowerManagementCapabilities | uint16[] | CIM_LogicalDevice
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
EnableDevice | uint32 | CIM_LogicalDevice
OnlineDevice | uint32 | CIM_LogicalDevice
QuiesceDevice | uint32 | CIM_LogicalDevice
RequestStateChange | uint32 | CIM_EnabledLogicalElement
Reset | uint32 | CIM_LogicalDevice
RestoreProperties | uint32 | CIM_LogicalDevice
SaveProperties | uint32 | CIM_LogicalDevice
SetPowerState | uint32 | CIM_LogicalDevice