JEEP::JComment Struct Reference

Auxiliary class for comment. More...

#include <JComment.hh>

Inheritance diagram for JEEP::JComment:

Public Member Functions
	JComment ()
	Default constructor. More...
JComment &	add (const std::string &comment)
	Add comment. More...
JComment &	add (const JComment &comment)
	Add comment. More...

Static Public Attributes
static const char	START_COMMENT = '#'
	start of comment More...
static const char	CLOSE_COMMENT = '\n'
	close of comment More...

Friends
std::istream &	operator>> (std::istream &in, JComment &comment)
	Read comment from input. More...
std::ostream &	operator<< (std::ostream &out, const JComment &comment)
	Write comment to output. More...

Detailed Description

Auxiliary class for comment.

A comment starts with a

JComment::START_COMMENT

and ends with a

JComment::CLOSE_COMMENT

. The comments are appended.

Definition at line 34 of file JComment.hh.

Constructor & Destructor Documentation

JComment()

JEEP::JComment::JComment ( )

inline

Default constructor.

Definition at line 45 of file JComment.hh.

    {}

Member Function Documentation

add() [1/2]

JComment& JEEP::JComment::add ( const std::string &  comment )

inline

Add comment.

Parameters

comment

comment

Returns

this comment

Definition at line 55 of file JComment.hh.

    {
      this->push_back(comment);
 
      return *this;
    }

add() [2/2]

JComment& JEEP::JComment::add ( const JComment &  comment )

inline

Add comment.

Parameters

comment

comment

Returns

this comment

Definition at line 69 of file JComment.hh.

    {
      for (const_iterator i = comment.begin(); i != comment.end(); ++i) {
        this->push_back(*i);
      }
 
      return *this;
    }

Friends And Related Function Documentation

operator>>

std::istream& operator>> ( std::istream &  in, JComment &  comment  )

friend

Read comment from input.

Parameters

in	input stream
comment	comment

Returns

input stream

Definition at line 86 of file JComment.hh.

    {
      using namespace std;
 
      for (string buffer; in.peek() == (int) START_COMMENT; ) {
 
        in.get();
 
        if (in.peek() == (int) ' ') {
          in.get();
        }
 
        getline(in, buffer, CLOSE_COMMENT);
 
        comment.push_back(buffer);
      }
 
      return in;
    }

operator<<

std::ostream& operator<< ( std::ostream &  out, const JComment &  comment  )

friend

Write comment to output.

Parameters

out	output stream
comment	comment

Returns

output stream

Definition at line 114 of file JComment.hh.

    {
      using namespace std;
 
      for (JComment::const_iterator i = comment.begin(); i != comment.end(); ++i) {
        out << START_COMMENT << ' ' << *i << CLOSE_COMMENT;
      }
 
      return out << flush;
    }

Member Data Documentation

START_COMMENT

const char JEEP::JComment::START_COMMENT = '#'

static

start of comment

Definition at line 38 of file JComment.hh.

CLOSE_COMMENT

const char JEEP::JComment::CLOSE_COMMENT = '\n'

static

close of comment

Definition at line 39 of file JComment.hh.

---

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

• JComment.hh