Chromatogram.h

Go to the documentation of this file.

#ifndef __KOME_OBJECTS_CHROMATOGRAM_H__
#define __KOME_OBJECTS_CHROMATOGRAM_H__


#include "DataObjectsCommon.h"

#include <vector>


namespace kome {
    namespace objects {

        class Sample;
        class DataGroupNode;
        class Spectrum;
        class DataSet;

        class DATA_OBJECTS_CLASS Chromatogram {
        public:
            Chromatogram( Sample* sample );

            virtual ~Chromatogram();

        protected:
            Sample* m_sample;

            DataGroupNode* m_group;

            std::string m_name;

            double m_mz;

            std::string m_icon;

            std::string m_title;

            kome::core::Properties m_props;

            kome::core::Properties m_userProps;

            bool m_autoCreated;

            bool m_visible;

            Chromatogram* m_orgChrom;
            
            bool m_op;

            int m_chromId;

            double m_q1;

            double m_q3;

        protected:
            static std::vector< std::string > m_commonProps;
                
        public:
            void setOperationFlag( const bool op ){ m_op = op; }

            bool getOperationFlag(){ return m_op; }
        public:
            void setId( int id );
            
            int getId();
        public:
            Sample* getSample();

            void setName( const char* name );

            const char* getName();

            void setMz( const double mz );

            double getMz();

            void setGroup( DataGroupNode* group );

            DataGroupNode* getGroup();

            void setIcon( const char* icon );

            const char* getIcon();

            void setTitle( const char* title );

            const char* getTitle();

            kome::core::Properties& getProperties();

            kome::core::Properties& getUserProperties();

            void setAutoCreated( const bool autoCreated = true );

            bool isAutoCreated();

            void setVisible( const bool visible );

             bool isVisible();

            void setOrgChromatogram( Chromatogram* chrom );

            Chromatogram* getOrgChromatogram();

        public:
            void setQ1( const double q1 );

            double getQ1();

            void setQ3( const double q3 );

            double getQ3();

        public:         
            kome::core::XYData* getXYData();

            void deleteXYData();

            void getXYData( kome::core::XYData* const xyData, const bool op );

        public:
            Spectrum* searchSpectrum( const double rt, const SearchType search = SEARCH_NEAR );

            void getSpectra(
                    DataSet& dataSet,
                    const double startRt,
                    const double endRt,
                    const SearchType startSearch = SEARCH_NEAR,
                    const SearchType endSearch = SEARCH_NEAR
            );

            double getMass( const unsigned int index );

            int getMsStage( const unsigned int index );

            double getPrecursor( const unsigned int index );

        public:
            void getProperties( kome::core::Properties& properties );

            void getUserProperties( kome::core::Properties& userProperties );

        public:
            static bool isCommonProperty( const char* key );

        protected:
            virtual void onGetXYData( kome::core::XYData* const xyData ) = 0;

            virtual void onGetSpectra(
                DataSet& dataSet,
                const double startRt,
                const double endRt,
                const SearchType startSearch,
                const SearchType endSearch
            ) = 0;

            virtual double onGetMass( const unsigned int index ) = 0;
            
            virtual int onGetMsStage( const unsigned int index ) = 0;

            virtual double onGetPrecursor( const unsigned int index ) = 0;
        };
    }
}

#endif  // __KOME_OBJECTS_CHROMATOGRAM_H__