MDRow Class Reference

#include <metadata_row_base.h>

Inheritance diagram for MDRow:

Classes
class	iterator_ptr

Public Types
using	iterator = iterator_ptr< false >
using	const_iterator = iterator_ptr< true >

Public Member Functions
virtual void	detach ()
virtual bool	empty () const =0
virtual int	size () const =0
virtual void	clear ()=0
virtual MDRow &	operator= (const MDRow &)=0
virtual	~MDRow ()=default
virtual size_t	id () const
virtual bool	containsLabel (MDLabel label) const =0
virtual std::vector< MDLabel >	labels () const =0
virtual void	addLabel (MDLabel label)=0
virtual void	resetGeo (bool addLabels=true)
virtual MDObject *	getObject (MDLabel label)=0
virtual const MDObject *	getObject (MDLabel label) const =0
template<typename T >
T &	getValue (MDLabel label)
template<typename T >
const T &	getValue (MDLabel label) const
template<typename T >
bool	getValue (MDLabel label, T &d) const
bool	getValue (MDObject &object) const
template<typename T >
const T &	getValueOrDefault (MDLabel label, const T &def) const
template<typename T >
T &	getValueOrDefault (MDLabel label, const T &def)
template<typename T , typename T1 >
void	getValueOrDefault (MDLabel label, T &d, T1 def) const
template<typename T >
void	setValue (MDLabel label, const T &d, bool addLabel=true)
virtual void	setValue (const MDObject &object)=0
virtual void	setValueFromStr (MDLabel label, const String &value)
iterator	begin ()
iterator	end ()
const_iterator	begin () const
const_iterator	end () const

Friends
std::ostream &	operator<< (std::ostream &out, const MDRow &row)

Detailed Description

Common API of all metadata rows (abstract class). Classes like MDRowVec & MDRowSql implement this API.

Definition at line 53 of file metadata_row_base.h.

Member Typedef Documentation

const_iterator

using MDRow::const_iterator = iterator_ptr<true>

Definition at line 191 of file metadata_row_base.h.

iterator

using MDRow::iterator = iterator_ptr<false>

Definition at line 190 of file metadata_row_base.h.

Constructor & Destructor Documentation

~MDRow()

virtual MDRow::~MDRow ( )

virtualdefault

Member Function Documentation

addLabel()

virtual void MDRow::addLabel ( MDLabel  label )

pure virtual

Implemented in MDRowVec, and MDRowSql.

begin() [1/2]

iterator MDRow::begin ( )

inline

Definition at line 193 of file metadata_row_base.h.

{ return iterator_ptr<false>(0, *this); }

begin() [2/2]

const_iterator MDRow::begin ( ) const

inline

Definition at line 196 of file metadata_row_base.h.

{ return iterator_ptr<true>(0, *this); }

clear()

virtual void MDRow::clear ( )

pure virtual

Return number of labels present

Implemented in MDRowVec, and MDRowSql.

containsLabel()

virtual bool MDRow::containsLabel ( MDLabel  label ) const

pure virtual

Implemented in MDRowVec, and MDRowSql.

detach()

virtual void MDRow::detach ( )

inlinevirtual

Reimplemented in MDRowVec.

Definition at line 58 of file metadata_row_base.h.

{}

empty()

virtual bool MDRow::empty ( ) const

pure virtual

Implemented in MDRowVec, and MDRowSql.

end() [1/2]

iterator MDRow::end ( )

inline

Definition at line 194 of file metadata_row_base.h.

{ return iterator_ptr<false>(this->size(), *this); }

end() [2/2]

const_iterator MDRow::end ( ) const

inline

Definition at line 197 of file metadata_row_base.h.

{ return iterator_ptr<true>(this->size(), *this); }

getObject() [1/2]

virtual MDObject* MDRow::getObject ( MDLabel  label )

pure virtual

Implemented in MDRowVec, and MDRowSql.

getObject() [2/2]

virtual const MDObject* MDRow::getObject ( MDLabel  label ) const

pure virtual

Implemented in MDRowVec, and MDRowSql.

getValue() [1/4]

template<typename T >

T& MDRow::getValue ( MDLabel  label )

inline

Definition at line 97 of file metadata_row_base.h.

                               {
        MDObject* ptr = getObject(label);
        if (ptr == nullptr)
            throw std::logic_error("Object does not exist!");
        return ptr->getValue2(T());
    }

getValue() [2/4]

template<typename T >

const T& MDRow::getValue ( MDLabel  label ) const

inline

Definition at line 105 of file metadata_row_base.h.

                                           {
        const MDObject* ptr = getObject(label);
        if (ptr == nullptr)
            throw std::logic_error("Object does not exist!");
        return ptr->getValue2(T());
    }

getValue() [3/4]

template<typename T >

bool MDRow::getValue ( MDLabel  label, T &  d  ) const

inline

Definition at line 113 of file metadata_row_base.h.

                                             { // FIXME: deprecated
        auto *obj = getObject(label);
        if (obj == nullptr)
            return false;
        d = obj->getValue2(T());
        return true;
    }

getValue() [4/4]

bool MDRow::getValue ( MDObject &  object ) const

inline

Definition at line 121 of file metadata_row_base.h.

                                          { // FIXME: deprecated
        const MDObject* ptr = this->getObject(object.label);
        if (ptr != nullptr)
            object = *ptr;
        return (ptr != nullptr);
    }

getValueOrDefault() [1/3]

template<typename T >

const T& MDRow::getValueOrDefault ( MDLabel  label, const T &  def  ) const

inline

Definition at line 129 of file metadata_row_base.h.

                                                                  {
        const MDObject* ptr = getObject(label);
        if (ptr == nullptr)
            return def;
        return ptr->getValue2(T());
    }

getValueOrDefault() [2/3]

template<typename T >

T& MDRow::getValueOrDefault ( MDLabel  label, const T &  def  )

inline

Definition at line 137 of file metadata_row_base.h.

                                                      {
        const MDObject* ptr = getObject(label);
        if (ptr == nullptr)
            return def;
        return ptr->getValue2(T());
    }

getValueOrDefault() [3/3]

template<typename T , typename T1 >

void MDRow::getValueOrDefault ( MDLabel  label, T &  d, T1  def  ) const

inline

Definition at line 145 of file metadata_row_base.h.

                                                              { // FIXME: deprecated
        if (!getValue(label, d))
            d = (T) def;
    }

id()

virtual size_t MDRow::id ( ) const

inlinevirtual

Reimplemented in MDRowSql.

Definition at line 67 of file metadata_row_base.h.

                              {
        return getObject(MDL_OBJID)->getValue2(size_t());
    }

labels()

virtual std::vector<MDLabel> MDRow::labels ( ) const

pure virtual

Implemented in MDRowVec, and MDRowSql.

operator=()

virtual MDRow& MDRow::operator= ( const MDRow &  )

pure virtual

Implemented in MDRowVec, and MDRowSql.

resetGeo()

virtual void MDRow::resetGeo ( bool  addLabels = true )

inlinevirtual

Reset the values of the labels related to geometry to their default values

Definition at line 78 of file metadata_row_base.h.

                                                 {
        setValue(MDL_ORIGIN_X,  0., addLabels);
        setValue(MDL_ORIGIN_Y,  0., addLabels);
        setValue(MDL_ORIGIN_Z,  0., addLabels);
        setValue(MDL_SHIFT_X,   0., addLabels);
        setValue(MDL_SHIFT_Y,   0., addLabels);
        setValue(MDL_SHIFT_Z,   0., addLabels);
        setValue(MDL_ANGLE_ROT, 0., addLabels);
        setValue(MDL_ANGLE_TILT,0., addLabels);
        setValue(MDL_ANGLE_PSI, 0., addLabels);
        setValue(MDL_WEIGHT,   1., addLabels);
        setValue(MDL_FLIP,     false, addLabels);
        setValue(MDL_SCALE,    1., addLabels);
    }

setValue() [1/2]

template<typename T >

void MDRow::setValue ( MDLabel  label, const T &  d, bool  addLabel = true  )

inline

Definition at line 151 of file metadata_row_base.h.

                                                                   {
        if (this->containsLabel(label) || addLabel)
            this->setValue(MDObject(label, d));
    }

setValue() [2/2]

virtual void MDRow::setValue ( const MDObject &  object )

pure virtual

Implemented in MDRowVec, and MDRowSql.

setValueFromStr()

virtual void MDRow::setValueFromStr ( MDLabel  label, const String &  value  )

inlinevirtual

Definition at line 158 of file metadata_row_base.h.

                                                                     {
        MDObject mdValue(label);
        mdValue.fromString(value);
        setValue(mdValue);
    }

size()

virtual int MDRow::size ( ) const

pure virtual

Implemented in MDRowVec, and MDRowSql.

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  out, const MDRow &  row  )

friend

---

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

• xmippCore/core/metadata_row_base.h