CSensrvChannelCondition Class Reference

#include <sensrvchannelcondition.h>

class CSensrvChannelCondition : public CBase

Inherits from

  • CSensrvChannelCondition

    Detailed Description

    CSensrvChannelCondition represents a channel condition item. Channel conditions are added to a channel condition set. A channel condition set is met when all channel conditions are met at the same time, if it is AND-type set, or when single condition is met if it is OR-type set. Only one channel condition can be set for each data item in single channel condition set. Certain condition types (range conditions) require two condition objects (upper and lower limit) in a condition set for the set to be valid. The pair of conditions must both have the same index in the condition set and they are considered a single channel condition.

    Each Condition has an ItemIndex associated with it. When a Condition is added to a Condition Set using CSensrvChannelConditionSet::AddChannelConditionL() this index must be different to all other conditions added to the set with the exception of range conditions as described above. If the index supplied already exists and the condition is not part of a range condition then CSensrvChannelConditionSet::AddChannelConditionL() leaves with KErrArgument.

    See also: CSensrvChannelConditionSet TSensrvConditionType TSensrvConditionOperator

    library
    sensrvutil.lib
    Since
    S60 5.0

    Constructor & Destructor Documentation

    CSensrvChannelCondition ( )

    CSensrvChannelCondition()

    Default constructor.

    Member Function Documentation

    ConditionItemIndex ( )

    TInt ConditionItemIndex()const [pure virtual]

    Get condition item index

    Returns: TInt Condition item index

    ConditionOperator ( )

    TInt ConditionOperator()const [pure virtual]

    Get condition operator

    Returns: TInt Condition operator

    ConditionType ( )

    TInt ConditionType()const [pure virtual]

    Get condition type

    Returns: Condition Type

    ConditionValue ( )

    const TDesC8 &ConditionValue()const [pure virtual]

    Get condition value as reference.

    Returns: Reference to condition value descriptor.

    GetConditionValue ( TDes8 & )

    TInt GetConditionValue(TDes8 &aValue)const [pure virtual]

    Get condition value.

    ParameterDescription
    aValueValue of the condition is copied to the supplied descriptor

    Returns: KErrOverflow if aData is the wrong size for data item or one of the system-wide error codes

    NewL ( TInt, TInt, TInt, TDesC8 & )

    IMPORT_C CSensrvChannelCondition *NewL(TIntaConditionType,
    TIntaConditionOperator,
    TIntaItemIndex,
    TDesC8 &aValue
    )[static]

    Two-phase constructor

    leave
    KErrNoMemory
    leave
    KErrArgument if parameters are invalid or are less than 0
    leave
    One of the system-wide error codes
    ParameterDescription
    aConditionTypeDefines the type of the condition
    aConditionOperatorDefines the operator used in the condition
    aItemIndexItem index to be used in the condition evaluation
    aValueValue to be used in condition evaluation. By default this should be a packaged data object of the channel. See the channel specific headers in . If the channel type requires a different type of value, that must be indicated clearly in the channel specific header defining the channel.

    Returns: Pointer to created object

    NewLC ( TInt, TInt, TInt, TDesC8 & )

    IMPORT_C CSensrvChannelCondition *NewLC(TIntaConditionType,
    TIntaConditionOperator,
    TIntaItemIndex,
    TDesC8 &aValue
    )[static]

    Two-phase constructor

    leave
    KErrNoMemory
    leave
    KErrArgument if parameters are invalid or are less than 0
    leave
    One of the system-wide error codes
    ParameterDescription
    aConditionTypeDefines the type of the condition
    aConditionOperatorDefines the operator used in the condition
    aItemIndexItem index to be used in the condition evaluation
    aValueValue to be used in condition evaluation. By default this should be a packaged data object of the channel. See the channel specific headers in . If the channel type requires a different type of value, that must be indicated clearly in the channel specific header defining the channel.

    Returns: Pointer to created object