tracesrv/tracecore/btrace_handler/inc/TraceCoreActivation.h
author hgs
Fri, 08 Oct 2010 14:56:39 +0300
changeset 56 aa2539c91954
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
56
hgs
parents:
diff changeset
     1
// Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     2
// All rights reserved.
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
hgs
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     7
//
hgs
parents:
diff changeset
     8
// Initial Contributors:
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    10
//
hgs
parents:
diff changeset
    11
// Contributors:
hgs
parents:
diff changeset
    12
//
hgs
parents:
diff changeset
    13
// Description:
hgs
parents:
diff changeset
    14
// Interface to activation bitmap classes
hgs
parents:
diff changeset
    15
//
hgs
parents:
diff changeset
    16
hgs
parents:
diff changeset
    17
#ifndef __TRACECOREACTIVATION_H__
hgs
parents:
diff changeset
    18
#define __TRACECOREACTIVATION_H__
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
class MTraceCoreActivation;
hgs
parents:
diff changeset
    22
class DTraceCoreSettings;
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
/**
hgs
parents:
diff changeset
    26
 * Interface to get change notification from activation classes
hgs
parents:
diff changeset
    27
 */
hgs
parents:
diff changeset
    28
NONSHARABLE_CLASS( MTraceCoreActivationNotification )
hgs
parents:
diff changeset
    29
    {
hgs
parents:
diff changeset
    30
public:
hgs
parents:
diff changeset
    31
hgs
parents:
diff changeset
    32
    /**
hgs
parents:
diff changeset
    33
     * Notification that the activation state has changed
hgs
parents:
diff changeset
    34
     * 
hgs
parents:
diff changeset
    35
     * @param aActivation the activation interface that was updated
hgs
parents:
diff changeset
    36
     * @param aFromSettings ETrue if activation was due to settings read, EFalse if from some other source
hgs
parents:
diff changeset
    37
     * @param aComponentId Component ID of the activation
hgs
parents:
diff changeset
    38
     */
hgs
parents:
diff changeset
    39
    virtual void ActivationChanged( MTraceCoreActivation& aActivation, TBool aFromSettings,
hgs
parents:
diff changeset
    40
            TUint32 aComponentId ) = 0;
hgs
parents:
diff changeset
    41
    };
hgs
parents:
diff changeset
    42
hgs
parents:
diff changeset
    43
hgs
parents:
diff changeset
    44
/**
hgs
parents:
diff changeset
    45
 * Interface to activation classes
hgs
parents:
diff changeset
    46
 */
hgs
parents:
diff changeset
    47
NONSHARABLE_CLASS( MTraceCoreActivation )
hgs
parents:
diff changeset
    48
    {
hgs
parents:
diff changeset
    49
public:
hgs
parents:
diff changeset
    50
hgs
parents:
diff changeset
    51
    /**
hgs
parents:
diff changeset
    52
     * Checks if this bitmap supports the given component ID
hgs
parents:
diff changeset
    53
     */
hgs
parents:
diff changeset
    54
    virtual TBool IsComponentSupported( TUint32 aComponentID ) = 0;
hgs
parents:
diff changeset
    55
    
hgs
parents:
diff changeset
    56
    /**
hgs
parents:
diff changeset
    57
     * Gets activated groups for this component ID
hgs
parents:
diff changeset
    58
     * @param aComponentId the component ID
hgs
parents:
diff changeset
    59
     */
hgs
parents:
diff changeset
    60
    virtual RArray<TUint> GetActivatedGroups( const TUint32 aComponentId ) = 0;
hgs
parents:
diff changeset
    61
    
hgs
parents:
diff changeset
    62
    /**
hgs
parents:
diff changeset
    63
     * Updates this activation object from the given settings
hgs
parents:
diff changeset
    64
     * 
hgs
parents:
diff changeset
    65
     * @param aSettings the settings to be read
hgs
parents:
diff changeset
    66
     */
hgs
parents:
diff changeset
    67
    virtual void ReadFromSettings( DTraceCoreSettings& aSettings ) = 0;
hgs
parents:
diff changeset
    68
    
hgs
parents:
diff changeset
    69
    /**
hgs
parents:
diff changeset
    70
     * Updates the settings with the content of this activation object
hgs
parents:
diff changeset
    71
     * 
hgs
parents:
diff changeset
    72
     * @param aSettings the settings to be written
hgs
parents:
diff changeset
    73
     */
hgs
parents:
diff changeset
    74
    virtual void WriteToSettings( DTraceCoreSettings& aSettings ) = 0;
hgs
parents:
diff changeset
    75
    
hgs
parents:
diff changeset
    76
    /**
hgs
parents:
diff changeset
    77
     * Registers an activation notification interface
hgs
parents:
diff changeset
    78
     */
hgs
parents:
diff changeset
    79
    virtual TInt RegisterActivationNotification( MTraceCoreActivationNotification& aNotification ) = 0;
hgs
parents:
diff changeset
    80
    
hgs
parents:
diff changeset
    81
     /**
hgs
parents:
diff changeset
    82
     * Activate trace group.
hgs
parents:
diff changeset
    83
     * Method can be called only from Symbian OS thread context. 
hgs
parents:
diff changeset
    84
     * Activation of groupID/ComponentID from IRQs, IDFCs is not allowed.
hgs
parents:
diff changeset
    85
     *
hgs
parents:
diff changeset
    86
     * @param aComponentId The component ID
hgs
parents:
diff changeset
    87
     * @param aGroupId The group ID
hgs
parents:
diff changeset
    88
     */
hgs
parents:
diff changeset
    89
    virtual void ActivateTrace( const TUint32 aComponentId, const TUint32 aGroupId ) = 0;
hgs
parents:
diff changeset
    90
    
hgs
parents:
diff changeset
    91
    /**
hgs
parents:
diff changeset
    92
     * Deactivate trace group
hgs
parents:
diff changeset
    93
     *
hgs
parents:
diff changeset
    94
     * Method can be called only from Symbian OS thread context.
hgs
parents:
diff changeset
    95
     * Activation of groupID/ComponentID from IRQs, IDFCs is not allowed.
hgs
parents:
diff changeset
    96
     * 
hgs
parents:
diff changeset
    97
     * @param aComponentId The component ID
hgs
parents:
diff changeset
    98
     * @param aGroupId The group ID
hgs
parents:
diff changeset
    99
     */
hgs
parents:
diff changeset
   100
    virtual void DeactivateTrace( const TUint32 aComponentId, const TUint32 aGroupId ) = 0;
hgs
parents:
diff changeset
   101
hgs
parents:
diff changeset
   102
    /**
hgs
parents:
diff changeset
   103
     * Deactivates all groups from a component
hgs
parents:
diff changeset
   104
     * 
hgs
parents:
diff changeset
   105
     * @param aComponentId The component ID
hgs
parents:
diff changeset
   106
     */
hgs
parents:
diff changeset
   107
    virtual void DeactivateAll( const TUint32 aComponentId ) = 0;
hgs
parents:
diff changeset
   108
hgs
parents:
diff changeset
   109
    /**
hgs
parents:
diff changeset
   110
     * Reactivate all currently activated traces
hgs
parents:
diff changeset
   111
     * 
hgs
parents:
diff changeset
   112
     * @return KErrNone if refresh successful
hgs
parents:
diff changeset
   113
     */
hgs
parents:
diff changeset
   114
    virtual TInt RefreshActivations() { return KErrNotFound; };
hgs
parents:
diff changeset
   115
    };
hgs
parents:
diff changeset
   116
hgs
parents:
diff changeset
   117
    
hgs
parents:
diff changeset
   118
#endif // __TRACECOREACTIVATION_H__