MMSimpleStatus

## MMSimpleStatus MMSimpleStatus — Helper object to handle overall modem status. |

## Synopsis

    struct              MMSimpleStatus;

    MMModemState        mm_simple_status_get_state          (MMSimpleStatus *self);
    guint32             mm_simple_status_get_signal_quality (MMSimpleStatus *self,
                                                             gboolean *recent);
    MMModemAccessTechnology mm_simple_status_get_access_technologies
                                                            (MMSimpleStatus *self);
    void                mm_simple_status_get_current_bands  (MMSimpleStatus *self,
                                                             const MMModemBand **bands,
                                                             guint *n_bands);
    MMModem3gppRegistrationState mm_simple_status_get_3gpp_registration_state
                                                            (MMSimpleStatus *self);
    const gchar *       mm_simple_status_get_3gpp_operator_code
                                                            (MMSimpleStatus *self);
    const gchar *       mm_simple_status_get_3gpp_operator_name
                                                            (MMSimpleStatus *self);
    MMModemCdmaRegistrationState mm_simple_status_get_cdma_cdma1x_registration_state
                                                            (MMSimpleStatus *self);
    MMModemCdmaRegistrationState mm_simple_status_get_cdma_evdo_registration_state
                                                            (MMSimpleStatus *self);
    guint               mm_simple_status_get_cdma_nid       (MMSimpleStatus *self);
    guint               mm_simple_status_get_cdma_sid       (MMSimpleStatus *self);

## Object Hierarchy

      GObject
       +----MMSimpleStatus

## Properties

      "access-technologies"      MMModemAccessTechnology  : Read / Write
      "cdma-cdma1x-registration-state" MMModemCdmaRegistrationState  : Read / Write
      "cdma-evdo-registration-state" MMModemCdmaRegistrationState  : Read / Write
      "cdma-nid"                 guint                 : Read / Write
      "cdma-sid"                 guint                 : Read / Write
      "current-bands"            GVariant*             : Read / Write
      "m3gpp-operator-code"      gchar*                : Read / Write
      "m3gpp-operator-name"      gchar*                : Read / Write
      "m3gpp-registration-state" MMModem3gppRegistrationState  : Read / Write
      "signal-quality"           GVariant*             : Read / Write
      "state"                    MMModemState          : Read / Write

## Description

The MMSimpleStatus is an object handling the general modem status properties, available in the Simple interface.

This object is retrieved with either `mm_modem_simple_get_status()` or `mm_modem_simple_get_status_sync()`.

## Details

### struct MMSimpleStatus

    struct MMSimpleStatus;

The MMSimpleStatus structure contains private data and should only be accessed using the provided API.

### mm_simple_status_get_state ()

    MMModemState        mm_simple_status_get_state          (MMSimpleStatus *self);

Gets the state of the modem.

`self` : | a MMSimpleStatus.
Returns : | a MMModemState.

### mm_simple_status_get_signal_quality ()

    guint32             mm_simple_status_get_signal_quality (MMSimpleStatus *self,
                                                             gboolean *recent);

Gets the signal quality.

`self` : | a MMSimpleStatus.
`recent` : | indication of whether the given signal quality is considered recent. [out][allow-none]
Returns : | the signal quality.

### mm_simple_status_get_access_technologies ()

    MMModemAccessTechnology mm_simple_status_get_access_technologies
                                                            (MMSimpleStatus *self);

Gets the currently used access technologies.

`self` : | a MMSimpleStatus.
Returns : | a bitmask of MMModemAccessTechnology values.

### mm_simple_status_get_current_bands ()

    void                mm_simple_status_get_current_bands  (MMSimpleStatus *self,
                                                             const MMModemBand **bands,
                                                             guint *n_bands);

Gets the currently used frequency bands.

`self` : | a MMSimpleStatus.
`bands` : | location for an array of MMModemBand values. Do not free the returned value, it is owned by `self`. [out]
`n_bands` : | number of elements in `bands`. [out]

### mm_simple_status_get_3gpp_registration_state ()

    MMModem3gppRegistrationState mm_simple_status_get_3gpp_registration_state
                                                            (MMSimpleStatus *self);

Gets the current state of the registration in the 3GPP network.

`self` : | a MMSimpleStatus.
Returns : | a MMModem3gppRegistrationState.

### mm_simple_status_get_3gpp_operator_code ()

    const gchar *       mm_simple_status_get_3gpp_operator_code
                                                            (MMSimpleStatus *self);

Gets the MCC/MNC of the operator of the 3GPP network where the modem is registered.

`self` : | a MMSimpleStatus.
Returns : | the operator code, or `NULL` if unknown. Do not free the returned value, it is owned by `self`.

### mm_simple_status_get_3gpp_operator_name ()

    const gchar *       mm_simple_status_get_3gpp_operator_name
                                                            (MMSimpleStatus *self);

Gets the name of the operator of the 3GPP network where the modem is registered.

`self` : | a MMSimpleStatus.
Returns : | the operator name, or `NULL` if unknown. Do not free the returned value, it is owned by `self`.

### mm_simple_status_get_cdma_cdma1x_registration_state ()

    MMModemCdmaRegistrationState mm_simple_status_get_cdma_cdma1x_registration_state
                                                            (MMSimpleStatus *self);

Gets the current state of the registration in the CDMA-1x network.

`self` : | a MMSimpleStatus.
Returns : | a MMModemCdmaRegistrationState.

### mm_simple_status_get_cdma_evdo_registration_state ()

    MMModemCdmaRegistrationState mm_simple_status_get_cdma_evdo_registration_state
                                                            (MMSimpleStatus *self);

Gets the current state of the registration in the EV-DO network.

`self` : | a MMSimpleStatus.
Returns : | a MMModemCdmaRegistrationState.

### mm_simple_status_get_cdma_nid ()

    guint               mm_simple_status_get_cdma_nid       (MMSimpleStatus *self);

Gets the Network Identification number of the CDMA network.

`self` : | a MMSimpleStatus.
Returns : | the NID, or `MM_MODEM_CDMA_NID_UNKNOWN` if unknown.

### mm_simple_status_get_cdma_sid ()

    guint               mm_simple_status_get_cdma_sid       (MMSimpleStatus *self);

Gets the System Identification number of the CDMA network.

`self` : | a MMSimpleStatus.
Returns : | the SID, or `MM_MODEM_CDMA_SID_UNKNOWN` if unknown.

## Property Details

### The `"access-technologies"` property

      "access-technologies"      MMModemAccessTechnology  : Read / Write

Access technologies used by the modem.

### The `"cdma-cdma1x-registration-state"` property

      "cdma-cdma1x-registration-state" MMModemCdmaRegistrationState  : Read / Write

Registration state in the CDMA1x network.

Default value: MM_MODEM_CDMA_REGISTRATION_STATE_UNKNOWN

### The `"cdma-evdo-registration-state"` property

      "cdma-evdo-registration-state" MMModemCdmaRegistrationState  : Read / Write

Registration state in the EV-DO network.

Default value: MM_MODEM_CDMA_REGISTRATION_STATE_UNKNOWN

### The `"cdma-nid"` property

      "cdma-nid"                 guint                 : Read / Write

Network Identifier of the serving CDMA1x network.

Allowed values: <= 99999

Default value: 99999

### The `"cdma-sid"` property

      "cdma-sid"                 guint                 : Read / Write

System Identifier of the serving CDMA1x network.

Allowed values: <= 99999

Default value: 99999

### The `"current-bands"` property

      "current-bands"            GVariant*             : Read / Write

Frequency bands used by the modem.

Allowed values: GVariant<au>

Default value: NULL

### The `"m3gpp-operator-code"` property

      "m3gpp-operator-code"      gchar*                : Read / Write

Code of the current operator in the 3GPP network.

Default value: NULL

### The `"m3gpp-operator-name"` property

      "m3gpp-operator-name"      gchar*                : Read / Write

Name of the current operator in the 3GPP network.

Default value: NULL

### The `"m3gpp-registration-state"` property

      "m3gpp-registration-state" MMModem3gppRegistrationState  : Read / Write

Registration state in the 3GPP network.

Default value: MM_MODEM_3GPP_REGISTRATION_STATE_UNKNOWN

### The `"signal-quality"` property

      "signal-quality"           GVariant*             : Read / Write

Signal quality reported by the modem.

Allowed values: GVariant<(ub)>

Default value: NULL

### The `"state"` property

      "state"                    MMModemState          : Read / Write

State of the modem.

Default value: MM_MODEM_STATE_UNKNOWN