sl@0: /**
sl@0: * Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: * All rights reserved.
sl@0: * This component and the accompanying materials are made available
sl@0: * under the terms of the License "Eclipse Public License v1.0"
sl@0: * which accompanies this distribution, and is available
sl@0: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: *
sl@0: * Initial Contributors:
sl@0: * Nokia Corporation - initial contribution.
sl@0: *
sl@0: * Contributors:
sl@0: *
sl@0: * Description:
sl@0: * Trace API
sl@0: * ---------------TTraceContext-----------------------
sl@0: *
sl@0: */
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0:  @file
sl@0:  @publishedPartner
sl@0:  @prototype
sl@0:  
sl@0:  Define the context of a trace packet by setting its attributes.
sl@0:  
sl@0:  The module UID is defaulted according to the FW_DEFAULT_MODULEUID definition.
sl@0:  The HasThreadIdentification is defaulted to the FW_DEFAULT_HAS_THREAD_IDENTIFICATION definition.
sl@0:  The HasProgramCounter is defaulted to the FW_DEFAULT_HAS_PC definition.
sl@0:  
sl@0:  @param aClassification 	@see TClassification
sl@0:  
sl@0: */
sl@0: TTraceContext::TTraceContext(const TClassification aClassification)
sl@0: :iModuleUid(FW_DEFAULT_MODULEUID), iClassification(aClassification), iHasThreadIdentification(FW_DEFAULT_HAS_THREAD_IDENTIFICATION), iHasProgramCounter(FW_DEFAULT_HAS_PC), iReserved1(0), iReserved2(0)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  * Define the context of a trace packet by setting its attributes.
sl@0:  *
sl@0:  * The HasThreadIdentification is defaulted to the FW_DEFAULT_HAS_THREAD_IDENTIFICATION definition.
sl@0:  * The HasProgramCounter is defaulted to the FW_DEFAULT_HAS_PC definition.
sl@0:  * 
sl@0:  * @param aModuleUid		@see TModuleUid
sl@0:  * @param aClassification	@see TClassification
sl@0:  */
sl@0: TTraceContext::TTraceContext(const TModuleUid aModuleUid, const TClassification aClassification)
sl@0: :iModuleUid(aModuleUid), iClassification(aClassification), iHasThreadIdentification(FW_DEFAULT_HAS_THREAD_IDENTIFICATION), iHasProgramCounter(FW_DEFAULT_HAS_PC), iReserved1(0), iReserved2(0)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  * Define the context of a trace packet by setting its attributes.
sl@0:  * 
sl@0:  * The module UID is defaulted according to the FW_DEFAULT_MODULEUID definition.
sl@0:  * 
sl@0:  * @param aClassification 	@see TClassification
sl@0:  * @param aHasThreadIdentification	Set whether to add thread identification automatically in the trace packet.
sl@0:  * @param aHasProgramCounter			Set whether to add PC (program counter) automatically in the trace packet.
sl@0:  */
sl@0: TTraceContext::TTraceContext(const TClassification aClassification, const THasThreadIdentification aHasThreadIdentification, const THasProgramCounter aHasProgramCounter)
sl@0: :iModuleUid(FW_DEFAULT_MODULEUID), iClassification(aClassification), iHasThreadIdentification(aHasThreadIdentification), iHasProgramCounter(aHasProgramCounter), iReserved1(0), iReserved2(0)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /**
sl@0:  * Define the context of a trace packet by setting its attributes.
sl@0:  *
sl@0:  * @param aModuleUid 		@see TModuleUid
sl@0:  * @param aClassification 	@see TClassification
sl@0:  * @param aHasThreadIdentification	Set whether to add thread identification automatically in the trace packet.
sl@0:  * @param aHasProgramCounter		Set whether to add PC (program counter) automatically in the trace packet.
sl@0:  */
sl@0: TTraceContext::TTraceContext(const TModuleUid aModuleUid, const TClassification aClassification, const THasThreadIdentification aHasThreadIdentification, const THasProgramCounter aHasProgramCounter)
sl@0: :iModuleUid(aModuleUid), iClassification(aClassification), iHasThreadIdentification(aHasThreadIdentification), iHasProgramCounter(aHasProgramCounter), iReserved1(0), iReserved2(0)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: //------------------ Trace -----------------------
sl@0: /**
sl@0: Outputs a trace packet containing variable length data.
sl@0: 
sl@0: If the specified data is too big to fit into a single
sl@0: trace record a multipart trace is generated.
sl@0: 
sl@0: @param aContext 	Attributes of the trace point. 
sl@0: @param aFormatId	A format identifier as specified by @see TFormatId
sl@0: @param aData		Additional data to add to trace packet.
sl@0: 					Must be word aligned, i.e. a multiple of 4.
sl@0: 
sl@0: @return 			The trace packet was/was not logged.
sl@0: 
sl@0: @See BTrace::TMultipart
sl@0: */
sl@0: template<typename T>
sl@0: TBool Trace(const TTraceContext& aContext, TFormatId aFormatId, const T& aData)
sl@0: 	{
sl@0: 	return Trace(aContext, aFormatId, &aData, sizeof(aData));
sl@0: 	}
sl@0: