example/clientapi/smf/inc/common/smfmusic/smfmusicfingerprint.h
changeset 2 86af6c333601
parent 1 4b1e636e8a71
equal deleted inserted replaced
1:4b1e636e8a71 2:86af6c333601
     1 /**
     1 /**
     2  * @file	smfmusicfingerprint.h
     2  * Copyright (c) 2010 Sasken Communication Technologies Ltd.
     3  * @author  Nalina Hariharan, Sasken Communication Technologies Ltd - Initial contribution
     3  * All rights reserved.
     4  * @version 1.0
     4  * This component and the accompanying materials are made available
       
     5  * under the terms of the "Eclipse Public License v1.0" 
       
     6  * which accompanies  this distribution, and is available
       
     7  * at the URL "http://www.eclipse.org/legal/epl-v10.html"
     5  *
     8  *
     6  * @section LICENSE
     9  * Initial Contributors:
       
    10  * Chandradeep Gandhi, Sasken Communication Technologies Ltd - Initial contribution
     7  *
    11  *
     8  * Copyright (c) 2010 Sasken Communication Technologies Ltd. 
    12  * Contributors:
     9  * All rights reserved.
    13  * Manasij Roy, Nalina Hariharan
    10  * This component and the accompanying materials are made available 
       
    11  * under the terms of the "{License}" 
       
    12  * which accompanies  this distribution, and is available 
       
    13  * at the URL "{LicenseUrl}".
       
    14  * 
    14  * 
    15  * @section DESCRIPTION
    15  * Description:
       
    16  * The SmfMusicFingerPrint class represents a music finger print used in searches
    16  *
    17  *
    17  * The musicfingerprint class represents a music finger print used in searches
       
    18  */
    18  */
    19 
    19 
    20 #ifndef SMFMUSICFINGERPRINT_H_
    20 #ifndef SMFMUSICFINGERPRINT_H_
    21 #define SMFMUSICFINGERPRINT_H_
    21 #define SMFMUSICFINGERPRINT_H_
    22 
    22 
    23 #include <QObject>
    23 #include <qdatastream.h>
       
    24 #include <QSharedData>
       
    25 #include <smfclientglobal.h>
       
    26 
       
    27 class SmfMusicFingerPrintPrivate;
    24 
    28 
    25 /**
    29 /**
       
    30  * @ingroup smf_common_group
    26  * The musicfingerprint class represents a music finger print used in searches
    31  * The musicfingerprint class represents a music finger print used in searches
    27  */
    32  */
    28 class SmfMusicFingerPrint : public QObject
    33 class SMFCLIENT_EXPORT SmfMusicFingerPrint : public QObject
    29 	{
    34 	{
    30 	Q_OBJECT
    35 	Q_OBJECT
    31 public:
    36 public:
    32 	/**
    37 	/**
    33 	 * Constructor with default argument
    38 	 * Constructor with default argument
    37 	/**
    42 	/**
    38 	 * Destructor
    43 	 * Destructor
    39 	 */
    44 	 */
    40 	~SmfMusicFingerPrint( );
    45 	~SmfMusicFingerPrint( );
    41 	
    46 	
       
    47 	/**
       
    48 	 * GEt the music finger print data
       
    49 	 * @return The music finger print data
       
    50 	 */
       
    51 	QByteArray musicFingerPrint ( ) const;
       
    52 	
       
    53 private:
       
    54 	QSharedDataPointer<SmfMusicFingerPrintPrivate> d;
       
    55 	
       
    56 	friend QDataStream &operator<<( QDataStream &aDataStream, 
       
    57 			const SmfMusicFingerPrint &aMFP );
       
    58 
       
    59 	friend QDataStream &operator>>( QDataStream &aDataStream, 
       
    60 			SmfMusicFingerPrint &aMFP );
       
    61 	
    42 	};
    62 	};
       
    63 
       
    64 
    43 /**
    65 /**
    44 * Externalization
    66  * Method for Externalization. Writes the SmfMusicFingerPrint object to 
    45 */
    67  * the stream and returns a reference to the stream.
    46 friend QDataStream &operator<<(QDataStream &, const SmfMusicFingerPrint&);
    68  * @param aDataStream Stream to be written
       
    69  * @param aMFP The SmfMusicFingerPrint object to be externalized
       
    70  * @return reference to the written stream
       
    71  */
       
    72 QDataStream &operator<<( QDataStream &aDataStream, 
       
    73 		const SmfMusicFingerPrint &aMFP );
       
    74 
    47 /**
    75 /**
    48  * Internalization
    76  * Method for Internalization. Reads a SmfMusicFingerPrint object from 
       
    77  * the stream and returns a reference to the stream.
       
    78  * @param aDataStream Stream to be read
       
    79  * @param aMFP The SmfMusicFingerPrint object to be internalized
       
    80  * @return reference to the stream
    49  */
    81  */
    50 friend QDataStream &operator>>(QDataStream &, SmfMusicFingerPrint&);
    82 QDataStream &operator>>( QDataStream &aDataStream, 
       
    83 		SmfMusicFingerPrint &aMFP);
       
    84 
    51 #endif /* SMFMUSICFINGERPRINT_H_ */
    85 #endif /* SMFMUSICFINGERPRINT_H_ */