SHA_Logger::Comment Class Reference

#include <comment.hxx>

Public Member Functions
	~Comment ()

Static Public Member Functions
static Ostream &	Build (Ostream &os, const String &message, int level=0, const String extent="normal")
static Writer &	Build (Writer &writer, const String &message, int level=0, const String extent="normal")

Private Member Functions
	Comment (Ostream &os)
Comment	operator= (Comment &)
bool	Write (const String &message, int level, const String &extent)

Static Private Member Functions
static bool	Write (Writer &writer, const String &message, int level, const String &extent)

Private Attributes
std::unique_ptr< Stream >	stream
std::unique_ptr< Writer >	writer

Detailed Description

parameter.

Definition at line 30 of file comment.hxx.

Constructor & Destructor Documentation

SHA_Logger::Comment::~Comment ( )

inline

Definition at line 34 of file comment.hxx.

{ assert(this->writer->IsComplete()); }

SHA_Logger::Comment::Comment ( Ostream &  os )

inlineprivate

Definition at line 65 of file comment.hxx.

                           : stream(std::unique_ptr<Stream>(new Stream(os))),
                             writer(std::unique_ptr<Writer>(new Writer(*this->stream))) {}

Member Function Documentation

static Ostream& SHA_Logger::Comment::Build ( Ostream &  os, const String &  message, int  level = 0, const String  extent = "normal"  )

inlinestatic

Instantiate a new json writer using the stream passed as argument and write value information.

Returns

stream reference filled up with Comment object information, error information in case of failure.

Note

todo pass extent as an enumered type.

Definition at line 43 of file comment.hxx.

      {
        std::unique_ptr<Comment> builder = std::unique_ptr<Comment>(new Comment(os));
        builder->Write(message, level, extent);

        return os;
      }

static Writer& SHA_Logger::Comment::Build ( Writer &  writer, const String &  message, int  level = 0, const String  extent = "normal"  )

inlinestatic

Use json writer passed as parameter to write iterator information.

Returns

stream reference filled up with Comment object information, error information in case of failure.

Definition at line 56 of file comment.hxx.

      {
        Write(writer, message, level, extent);

        return writer;
      }

Comment SHA_Logger::Comment::operator= ( Comment &  )

inlineprivate

Definition at line 67 of file comment.hxx.

{} // Not Implemented

bool SHA_Logger::Comment::Write ( const String &  message, int  level, const String &  extent  )

inlineprivate

Definition at line 69 of file comment.hxx.

      { return Write(*this->writer, message, level, extent); }

static bool SHA_Logger::Comment::Write ( Writer &  writer, const String &  message, int  level, const String &  extent  )

inlinestaticprivate

Definition at line 72 of file comment.hxx.

      {
        writer.StartObject();
        writer.Key("type");
        writer.String("comment");
        writer.Key("message");
        writer.String(message);
        writer.Key("level");
        writer.Int(level);
        writer.Key("extent");
        writer.String(extent);
        writer.EndObject();

        return true;
      }

Member Data Documentation

std::unique_ptr<Stream> SHA_Logger::Comment::stream

private

Definition at line 88 of file comment.hxx.

std::unique_ptr<Writer> SHA_Logger::Comment::writer

private

Definition at line 89 of file comment.hxx.

---

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

• comment.hxx