QValueSpacePublisher Class Reference

Member Function Documentation

QValueSpacePublisher::QValueSpacePublisher ( const QString & path, QObject * parent = 0 )

Constructs a QValueSpacePublisher with the specified parent that publishes values under path.

This function was introduced in Qt Mobility 1.0.

QValueSpacePublisher::QValueSpacePublisher ( QValueSpace::LayerOptions filter, const QString & path, QObject * parent = 0 )

Constructs a QValueSpacePublisher with the specified parent that publishes values under path. The filter parameter is used to limit which layer this QValueSpacePublisher will access.

The constructed Value Space publisher will access the layer with the highest order that matches filter and for which path is a valid path.

If no suitable layer is found, the constructed QValueSpacePublisher will be unconnected.

This function was introduced in Qt Mobility 1.0.

See also isConnected().

QValueSpacePublisher::QValueSpacePublisher ( const QUuid & uuid, const QString & path, QObject * parent = 0 )

Constructs a QValueSpacePublisher with the specified parent that publishes values under path. Only the layer identified by uuid will be accessed by this publisher.

Use of this constructor is not platform agnostic. If possible use one of the constructors that take a QValueSpace::LayerOptions parameter instead.

If a layer with a matching uuid is not found, the constructed QValueSpacePublisher will be unconnected.

This function was introduced in Qt Mobility 1.0.

See also isConnected().

QValueSpacePublisher::~QValueSpacePublisher () [virtual]

Destroys the QValueSpacePublisher. This will remove all values published by this publisher in non-permanent layers.

This function was introduced in Qt Mobility 1.0.

void QValueSpacePublisher::connectNotify ( const char * member ) [virtual protected]

Reimplemented from QObject::connectNotify().

Registers this QValueSpacePublisher for notifications when QValueSpaceSubscribers are interested in values under path().

Generally you do not need to call this function as it is automatically called when connections are made to this classes signals. member is the signal that has been connected.

If you reimplement this virtual function it is important that you call this implementation from your implementation.

This function was introduced in Qt Mobility 1.0.

See also interestChanged().

void QValueSpacePublisher::interestChanged ( const QString & attribute, bool interested ) [signal]

Signal that is emitted when interest in attribute changes. If interested is true at least on QValueSpaceSubscriber is interested in the value of attribute.

This function was introduced in Qt Mobility 1.0.

bool QValueSpacePublisher::isConnected () const

Returns true if this QValueSpacePublisher is connected to an available layer; otherwise returns false.

This function was introduced in Qt Mobility 1.0.

QString QValueSpacePublisher::path () const

Returns the path that this QValueSpacePublisher refers to.

This function was introduced in Qt Mobility 1.0.

void QValueSpacePublisher::resetValue ( const QString & name ) [slot]

Removes the value name and all sub-attributes from the system.

For example:

 QValueSpacePublisher publisher("/Device");
 publisher.setValue("State", "Starting");
 publisher.setValue("State/Memory", "1000");
 publisher.sync();
 // QValueSpaceSubscriber("/Device/State").value() == QVariant("Starting")
 // QValueSpaceSubscriber("/Device/State/Memory").value() == QVariant("1000")

 publisher.resetValue("State");
 publisher.sync();
 // QValueSpaceSubscriber("/Device/State").value() == QVariant();
 // QValueSpaceSubscriber("/Device/State/Memory").value() == QVariant();

This function was introduced in Qt Mobility 1.0.

void QValueSpacePublisher::setValue ( const QString & name, const QVariant & data ) [slot]

Sets the value name on the publisher to data. If name is empty, this call will set the value of this publisher's path.

For example:

 QValueSpacePublisher publisher("/Device");
 publisher.setValue("State", "Starting");
 publisher.sync();

 // QValueSpaceSubscriber("/Device/State").value() == QVariant("Starting")

This function was introduced in Qt Mobility 1.0.

void QValueSpacePublisher::sync ()

Forcibly sync all Value Space publisher using the same layer as this publisher.

For performance reasons attribute changes are batched internally by QValueSpacePublisher instances. In cases where the visibility of changes must be synchronized with other processes, calling this function will flush these batches. By the time this function returns, all other processes in the system will be able to see the attribute changes.

Generally, calling this function is unnecessary.

This function was introduced in Qt Mobility 1.0.