QDBusArgument Class

Documentación de las funciones miembro

QDBusArgument::QDBusArgument()

Construye un argumento QDBusArgument vacío.

Un objeto QDBusArgument vacío no permite ni la lectura ni la escritura.

QDBusArgument::QDBusArgument(const QDBusArgument &other)

Construye una copia del objeto other QDBusArgument.

Ambos objetos contendrán, por tanto, el mismo estado a partir de este momento. Los QDBusArguments son explícitamente compartidos y, por tanto, cualquier modificación en cualquiera de las copias afectará también a la otra.

[noexcept] QDBusArgument::~QDBusArgument()

Elimina los recursos asociados a este objeto QDBusArgument.

QVariant QDBusArgument::asVariant() const

Devuelve el argumento actual en forma de QVariant. Los tipos básicos serán decodificados y devueltos en QVariant, pero para tipos complejos, esta función devolverá un objeto QDBusArgument en QVariant. Es responsabilidad de quien llama decodificar el argumento (por ejemplo, llamando a asVariant() en él).

Por ejemplo, si el argumento actual es un INT32, esta función devolverá un QVariant con un argumento de tipo QMetaType::Int. Para una matriz de INT32, devolverá un QVariant que contiene un QDBusArgument.

Si se produce un error o si no hay más argumentos que decodificar (es decir, estamos al final de la lista de argumentos), esta función devolverá un QVariant no válido.

Véase también atEnd().

bool QDBusArgument::atEnd() const

Devuelve true si no hay más elementos que extraer de este QDBusArgument. Esta función suele utilizarse en los objetos QDBusArgument devueltos por beginMap() y beginArray().

void QDBusArgument::beginArray() const

Recurre a la matriz D-Bus para permitir la extracción de los elementos de la matriz.

Esta función se utiliza normalmente en operator>> operadores de flujo, como en el siguiente ejemplo:

// Extract a MyArray array of MyElement elements
const QDBusArgument &operator>>(const QDBusArgument &argument, MyArray &myArray)
{
    argument.beginArray();
    myArray.clear();

    while (!argument.atEnd()) {
        MyElement element;
        argument >> element;
        myArray.append(element);
    }

    argument.endArray();
    return argument;
}

Si el tipo que quieres demarshall es un QList o cualquiera de las Clases Contenedoras de Qt que toman un parámetro de plantilla, no necesitas declarar una función operator>> para ello, ya que Qt D-Bus proporciona plantillas genéricas para hacer el trabajo de demarshall de los datos. Lo mismo se aplica para los contenedores de secuencia de STL, como std::list, std::vector, etc.

Véase también atEnd(), beginStructure(), y beginMap().

void QDBusArgument::beginArray(QMetaType id)

Abre una nueva matriz D-Bus adecuada para añadir elementos del metatipo id.

Esta función se utiliza normalmente en operadores de flujo operator<<, como en el siguiente ejemplo:

// Append an array of MyElement types
QDBusArgument &operator<<(QDBusArgument &argument, const MyArray &myArray)
{
    argument.beginArray(qMetaTypeId<MyElement>());
    for (const auto &element : myArray)
        argument << element;
    argument.endArray();
    return argument;
}

Si el tipo que quieres marshall es un QList o cualquiera de las Clases Contenedoras de Qt que toman un parámetro de plantilla, no necesitas declarar una función operator<< para ello, ya que Qt D-Bus proporciona plantillas genéricas para hacer el trabajo de marshalling de los datos. Lo mismo se aplica para los contenedores de secuencia de STL, como std::list, std::vector, etc.

Véase también endArray(), beginStructure(), y beginMap().

void QDBusArgument::beginMap() const

Recurre al mapa D-Bus para permitir la extracción de los elementos del mapa.

Esta función se utiliza normalmente en operadores de flujo operator>>, como en el siguiente ejemplo:

// Extract a MyDictionary map that associates integers to MyElement items
const QDBusArgument &operator>>(const QDBusArgument &argument, MyDictionary &myDict)
{
    argument.beginMap();
    myDict.clear();

    while (!argument.atEnd()) {
        int key;
        MyElement value;
        argument.beginMapEntry();
        argument >> key >> value;
        argument.endMapEntry();
        myDict.insert(key, value);
    }

    argument.endMap();
    return argument;
}

Si el tipo que desea demarshall es un QMap o QHash, no necesita declarar una función operator>> para él, ya que Qt D-Bus proporciona plantillas genéricas para hacer el trabajo de demarshall de los datos.

Véase también endMap(), beginStructure(), beginArray(), y beginMapEntry().

void QDBusArgument::beginMap(QMetaType keyMetaType, QMetaType valueMetaType)

Abre un nuevo mapa D-Bus adecuado para añadir elementos. Los mapas son contenedores que asocian una entrada (la clave) a otra (el valor), como QMap o QHash de Qt. Los ids de los metatipos clave y valor del mapa deben pasarse en keyMetaType y valueMetaType respectivamente.

Esta función se utiliza normalmente en los operadores de streaming de operator<<, como en el siguiente ejemplo:

// Append a dictionary that associates ints to MyValue types
QDBusArgument &operator<<(QDBusArgument &argument, const MyDictionary &myDict)
{
    argument.beginMap(QMetaType::fromType<int>(), QMetaType::fromType<MyValue>());
    MyDictionary::const_iterator i;
    for (i = myDict.cbegin(); i != myDict.cend(); ++i) {
        argument.beginMapEntry();
        argument << i.key() << i.value();
        argument.endMapEntry();
    }
    argument.endMap();
    return argument;
}

Normalmente no es necesario proporcionar una función operator<< o operator>> para contenedores asociativos como QHash o std::map, ya que Qt D-Bus proporciona plantillas genéricas para hacer el trabajo de marshalling de los datos.

Véase también endMap(), beginStructure(), beginArray(), y beginMapEntry().

void QDBusArgument::beginMapEntry()

Abre una entrada de mapa D-Bus adecuada para añadir las entradas de clave y valor. Esta función sólo es válida cuando se ha abierto un mapa con beginMap().

Véase beginMap() para un ejemplo de utilización de esta función.

Véase también endMapEntry() y beginMap().

void QDBusArgument::beginMapEntry() const

Recurre a la entrada del mapa D-Bus para permitir la extracción del par clave y valor.

Véase beginMap() para un ejemplo de cómo se utiliza normalmente esta función.

Véase también endMapEntry() y beginMap().

void QDBusArgument::beginStructure()

Abre una nueva estructura D-Bus adecuada para añadir nuevos argumentos.

Esta función se utiliza normalmente en los operadores de flujo operator<<, como en el siguiente ejemplo:

QDBusArgument &operator<<(QDBusArgument &argument, const MyStructure &myStruct)
{
    argument.beginStructure();
    argument << myStruct.member1 << myStruct.member2;
    argument.endStructure();
    return argument;
}

Las estructuras pueden contener otras estructuras, por lo que el siguiente código también es válido:

QDBusArgument &operator<<(QDBusArgument &argument, const MyStructure &myStruct)
{
    argument.beginStructure();
    argument << myStruct.member1 << myStruct.member2;

    argument.beginStructure();
    argument << myStruct.member3.subMember1 << myStruct.member3.subMember2;
    argument.endStructure();

    argument << myStruct.member4;
    argument.endStructure();
    return argument;
}

Véase también endStructure(), beginArray(), y beginMap().

void QDBusArgument::beginStructure() const

Abre una estructura D-Bus apta para extraer elementos.

Esta función se utiliza normalmente en los operadores de flujo operator>>, como en el ejemplo siguiente:

const QDBusArgument &operator>>(const QDBusArgument &argument, MyStructure &myStruct)
{
    argument.beginStructure();
    argument >> myStruct.member1 >> myStruct.member2 >> myStruct.member3;
    argument.endStructure();
    return argument;
}

Véase también endStructure(), beginArray() y beginMap().

QDBusArgument::ElementType QDBusArgument::currentType() const

Devuelve la clasificación del tipo de elemento actual. Si se produce un error decodificando el tipo o si estamos al final del argumento, esta función devuelve QDBusArgument::UnknownType.

Esta función sólo tiene sentido cuando se demarshalling argumentos. Si se utiliza mientras se marshalling, siempre devolverá UnknownType.

void QDBusArgument::endArray()

Cierra un array D-Bus abierto con beginArray(). Esta función debe ser llamada el mismo número de veces que beginArray().

Véase también beginArray(), endStructure(), y endMap().

void QDBusArgument::endArray() const

Cierra el array D-Bus y permite extraer el siguiente elemento después del array.

Véase también beginArray().

void QDBusArgument::endMap()

Cierra un mapa D-Bus abierto con beginMap(). Esta función debe llamarse el mismo número de veces que beginMap().

Véase también beginMap(), endStructure(), y endArray().

void QDBusArgument::endMap() const

Cierra el mapa D-Bus y permite extraer el siguiente elemento después del mapa.

Véase también beginMap().

void QDBusArgument::endMapEntry()

Cierra una entrada de mapa D-Bus abierta con beginMapEntry(). Esta función debe llamarse el mismo número de veces que beginMapEntry().

Véase también beginMapEntry().

void QDBusArgument::endMapEntry() const

Cierra la entrada del mapa D-Bus y permite extraer el siguiente elemento del mapa.

Véase también beginMapEntry().

void QDBusArgument::endStructure()

Cierra una estructura D-Bus abierta con beginStructure(). Esta función debe llamarse el mismo número de veces que beginStructure().

Véase también beginStructure(), endArray() y endMap().

void QDBusArgument::endStructure() const

Cierra la estructura D-Bus y permite extraer el siguiente elemento después de la estructura.

Véase también beginStructure().

[noexcept] void QDBusArgument::swap(QDBusArgument &other)

Cambia este argumento por other. Esta operación es muy rápida y nunca falla.

QDBusArgument &QDBusArgument::operator<<(uchar arg)

Añade el valor primitivo arg de tipo BYTE al flujo D-Bus.

QDBusArgument &QDBusArgument::operator<<(bool arg)

Añade el valor primitivo arg de tipo BOOLEAN al flujo D-Bus.

QDBusArgument &QDBusArgument::operator<<(const QByteArray &arg)

Añade el QByteArray dado por arg como ARRAY of BYTE al flujo D-Bus.

QStringList y QByteArray son los dos únicos tipos no primitivos soportados directamente por QDBusArgument debido a su extendido uso en aplicaciones Qt.

Otros arrays son soportados a través de tipos compuestos en Qt D-Bus.

QDBusArgument &QDBusArgument::operator<<(const QDBusVariant &arg)

Añade el valor primitivo arg de tipo VARIANT al flujo D-Bus.

Un tipo de variante D-Bus puede contener cualquier tipo, incluidas otras variantes. Es similar al tipo Qt QVariant.

QDBusArgument &QDBusArgument::operator<<(const QString &arg)

Añade el valor primitivo arg de tipo STRING (cadena de caracteres Unicode) al flujo D-Bus.

QDBusArgument &QDBusArgument::operator<<(const QStringList &arg)

Añade el QStringList dado por arg como ARRAY of STRING al flujo D-Bus.

QStringList y QByteArray son los dos únicos tipos no primitivos soportados directamente por QDBusArgument debido a su extendido uso en aplicaciones Qt.

Otros arrays son soportados a través de tipos compuestos en Qt D-Bus.

QDBusArgument &QDBusArgument::operator<<(double arg)

Añade el valor primitivo arg de tipo DOUBLE (punto flotante de doble precisión) al flujo D-Bus.

QDBusArgument &QDBusArgument::operator<<(int arg)

Añade el valor primitivo arg de tipo INT32 al flujo D-Bus.

QDBusArgument &QDBusArgument::operator<<(qlonglong arg)

Añade el valor primitivo arg de tipo INT64 al flujo D-Bus.

QDBusArgument &QDBusArgument::operator<<(qulonglong arg)

Añade el valor primitivo arg de tipo UINT64 al flujo D-Bus.

QDBusArgument &QDBusArgument::operator<<(short arg)

Añade el valor primitivo arg de tipo INT16 al flujo D-Bus.

QDBusArgument &QDBusArgument::operator<<(uint arg)

Añade el valor primitivo arg de tipo UINT32 al flujo D-Bus.

QDBusArgument &QDBusArgument::operator<<(ushort arg)

Añade el valor primitivo arg de tipo UINT16 al flujo D-Bus.

QDBusArgument &QDBusArgument::operator=(const QDBusArgument &other)

Copia el objeto other QDBusArgument en éste.

Por lo tanto, ambos objetos contendrán el mismo estado a partir de este momento. Los QDBusArguments se comparten explícitamente y, por tanto, cualquier modificación en cualquiera de las copias afectará también a la otra.

const QDBusArgument &QDBusArgument::operator>>(uchar &arg) const

Extrae un argumento primitivo D-Bus de tipo BYTE del flujo D-Bus y lo coloca en arg.

const QDBusArgument &QDBusArgument::operator>>(QByteArray &arg) const

Extrae un array de bytes del flujo D-Bus y lo devuelve como QByteArray.

QStringList y QByteArray son los dos únicos tipos no primitivos soportados directamente por QDBusArgument debido a su extendido uso en aplicaciones Qt.

Otros arrays son soportados a través de tipos compuestos en Qt D-Bus.

const QDBusArgument &QDBusArgument::operator>>(QDBusVariant &arg) const

Extrae un argumento primitivo D-Bus de tipo VARIANT del flujo D-Bus.

Un tipo de variante D-Bus puede contener cualquier tipo, incluidas otras variantes. Es similar al tipo Qt QVariant.

En caso de que la variante contenga un tipo no soportado directamente por QDBusArgument, el valor del QDBusVariant devuelto contendrá otro QDBusArgument. Es su responsabilidad demarshall aún más en otro tipo.

const QDBusArgument &QDBusArgument::operator>>(QString &arg) const

Extrae un argumento primitivo D-Bus de tipo STRING (cadena de caracteres Unicode) del flujo D-Bus.

const QDBusArgument &QDBusArgument::operator>>(QStringList &arg) const

Extrae un array de cadenas del flujo D-Bus y lo devuelve como QStringList.

QStringList y QByteArray son los dos únicos tipos no primitivos soportados directamente por QDBusArgument debido a su extendido uso en aplicaciones Qt.

Otros arrays son soportados a través de tipos compuestos en Qt D-Bus.

const QDBusArgument &QDBusArgument::operator>>(bool &arg) const

Extrae un argumento primitivo D-Bus de tipo BOOLEAN del flujo D-Bus.

const QDBusArgument &QDBusArgument::operator>>(double &arg) const

Extrae un argumento primitivo D-Bus de tipo DOUBLE (coma flotante de doble precisión) del flujo D-Bus.

const QDBusArgument &QDBusArgument::operator>>(int &arg) const

Extrae un argumento primitivo D-Bus de tipo INT32 del flujo D-Bus.

const QDBusArgument &QDBusArgument::operator>>(qlonglong &arg) const

Extrae un argumento primitivo D-Bus de tipo INT64 del flujo D-Bus.

const QDBusArgument &QDBusArgument::operator>>(qulonglong &arg) const

Extrae un argumento primitivo D-Bus de tipo UINT64 del flujo D-Bus.

const QDBusArgument &QDBusArgument::operator>>(short &arg) const

Extrae un argumento primitivo D-Bus de tipo INT16 del flujo D-Bus.

const QDBusArgument &QDBusArgument::operator>>(uint &arg) const

Extrae un argumento primitivo D-Bus de tipo UINT32 del flujo D-Bus.

const QDBusArgument &QDBusArgument::operator>>(ushort &arg) const

Extrae un argumento primitivo D-Bus de tipo UINT16 del flujo D-Bus.