kome::objects::MsDataVariant Class Reference

class that treats MS data of various types More...

#include <MsDataVariant.h>

Collaboration diagram for kome::objects::MsDataVariant:

Public Member Functions
	MsDataVariant ()
	constructor
	MsDataVariant (Variant &var)
	constructor More...
virtual	~MsDataVariant ()
	destructor
void	setVariant (Variant &var)
	sets variant object More...
Variant &	getVariant ()
	gets variant object More...
void	unsetObject ()
	unsets object
void	setSpectrum (Spectrum *spec)
	sets spectrum More...
void	setChromatogram (Chromatogram *chrom)
	sets chromatogram More...
void	setDataMap (DataMapInfo *dataMap)
	sets data map More...
void	setGroup (DataGroupNode *group)
	sets group More...
void	setSample (Sample *sample)
	sets sample More...
void	setSampleSet (SampleSet *sampleSet)
	sets sample set More...
Spectrum *	getSpectrum ()
	gets spectrum More...
Chromatogram *	getChromatogram ()
	gets chromatogram More...
DataMapInfo *	getDataMap ()
	gets data map More...
DataGroupNode *	getGroup ()
	gets group More...
Sample *	getSample ()
	gets sample More...
SampleSet *	getSampleSet ()
	gets sample set More...

Protected Attributes
Variant	m_var

Detailed Description

class that treats MS data of various types

Definition at line 33 of file MsDataVariant.h.

Constructor & Destructor Documentation

kome::objects::MsDataVariant::MsDataVariant

(

Variant &

var

)

constructor

Parameters

[in]

var

variant object

Definition at line 39 of file MsDataVariant.cpp.

                                           : m_var( var ) {
}

Member Function Documentation

Chromatogram * kome::objects::MsDataVariant::getChromatogram

(

)

gets chromatogram

Returns

chromatogram

Definition at line 133 of file MsDataVariant.cpp.

                                             {
    Chromatogram* chrom = NULL;
    if( m_var.type == Variant::CHROMATOGRAM ) {
        chrom = (Chromatogram*)m_var.prim.pt;
    }

    return chrom;
}

DataMapInfo * kome::objects::MsDataVariant::getDataMap

(

)

gets data map

Returns

data map

Definition at line 143 of file MsDataVariant.cpp.

                                       {
    DataMapInfo* dm = NULL;
    if( m_var.type == Variant::DATA_MAP ) {
        dm = (DataMapInfo*)m_var.prim.pt;
    }

    return dm;
}

DataGroupNode * kome::objects::MsDataVariant::getGroup

(

)

gets group

Returns

group

Definition at line 153 of file MsDataVariant.cpp.

                                       {
    DataGroupNode* group = NULL;

    if( m_var.type == Variant::DATA_GROUP_NODE ) {  // group
        group = (DataGroupNode*)m_var.prim.pt;
    }
    else {   // etc
        Spectrum* spec = getSpectrum();
        Chromatogram* chrom = getChromatogram();
        DataMapInfo* dm = getDataMap();

        if( spec != NULL ) {
            group = spec->getGroup();
        }
        else if( chrom != NULL ) {
            group = chrom->getGroup();
        }
        else if( dm != NULL ) {
            group = &( dm->getGroup() );
        }
    }

    return group;
}

Here is the call graph for this function:

Sample * kome::objects::MsDataVariant::getSample

(

)

gets sample

Returns

sample

Definition at line 179 of file MsDataVariant.cpp.

                                 {
    Sample* sample = NULL;

    if( m_var.type == Variant::SAMPLE ) {   // sample
        sample = (Sample*)m_var.prim.pt;
    }
    else {  // get sample from group
        DataGroupNode* group = getGroup();
        if( group != NULL ) {
            sample = group->getSample();
        }
    }

    return sample;
}

Here is the call graph for this function:

SampleSet * kome::objects::MsDataVariant::getSampleSet

(

)

gets sample set

Returns

sample set

Definition at line 196 of file MsDataVariant.cpp.

                                       {
    SampleSet* sampleSet = NULL;

    if( m_var.type == Variant::SAMPLE_SET ) {   // sample set
        sampleSet = (SampleSet*)m_var.prim.pt;
    }
    else {  // get sample set from sample
        Sample* sample = getSample();
        if( sample != NULL ) {
            sampleSet = sample->getSampleSet();
        }
    }

    return sampleSet;
}

Here is the call graph for this function:

Spectrum * kome::objects::MsDataVariant::getSpectrum

(

)

gets spectrum

Returns

spectrum

Definition at line 123 of file MsDataVariant.cpp.

                                     {
    Spectrum* spec = NULL;
    if( m_var.type == Variant::SPECTRUM ) {
        spec = (Spectrum*)m_var.prim.pt;
    }

    return spec;
}

Variant & kome::objects::MsDataVariant::getVariant

(

)

gets variant object

Returns

variant object

Definition at line 52 of file MsDataVariant.cpp.

                                   {
    return m_var;
}

void kome::objects::MsDataVariant::setChromatogram

(

Chromatogram *

chrom

)

sets chromatogram

Parameters

[in]

chrom

chromatogram

Definition at line 73 of file MsDataVariant.cpp.

                                                         {
    if( chrom == NULL ) {
        unsetObject();
    }

    m_var.type = Variant::CHROMATOGRAM;
    m_var.prim.pt = chrom;
}

Here is the call graph for this function:

void kome::objects::MsDataVariant::setDataMap

(

DataMapInfo *

dataMap

)

sets data map

Parameters

[in]

dataMap

data map

Definition at line 83 of file MsDataVariant.cpp.

                                                     {
    if( dataMap == NULL ) {
        unsetObject();
    }

    m_var.type = Variant::DATA_MAP;
    m_var.prim.pt = dataMap;
}

Here is the call graph for this function:

void kome::objects::MsDataVariant::setGroup

(

DataGroupNode *

group

)

sets group

Parameters

[in]

group

group

Definition at line 93 of file MsDataVariant.cpp.

                                                   {
    if( group == NULL ) {
        unsetObject();
    }

    m_var.type = Variant::DATA_GROUP_NODE;
    m_var.prim.pt = group;
}

Here is the call graph for this function:

void kome::objects::MsDataVariant::setSample

(

Sample *

sample

)

sets sample

Parameters

[in]

sample

sample

Definition at line 103 of file MsDataVariant.cpp.

                                              {
    if( sample == NULL ) {
        unsetObject();
    }

    m_var.type = Variant::SAMPLE;
    m_var.prim.pt = sample;
}

Here is the call graph for this function:

void kome::objects::MsDataVariant::setSampleSet

(

SampleSet *

sampleSet

)

sets sample set

Parameters

[in]

sampleSet

sample set

Definition at line 113 of file MsDataVariant.cpp.

                                                       {
    if( sampleSet == NULL ) {
        unsetObject();
    }

    m_var.type = Variant::SAMPLE_SET;
    m_var.prim.pt = sampleSet;
}

Here is the call graph for this function:

void kome::objects::MsDataVariant::setSpectrum

(

Spectrum *

spec

)

sets spectrum

Parameters

[in]

spec

spectrum

Definition at line 63 of file MsDataVariant.cpp.

                                                {
    if( spec == NULL ) {
        unsetObject();
    }

    m_var.type = Variant::SPECTRUM;
    m_var.prim.pt = spec;
}

Here is the call graph for this function:

void kome::objects::MsDataVariant::setVariant

(

Variant &

var

)

sets variant object

Parameters

[in]

var

variant object

Definition at line 47 of file MsDataVariant.cpp.

                                             {
    m_var = var;
}

Member Data Documentation

Variant kome::objects::MsDataVariant::m_var

protected

variant

Definition at line 56 of file MsDataVariant.h.

---

The documentation for this class was generated from the following files:

• DataObjects/MsDataVariant.h
• DataObjects/MsDataVariant.cpp