DocLine Class Reference

#include <docfile.h>

Public Types
enum	Line_Type { NOT_CONSIDERED = -1, NOT_ASSIGNED = 0, DATALINE = 1, COMMENT = 2 }

Public Member Functions
void	read (std::istream &i)
Constructors for Document Lines
	DocLine ()
Component access
double &	operator[] (size_t i)
double	operator[] (size_t i) const
void	set (size_t i, double val)
void	set (const Matrix1D< double > &v)
Structure information
std::string	get_text ()
int	get_key () const
int	get_no_components () const
void	clear ()
int	Is_comment ()
int	Is_data ()
void	set_type (Line_Type _line_type)

Friends
class	DocFile
	Document file can access anything in this class. More...
std::ostream &	operator<< (std::ostream &o, const DocLine &DL)

Detailed Description

DocFile Line.

The Document file is a collection (STL list) of Document lines. This class needn't be accessed in common programs since the DocFile class offers most of the used functions. However, the class is shown in case you may need to access specifically to any of the Document Line functions alone. The DocLines can be either comments or data line, they might be of other internal used types (not assigned or to be discarded), but you may assume that if a line is not a comment nor a data line then it can be skipped.

Definition at line 54 of file docfile.h.

Member Enumeration Documentation

Line_Type

enum DocLine::Line_Type

Enumerator
NOT_CONSIDERED
NOT_ASSIGNED
DATALINE
COMMENT

Definition at line 57 of file docfile.h.

    {
        NOT_CONSIDERED = -1,
        NOT_ASSIGNED = 0,
        DATALINE = 1,
        COMMENT = 2
    } Line_Type;

Constructor & Destructor Documentation

DocLine()

DocLine::DocLine ( )

inline

Empty Constructor.

The document line is created with no type (neither comment or data). You must use the function set_type to assign a type

Definition at line 82 of file docfile.h.

              : line_type(NOT_ASSIGNED)
    {}

Member Function Documentation

clear()

void DocLine::clear

(

)

Empty the document line.

Definition at line 87 of file docfile.cpp.

{
    line_type = NOT_ASSIGNED;
    text = "";
    key = 0;
    data.clear();
}

get_key()

int DocLine::get_key ( ) const

inline

Get the key of this line.

Definition at line 142 of file docfile.h.

    {
        return key;
    }

get_no_components()

int DocLine::get_no_components ( ) const

inline

Get the number of components.

If it is a comment or it hasn't been assigned it returns -1

Definition at line 151 of file docfile.h.

    {
        if (line_type == DATALINE)
            return data.size();
        else
            return -1;
    }

get_text()

std::string DocLine::get_text ( )

inline

Get text of this line.

The text is only valid for comment lines

Definition at line 135 of file docfile.h.

    {
        return text;
    }

Is_comment()

int DocLine::Is_comment ( )

inline

True if current line is a comment.

Definition at line 165 of file docfile.h.

    {
        return line_type == COMMENT;
    }

Is_data()

int DocLine::Is_data ( )

inline

True if current line is a comment.

Definition at line 172 of file docfile.h.

    {
        return line_type == DATALINE;
    }

operator[]() [1/2]

double & DocLine::operator[]

(

size_t

i

)

Set existing components.

Inside the document line the values are considered as an array (with starting index at 0). With this function you can set any EXISTING position inside the document line. If the position has not been created yet (ie, the vector is smaller) then an exception is thrown.

line[3] = 3; // line[3] must exist!!

This function is ignored in the python wrapper. Use "set" instead.

Definition at line 34 of file docfile.cpp.

{
    if (i+1 > data.size())
    {
        std::cout << "Docline=" << *this << std::endl;
        REPORT_ERROR(ERR_DOCFILE, "Trying to access to non-existing element " +
                     integerToString(i) + " of a document line");
    }

    return data[i];
}

operator[]() [2/2]

double DocLine::operator[]

(

size_t

i

)

const

Constant component access.

The same as the previous function

This function is renamed as "get" in the python wrapper.

Definition at line 46 of file docfile.cpp.

{
    if (i+1 > data.size())
    {
        std::cout << "Docline=" << *this << std::endl;
        REPORT_ERROR(ERR_DOCFILE, "Trying to access to non-existing element " +
                     integerToString(i) + " of a document line");
    }

    return data[i];
}

read()

void DocLine::read

(

std::istream &

i

)

Read a Document Line. An exception is thrown if the line doesn't meet the Document File specifications. First the line is read in a C way, if it fails then the exact Fortran output is tried.

Definition at line 129 of file docfile.cpp.

{
    std::string line;
    int param_no;

    // Get line
    getline(in, line);

    // Initialize target
    line_type = DocLine::NOT_ASSIGNED;
    text = "";
    key = 0;
    data.clear();

    // Check if comment or empty line
    int charpos1 = line.find_first_not_of(" \t");
    if (line[0] == '\0' || line[charpos1] == '#' || line[charpos1] == ';')
    {
        line_type = DocLine::COMMENT;
        text = line;
        data.clear();
        key = 0;
    }
    // Read a true document file line
    else
    {
        line_type = DocLine::DATALINE;
        text = "";
        size_t i = 0;

        key = textToInteger(nextToken(line, i));
        param_no = textToInteger(nextToken(line, i));
        std::string auxline = line;

        try
        {
            // Try unfixed mode first
            readFloatList(line, i, param_no, data);
        }
        catch (XmippError &e)
        {
            // Try fixed mode then
            data.clear();
            data.reserve(param_no);
            for (int i = 0; i < param_no; i++)
            {
                data.push_back(textToFloat(line.substr(8 + i*12, 12)));
            }
        }
    }
}

set() [1/2]

void DocLine::set	(	size_t	i,
		double	val
	)

Set an existing or not component.

If the Document Line is not large enough to hold the required component, then it is resized

Definition at line 58 of file docfile.cpp.

{
    // Make sure there is enough memory
    if (i + 1 > data.size())
        data.reserve(i + 1);

    // Pad with zeros for the non-existing indexes in between
    int space_needed = i + 1 - data.size();
    for (int k = 0; k < space_needed; k++)
        data.push_back(0);

    // Set required data
    data[i] = val;
}

set() [2/2]

void DocLine::set

(

const Matrix1D< double > &

v

)

Set a vector (Matrix1D) as Document line.

It doesn't matter if it is a row or a column vector. The previous data is overwritten and the key is kept. If it was not a data line, then the new key=0.

Definition at line 73 of file docfile.cpp.

{
    data.clear();
    if (line_type != DATALINE)
    {
        line_type = DATALINE;
        key = 0;
    }

    data.reserve(VEC_XSIZE(v));
    FOR_ALL_ELEMENTS_IN_MATRIX1D(v)
    data.push_back(VEC_ELEM(v, i));
}

set_type()

void DocLine::set_type ( Line_Type  _line_type )

inline

Set type.

Only the comment flag is set, the key and possible data are not lost. The comment text is not touched. The valid types are DATALINE, COMMENT, NOT_ASSIGNED, and NOT_CONSIDERED.

Definition at line 183 of file docfile.h.

    {
        line_type = _line_type;
    }

Friends And Related Function Documentation

DocFile

friend class DocFile

friend

Document file can access anything in this class.

Definition at line 71 of file docfile.h.

operator<<

std::ostream& operator<< ( std::ostream &  o, const DocLine &  DL  )

friend

Show a Document Line.

Definition at line 95 of file docfile.cpp.

{
    char aux[30];
    switch (line.line_type)
    {
    case DocLine::DATALINE:
                    // Print a data line
                    sprintf(aux, "%5d ", line.key);
        o << aux;
        sprintf(aux, "%-2lu", (unsigned long int)(line.data.size()));
        o << aux;

        int imax;
        imax = line.data.size();
        for (int i = 0; i < imax; i++)
{
            sprintf(aux, " % 10.5f", line.data[i]);
            o << aux;
        }

        o << std::endl;
        break;

    case DocLine::COMMENT:
                    // Print a comment
                    o << line.text << std::endl;
        break;
    default:
        break;
    }

    return o;
}

---

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

• xmipp/libraries/interface/docfile.h
• xmipp/libraries/interface/docfile.cpp