Instrument.h

Go to the documentation of this file.

/*
    This is part of CFugue, a C++ Runtime for MIDI Score Programming
    Copyright (C) 2009 Gopalakrishna Palem

    For links to further information, or to contact the author,
    see <http://cfugue.sourceforge.net/>.
    
    $LastChangedDate: 2013-12-18 10:59:57 +0530 (Wed, 18 Dec 2013) $
    $Rev: 197 $
    $LastChangedBy: krishnapg $
*/

#ifndef __MUSICINSTRUMENT_H__0823ABB9_BB3E_46a6_84DE_BBA9F4E7F821__
#define __MUSICINSTRUMENT_H__0823ABB9_BB3E_46a6_84DE_BBA9F4E7F821__

/** @file Instrument.h 
 * \brief Declares Instrument class
 */ 
#include "Dictionary.h"

namespace CFugue
{
    /**
     * Represents MIDI instrument objects. Useful for instrument changes,
     * also known as <i>patch changes</i>.
     */
    class Instrument
    {
        unsigned char m_nInstrumentID; //MIDI instrument ID in range [0, 127]
    public:
        inline Instrument(const unsigned char nInstrumentID) 
            : m_nInstrumentID(nInstrumentID) 
        { }
        
        ///<Summary>Returns the MIDI Instrument ID this object represents</Summary>      
        inline unsigned char GetInstrumentID() const { return m_nInstrumentID; }

        /// <Summary>Returns the name of the music instrument this object represents</Summary>
        MString GetInstrumentName() const;

        /// Populates the standard musical instrument Macro defintions into Music String Dictionary
        static void PopulateStandardDefinitions(DICTIONARY& stdDefns);
    };

} // namespace CFugue

#endif // __MUSICINSTRUMENT_H__0823ABB9_BB3E_46a6_84DE_BBA9F4E7F821__