Biomedical Image Analysis Library
The Biomedical Image Analysis Library is a poweful tool for developers, physicians, researchers, engineers, and so on.
Bial::PNMHeader Class Reference

PNM Header class. More...

#include <PNMHeader.hpp>

Collaboration diagram for Bial::PNMHeader:
Collaboration graph

Public Member Functions

void Comment (const std::string &cmt, const size_t line)
 Set comment of line 'line' with contents cmt. More...
 
std::string Comment (const size_t line) const
 Returns comment contents from line 'line'. More...
 
int First () const
 Returns the line of the first comment. If there are no comments, returns -1. More...
 
int Last () const
 Returns the line of the last comment. If there are no comments, returns -1. More...
 

Detailed Description

PNM Header class.

Definition at line 26 of file PNMHeader.hpp.

Member Function Documentation

void Bial::PNMHeader::Comment ( const std::string &  cmt,
const size_t  line 
)

Set comment of line 'line' with contents cmt.

Date
2013/Aug/06
Parameters
cmtComment contents
lineComment line
Returns
none.
Warning
May overwrite older comments.
std::string Bial::PNMHeader::Comment ( const size_t  line) const

Returns comment contents from line 'line'.

Date
2013/Aug/06
Parameters
lineComment line
Returns
Comment contents from line 'line'.
Warning
none.
int Bial::PNMHeader::First ( ) const

Returns the line of the first comment. If there are no comments, returns -1.

Date
2013/Aug/06
Parameters
none.
Returns
The line of the first comment.
Warning
none.
int Bial::PNMHeader::Last ( ) const

Returns the line of the last comment. If there are no comments, returns -1.

Date
2013/Aug/06
Parameters
none.
Returns
The line of the last comment.
Warning
none.

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