NoteAssignmentsMap.h

Go to the documentation of this file.

#ifndef NoteAssignmentsMap_h
#define NoteAssignmentsMap_h

#include "MusicData.h"

namespace choir {

class NoteAssignmentsMap : public MusicDatabaseObject
{
public:
   NoteAssignmentsMap();

   ~NoteAssignmentsMap();

   virtual void SetToDefaultState();

   virtual status_t SetFromArchive(const ConstMessageRef & archive);

   virtual status_t SaveToArchive(const MessageRef & archive) const;

   const Hashtable<ZGPeerID, uint64> & GetNoteAssignments() const {return _noteAssignments;}

   uint64 GetNoteAssignmentsForPeerID(const ZGPeerID & peerID) const {return _noteAssignments[peerID];}

   status_t SetNoteAssignmentsForPeerID(const ZGPeerID & peerID, uint64 newNotes);

   void UnassignNote(uint32 noteIdx);

   uint64 GetAllAssignedNotesChord() const {return _assignedNotes;}

   void SetAssignmentStrategy(uint32 strategy);

   uint32 GetAssignmentStrategy() const {return _assignmentStrategy;}

   virtual uint32 GetCurrentChecksum() const {return _checksum;}

   virtual uint32 CalculateChecksum() const;

   virtual ConstMessageRef SeniorUpdate(const ConstMessageRef & seniorDoMsg);

   virtual status_t JuniorUpdate(const ConstMessageRef & juniorDoMsg);

   status_t HandleToggleAssignmentMessage(const Message & msg);

   void PrintToStream() const;

   virtual String ToString() const;

   const Hashtable<uint8, uint32> & GetNoteHistogram() const {return _noteHistogram;}

private:
   uint32 CalculateChecksumForPeer(const ZGPeerID & peerID, uint64 chordValue) const {return peerID.CalculateChecksum()+CalculateChecksumForUint64(chordValue);}
   const ZGPeerID & GetLightestPeer(const Hashtable<ZGPeerID, ConstMessageRef> & onlinePeers, uint32 & retCount) const;
   const ZGPeerID & GetHeaviestPeer(const Hashtable<ZGPeerID, ConstMessageRef> & onlinePeers, uint32 & retCount) const;
   void SetToDefaultStateAux();
   void VerifyRunningChecksum(const char * desc) const; // just for debugging purposes
   status_t SeniorAutoUpdateAssignments(uint64 allNotesChord, bool & retChangedAnything);

   // checksummed data
   Hashtable<ZGPeerID, uint64> _noteAssignments;
   uint32 _assignmentStrategy;               // one of the ASSIGNMENT_STRATEGY_* values

   // metadata
   Hashtable<uint8, uint32> _noteHistogram;  // how many times each note is assigned to a peer
   uint64 _assignedNotes;                    // bit-chord of currently assigned notes (computed from the histogram)
   uint32 _checksum;                         // running checksum (so we don't have to recalculate it from scratch each time)
};
DECLARE_REFTYPES(NoteAssignmentsMap);

}; // end namespace choir

#endif