SHA_Logger::Iterator Class Reference

#include <iterator.hxx>

Public Member Functions
	~Iterator ()

Static Public Member Functions
static Ostream &	Build (Ostream &os, const String &parentId, const String &name, int index, const String &comment="")
static Writer &	Build (Writer &writer, const String &parentId, const String &name, int index, const String &comment="")
template<typename T >
static const T &	BuildIt (Ostream &os, const String &parentId, const String &name, int index, const T &it, const String &comment="")
template<typename T >
static const T &	BuildIt (Writer &writer, const String &parentId, const String &name, int index, const T &it, const String &comment="")

Private Member Functions
	Iterator (Ostream &os)
Iterator	operator= (Iterator &)
bool	Write (const String &parentId, const String &name, int index, const String &comment)

Static Private Member Functions
static bool	Write (Writer &writer, const String &parentId, const String &name, int index, const String &comment)

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

Detailed Description

parameter.

Definition at line 31 of file iterator.hxx.

Constructor & Destructor Documentation

SHA_Logger::Iterator::~Iterator ( )

inline

Definition at line 35 of file iterator.hxx.

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

SHA_Logger::Iterator::Iterator ( Ostream &  os )

inlineprivate

Definition at line 92 of file iterator.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::Iterator::Build ( Ostream &  os, const String &  parentId, const String &  name, int  index, const String &  comment = ""  )

inlinestatic

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

Returns

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

Definition at line 43 of file iterator.hxx.

      {
        std::unique_ptr<Iterator> builder = std::unique_ptr<Iterator>(new Iterator(os));
        builder->Write(parentId, name, index, comment);

        return os;
      }

static Writer& SHA_Logger::Iterator::Build ( Writer &  writer, const String &  parentId, const String &  name, int  index, const String &  comment = ""  )

inlinestatic

Use json writer passed as parameter to write iterator information.

Returns

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

Definition at line 56 of file iterator.hxx.

      {
        Write(writer, parentId, name, index, comment);

        return writer;
      }

template<typename T >

static const T& SHA_Logger::Iterator::BuildIt ( Ostream &  os, const String &  parentId, const String &  name, int  index, const T &  it, const String &  comment = ""  )

inlinestatic

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

Returns

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

Definition at line 69 of file iterator.hxx.

      {
        std::unique_ptr<Iterator> builder = std::unique_ptr<Iterator>(new Iterator(os));
        builder->Write(parentId, name, index, comment);

        return it;
      }

template<typename T >

static const T& SHA_Logger::Iterator::BuildIt ( Writer &  writer, const String &  parentId, const String &  name, int  index, const T &  it, const String &  comment = ""  )

inlinestatic

Use json writer passed as parameter to write iterator information.

Returns

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

Definition at line 83 of file iterator.hxx.

      {
        Write(writer, parentId, name, index, comment);

        return it;
      }

Iterator SHA_Logger::Iterator::operator= ( Iterator &  )

inlineprivate

Definition at line 94 of file iterator.hxx.

{} // Not Implemented

bool SHA_Logger::Iterator::Write ( const String &  parentId, const String &  name, int  index, const String &  comment  )

inlineprivate

Definition at line 96 of file iterator.hxx.

      { return Write(*this->writer, parentId, name, index, comment); }

static bool SHA_Logger::Iterator::Write ( Writer &  writer, const String &  parentId, const String &  name, int  index, const String &  comment  )

inlinestaticprivate

Definition at line 100 of file iterator.hxx.

      {
        // Add Error Object log in case of failure
        if (parentId.empty() || name.empty())
        {
          Error::Build(writer, __FILE__, __LINE__,
            "Missing parameter: " +
            (parentId.empty()) ? "+ parentId " : "" +
            (name.empty()) ? "+ name " : "");
          return false;
        }

        // Add iterator information
        writer.StartObject();
        writer.Key("type");
        writer.String("iterator");

        writer.Key("name");
        writer.String(name);

        writer.Key("ref");
        writer.String(parentId);

        writer.Key("data");
        writer.Int(index);

        if (!comment.empty())
        {
          writer.Key("comment");
          writer.String(comment);
        }
        writer.EndObject();

        return true;
      }

Member Data Documentation

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

private

Definition at line 136 of file iterator.hxx.

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

private

Definition at line 137 of file iterator.hxx.

---

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

• iterator.hxx