sensrvtypes.h File Reference

Link against: SensrvClient.lib


#include <e32base.h>
#include <sensrvproperty.h>

Go to the source code of this file.


Typedefs

typedef TUint32  TSensrvChannelId
  Type definition for a channel id used by TSensrvChannelInfo.
typedef TUint32  TSensrvChannelTypeId
  Type definition for a channel type used by TSensrvChannelInfo.
typedef TUint32  TSensrvChannelDataTypeId
  Typedef for datatype Id used by TSensrvChannelInfo.
typedef RArray< TSensrvChannelId RSensrvChannelList
  RArray based channel Id list.
typedef RArray< TSensrvProperty RSensrvPropertyList
  RArray based property list.
typedef RArray< TSensrvChannelInfo RSensrvChannelInfoList
  RArray based channel info list.

Enumerations

enum   TSetPropertySuccessIndicator { ESetPropertyIndicationUnknown = 0, ESetPropertyIndicationAvailable, ESetPropertyIndicationPossible, ESetPropertyIndicationUnavailable }
  Indication of whether a call to CSensrvChannel::SetPropertyL() is likely to succeed. More...
enum   TSensrvQuantity {
  ESensrvQuantityNotUsed = -1, ESensrvQuantityNotdefined = 0, ESensrvQuantityAcceleration = 10, ESensrvQuantityTapping = 11,
  ESensrvQuantityOrientation = 12, ESensrvQuantityRotation = 13, ESensrvQuantityMagnetic = 14, ESensrvQuantityAngle = 15,
  ESensrvQuantityProximity = 16, ESensrvQuantityLicenseeBase = 8192, ESensrvQuantityLicenseeEnd = 12287
}
  The quantity of channel values. More...
enum   TSensrvContextType {
  ESensrvContextTypeNotUsed = -1, ESensrvContextTypeNotDefined = 0, ESensrvContextTypeAmbient = 1, ESensrvContextTypeDevice = 2,
  ESensrvContextTypeUser = 3, ESensrvContextTypeLicenseeBase = 8192, ESensrvContextTypeLicenseeEnd = 12287
}
  The context type of a sensor. More...
enum   TSensrvConnectionType {
  ESensrvConnectionTypeNotDefined = 0, ESensrvConnectionTypeEmbedded, ESensrvConnectionTypeWired, ESensrvConnectionTypeWireless,
  ESensrvConnectionTypeLicenseeBase = 8192, ESensrvConnectionTypeLicenseeEnd = 12287
}
  The connection type of a sensor. More...
enum   TSensrvChannelUnit {
  ESensrvChannelUnitNotDefined = 0, ESensevChannelUnitAcceleration = 10, ESensrvChannelUnitGravityConstant = 11, ESensrvChannelUnitMagneticFluxDensity = 12,
  ESensrvChannelUnitLicenseeBase = 8192, ESensrvChannelUnitLicenseeEnd = 12287
}
  The unit of the data measured by the sensor channel Licensee defined values must be between ESensrvChannelUnitLicenseeBase and ESensrvChannelUnitLicenseeEnd. More...
enum   TSensrvChannelDataFormat {
  ESensrvChannelDataFormatNotDefined = 0, ESensrvChannelDataFormatAbsolute, ESensrvChannelDataFormatScaled, ESensrvChannelDataFormatLicenseeBase = 8192,
  ESensrvChannelDataFormatLicenseeEnd = 12287
}
  The format of the data measured by the sensor channel Licensee defined values must be between ESensrvChannelDataFormatLicenseeBase and ESensrvChannelDataFormatLicenseeEnd. More...
enum   TSensrvErrorSeverity { ESensrvErrorSeverityNotDefined = 0, ESensrvErrorSeverityMinor, ESensrvErrorSeverityFatal }
  The error code received by a sensor server listener. More...
enum   TSensrvChannelChangeType { ESensrvChannelChangeTypeNotDefined = 0, ESensrvChannelChangeTypeRemoved, ESensrvChannelChangeTypeAdded }
  The channel change is detected by the Channel Listener. More...
enum   TSensrvPower { ESensrvPowerPowerDown = 0, ESensrvPowerPowerUp }
  The TSensrvPower represents sensor power state. More...
enum   TSensrvAvailability { ESensrvAvailabilityFalse = 0, ESensrvAvailabilityTrue }
  The TSensrvAvailability represents sensor channel availability. More...

Variables

const TInt  KSensrvVendorIdLength = 16
  Max length of the vendor Id.
const TInt  KSensrvLocationLength = 16
  Max length of the location string.
const TInt  KSensrvItemIndexNone = -1
  Item index for properties that are not data item specific.
const TSensrvChannelTypeId  KSensrvChannelTypeIdUndefined = 0x00000000
  Undefined Channel id for use when finding channels.

Typedef Documentation

typedef RArray<TSensrvChannelInfo> RSensrvChannelInfoList
 

RArray based channel info list.

See also:
CSensrvChannelFinder

MSsyCallback

typedef RArray<TSensrvChannelId> RSensrvChannelList
 

RArray based channel Id list.

See also:
MSsyCallback

MSsyPropertyProvider

typedef RArray<TSensrvProperty> RSensrvPropertyList
 

RArray based property list.

See also:
CSensrvChannel

MSsyPropertyProvider

typedef TUint32 TSensrvChannelDataTypeId
 

Typedef for datatype Id used by TSensrvChannelInfo.

This identifies the data type for the data that the channel provides. This value is a uid and is unique among all channels. See sensor channel specific header files.

See also:
TSensrvChannelInfo
typedef TUint32 TSensrvChannelId
 

Type definition for a channel id used by TSensrvChannelInfo.

Its value is assigned by the Sensor Server and uniquely identifies a channel for the client session. When the client session has ended the channel id is no longer valid.

See also:
TSensrvChannelInfo

CSsyControl

MSsyCallback

MSsyChannelDataProvider

MSsyPropertyProvider

typedef TUint32 TSensrvChannelTypeId
 

Type definition for a channel type used by TSensrvChannelInfo.

This id identifies the type of channel * that the object represents and therefore the content of the channel. This value is a uid and is unique among all channels. See sensor channel specific header files. A client can use this value as one of the search criteria when finding channels.

See also:
TSensrvChannelInfo

Enumeration Type Documentation

enum TSensrvAvailability
 

The TSensrvAvailability represents sensor channel availability.

Possible values:

  • ESensrvAvailabilityFalse, the channel is not available, which is caused by either sensor being powered down, or a dependency with another channel prevents the channel for being available
  • ESensrvAvailabilityTrue, the channel is available
Enumerator:
ESensrvAvailabilityFalse  Channel not available.
ESensrvAvailabilityTrue  Channel available.
enum TSensrvChannelChangeType
 

The channel change is detected by the Channel Listener.

See also:
MSensrvChannelListener
Enumerator:
ESensrvChannelChangeTypeNotDefined  Channel Change not defined.
ESensrvChannelChangeTypeRemoved  Channel was removed.
ESensrvChannelChangeTypeAdded  Channel was added.
enum TSensrvChannelDataFormat
 

The format of the data measured by the sensor channel Licensee defined values must be between ESensrvChannelDataFormatLicenseeBase and ESensrvChannelDataFormatLicenseeEnd.

 Scaled format example:
 Measure range for the accelerometer, KSensrvPropIdMeasureRange: -2g to 2g.
 KSensrvPropIdScaledRange defines following values:
 Range: Min: -127  Max: 127

 Example values for the data item and their absolute values:
 Data item: -64 = > -64/127 * 2g = -1.01g
 Data item:  32 = > 32/127 * 2g = 0.51g
 Data item: 127 = > 127/127 * 2g = 2g
See also:
KSensrvPropIdChannelDataFormat
Enumerator:
ESensrvChannelDataFormatNotDefined  Data Fomat is not defined.
ESensrvChannelDataFormatAbsolute  Value of the data item represents actual value of the measured quantity.
ESensrvChannelDataFormatScaled  Value of the data item represents a relative value which is scaled between the maximum and minimum values of the measured quantity.
ESensrvChannelDataFormatLicenseeBase  Start of licensee Data Format range definitions.
ESensrvChannelDataFormatLicenseeEnd  End of licensee Data Format range definitions.
enum TSensrvChannelUnit
 

The unit of the data measured by the sensor channel Licensee defined values must be between ESensrvChannelUnitLicenseeBase and ESensrvChannelUnitLicenseeEnd.

See also:
KSensrvPropIdChannelUnit
Enumerator:
ESensrvChannelUnitNotDefined  Channel Unit is not defined.
ESensevChannelUnitAcceleration  Acceleration, meter per square second (m/s^2).
ESensrvChannelUnitGravityConstant  Acceleration, gravitational constant (G).
ESensrvChannelUnitMagneticFluxDensity  ESensrvChannelUnitMagneticFluxDensity, magnetic field density, Tesla (T).
ESensrvChannelUnitLicenseeBase  Start of licensee Channel Unit range definitions.
ESensrvChannelUnitLicenseeEnd  End of licensee Channel Unit range definitions.
enum TSensrvConnectionType
 

The connection type of a sensor.

Licensee defined values must be between ESensrvConnectionTypeLicenseeBase and ESensrvConnectionTypeLicenseeEnd

See also:
KSensrvSensorConnectionType
Enumerator:
ESensrvConnectionTypeNotDefined  Connection type is not defined.
ESensrvConnectionTypeEmbedded  Sensor is embedded in the phone.
ESensrvConnectionTypeWired  Sensor is attached to phone by wire.
ESensrvConnectionTypeWireless  Sensor is attached to phone wirelessly.
ESensrvConnectionTypeLicenseeBase  Start of licensee Connection type range definitions.
ESensrvConnectionTypeLicenseeEnd  End of licensee Connection type range definitions.
enum TSensrvContextType
 

The context type of a sensor.

Licensee defined values must be between ESensrvContextTypeLicenseeBase and ESensrvContextTypeLicenseeEnd

See also:
TSensrvChannelInfo
Enumerator:
ESensrvContextTypeNotUsed  Channel doesn't provide sensor context type information.
ESensrvContextTypeNotDefined  Context type is not defined.
ESensrvContextTypeAmbient  Sensor is measuring a physical quantity of the phones environment e.g.

pressure, temperature, sound intensity, humidity

ESensrvContextTypeDevice  Sensor is measuring a physical quantity that the phone itself is undergoing e.g.

acceleration, rotation, orientation

ESensrvContextTypeUser  Sensor is measuring a physical quantity that is user stimulated e.g.

body temperature, body mass, heart rate

ESensrvContextTypeLicenseeBase  Start of licensee context range definitions.
ESensrvContextTypeLicenseeEnd  End of licensee context range definitions.
enum TSensrvErrorSeverity
 

The error code received by a sensor server listener.

See also:
MSensrvChannelConditionListener

MSensrvChannelListener

MSensrvDataListener

MSensrvPropertyListener

Enumerator:
ESensrvErrorSeverityNotDefined  Error Severity is not defined.
ESensrvErrorSeverityMinor  The channel has a temporary failure but listening has been successfully continued.
ESensrvErrorSeverityFatal  The channel has a fatal error and the channel was closed.
enum TSensrvPower
 

The TSensrvPower represents sensor power state.

Possible values:

  • ESensrvPowerPowerDown, sensor is currently powered down
  • ESensrvPowerPowerUp, sensor currently powered up
Enumerator:
ESensrvPowerPowerDown  Sensor is powered down.
ESensrvPowerPowerUp  Sensor is powered up.
enum TSensrvQuantity
 

The quantity of channel values.

Defines the quantity the channel is measuring. Licensee defined values must be between ESensrvQuantityLicenseeBase and ESensrvQuantityLicenseeEnd

See also:
TSensrvChannelInfo
Enumerator:
ESensrvQuantityNotUsed  Channel doesn't provide quantity information.
ESensrvQuantityNotdefined  Quantity is not defined.
ESensrvQuantityAcceleration  Channel measures acceleration.
ESensrvQuantityTapping  Channel measures tapping events.
ESensrvQuantityOrientation  Channel measures phone orientation.
ESensrvQuantityRotation  Channel measures phone rotation.
ESensrvQuantityMagnetic  Channel measures phone direction.
ESensrvQuantityAngle  Channel measures degrees.
ESensrvQuantityProximity  Channel measures phone proximity events.
ESensrvQuantityLicenseeBase  Start of licensee quantity range definitions.
ESensrvQuantityLicenseeEnd  End of licensee quantity range definitions.
enum TSetPropertySuccessIndicator
 

Indication of whether a call to CSensrvChannel::SetPropertyL() is likely to succeed.

See also:
CSensrvChannel

MSensrvPropertyListener

Enumerator:
ESetPropertyIndicationUnknown 
ESetPropertyIndicationAvailable  Setting of a property is certain to succeed because client has the highest priority of all clients that have open channels on that sensor device.
ESetPropertyIndicationPossible  Setting of a property may not succeed because: 1.

Client has the highest priority on its own channel however there are multiple clients with the same priority and control is granted on a first come first served basis. 2. Client has highest priority on its own channel however there are higher priority clients on other channels of the device that may be affected by the setting, in which case it will not be allowed. 3. Client has highest priority on its channel however there are same priority clients on other channels of the device that may be affected by the setting, in which case it will not be allowed

ESetPropertyIndicationUnavailable  Setting of a property will not succeed because: 1.

There are clients on the same channel with higher priority 2. A client of the same priority is already setting properties on channel.


Variable Documentation

const TSensrvChannelTypeId KSensrvChannelTypeIdUndefined = 0x00000000
 

Undefined Channel id for use when finding channels.

See also:
CSensrvChannelFinder
const TInt KSensrvItemIndexNone = -1
 

Item index for properties that are not data item specific.

See also:
TSensrvProperty
const TInt KSensrvLocationLength = 16
 

Max length of the location string.

See also:
TSensrvChannelInfo
const TInt KSensrvVendorIdLength = 16
 

Max length of the vendor Id.

See also:
TSensrvChannelInfo

Copyright © Nokia Corporation 2001-2007
Back to top