--- a/example/clientapi/smf/inc/common/smfmusic/smfmusicfingerprint.h Thu Mar 25 14:44:08 2010 +0530
+++ b/example/clientapi/smf/inc/common/smfmusic/smfmusicfingerprint.h Tue Apr 06 16:35:37 2010 +0530
@@ -1,31 +1,36 @@
/**
- * @file smfmusicfingerprint.h
- * @author Nalina Hariharan, Sasken Communication Technologies Ltd - Initial contribution
- * @version 1.0
- *
- * @section LICENSE
- *
- * Copyright (c) 2010 Sasken Communication Technologies Ltd.
+ * Copyright (c) 2010 Sasken Communication Technologies Ltd.
* All rights reserved.
- * This component and the accompanying materials are made available
- * under the terms of the "{License}"
- * which accompanies this distribution, and is available
- * at the URL "{LicenseUrl}".
+ * This component and the accompanying materials are made available
+ * under the terms of the "Eclipse Public License v1.0"
+ * which accompanies this distribution, and is available
+ * at the URL "http://www.eclipse.org/legal/epl-v10.html"
+ *
+ * Initial Contributors:
+ * Chandradeep Gandhi, Sasken Communication Technologies Ltd - Initial contribution
+ *
+ * Contributors:
+ * Manasij Roy, Nalina Hariharan
*
- * @section DESCRIPTION
+ * Description:
+ * The SmfMusicFingerPrint class represents a music finger print used in searches
*
- * The musicfingerprint class represents a music finger print used in searches
*/
#ifndef SMFMUSICFINGERPRINT_H_
#define SMFMUSICFINGERPRINT_H_
-#include <QObject>
+#include <qdatastream.h>
+#include <QSharedData>
+#include <smfclientglobal.h>
+
+class SmfMusicFingerPrintPrivate;
/**
+ * @ingroup smf_common_group
* The musicfingerprint class represents a music finger print used in searches
*/
-class SmfMusicFingerPrint : public QObject
+class SMFCLIENT_EXPORT SmfMusicFingerPrint : public QObject
{
Q_OBJECT
public:
@@ -39,13 +44,42 @@
*/
~SmfMusicFingerPrint( );
+ /**
+ * GEt the music finger print data
+ * @return The music finger print data
+ */
+ QByteArray musicFingerPrint ( ) const;
+
+private:
+ QSharedDataPointer<SmfMusicFingerPrintPrivate> d;
+
+ friend QDataStream &operator<<( QDataStream &aDataStream,
+ const SmfMusicFingerPrint &aMFP );
+
+ friend QDataStream &operator>>( QDataStream &aDataStream,
+ SmfMusicFingerPrint &aMFP );
+
};
+
+
/**
-* Externalization
-*/
-friend QDataStream &operator<<(QDataStream &, const SmfMusicFingerPrint&);
+ * Method for Externalization. Writes the SmfMusicFingerPrint object to
+ * the stream and returns a reference to the stream.
+ * @param aDataStream Stream to be written
+ * @param aMFP The SmfMusicFingerPrint object to be externalized
+ * @return reference to the written stream
+ */
+QDataStream &operator<<( QDataStream &aDataStream,
+ const SmfMusicFingerPrint &aMFP );
+
/**
- * Internalization
+ * Method for Internalization. Reads a SmfMusicFingerPrint object from
+ * the stream and returns a reference to the stream.
+ * @param aDataStream Stream to be read
+ * @param aMFP The SmfMusicFingerPrint object to be internalized
+ * @return reference to the stream
*/
-friend QDataStream &operator>>(QDataStream &, SmfMusicFingerPrint&);
+QDataStream &operator>>( QDataStream &aDataStream,
+ SmfMusicFingerPrint &aMFP);
+
#endif /* SMFMUSICFINGERPRINT_H_ */