gum::prm::o3prmr::O3prmrContext< GUM_SCALAR > Class Template Reference

Represent a o3prmr context, with an import, and some sequencials commands. More...

#include <O3prmrContext.h>

Collaboration diagram for gum::prm::o3prmr::O3prmrContext< GUM_SCALAR >:

Public Member Functions
	O3prmrContext (const std::string &filename=std::string())
	O3prmrContext (const O3prmrContext &s)
virtual	~O3prmrContext ()
const ImportCommand *	mainImport () const
std::string	filename () const
std::string	package () const
void	setPackage (const std::string &package)
std::string	aliasToImport (const std::string &alias)
std::vector< ImportCommand *>	imports () const
void	addImport (int line, const std::string &import, const std::string &alias)
void	addImport (int line, const std::string &import, bool ismain)
void	addImport (const ImportCommand &i)
std::vector< O3prmrSession< GUM_SCALAR > *>	sessions () const
void	addSession (const O3prmrSession< GUM_SCALAR > &session)
virtual std::string	toString () const
O3prmrContext &	operator+= (const O3prmrContext &c)

Detailed Description

template<typename GUM_SCALAR>
class gum::prm::o3prmr::O3prmrContext< GUM_SCALAR >

Represent a o3prmr context, with an import, and some sequencials commands.

Definition at line 201 of file O3prmrContext.h.

Constructor & Destructor Documentation

O3prmrContext() [1/2]

template<typename GUM_SCALAR >

gum::prm::o3prmr::O3prmrContext< GUM_SCALAR >::O3prmrContext ( const std::string &  filename = std::string() )

explicit

Definition at line 38 of file O3prmrContext_tpl.h.

                                                                          {
        m_filename   = filename;
        m_mainImport = 0;
      }

O3prmrContext() [2/2]

template<typename GUM_SCALAR >

gum::prm::o3prmr::O3prmrContext< GUM_SCALAR >::O3prmrContext

(

const O3prmrContext< GUM_SCALAR > &

s

)

Definition at line 44 of file O3prmrContext_tpl.h.

                                                                       {
        m_filename   = s.m_filename;
        m_mainImport = s.m_mainImport;
        *this += s;
      }

~O3prmrContext()

template<typename GUM_SCALAR >

gum::prm::o3prmr::O3prmrContext< GUM_SCALAR >::~O3prmrContext ( )

virtual

Definition at line 51 of file O3prmrContext_tpl.h.

                                                  {
        for (Idx i = Size(m_imports.size()); i > 0; i--)
          delete m_imports[i - 1];

        for (Size i = Size(m_sessions.size()); i > 0; i--)
          delete m_sessions[i - 1];
      }

Member Function Documentation

addImport() [1/3]

template<typename GUM_SCALAR >

void gum::prm::o3prmr::O3prmrContext< GUM_SCALAR >::addImport	(	int	line,
		const std::string &	import,
		const std::string &	alias
	)

Definition at line 88 of file O3prmrContext_tpl.h.

                                                                          {
        m_imports.push_back(new ImportCommand(line, import, alias));

        if (alias == "default") m_mainImport = m_imports.back();
      }

addImport() [2/3]

template<typename GUM_SCALAR >

void gum::prm::o3prmr::O3prmrContext< GUM_SCALAR >::addImport	(	int	line,
		const std::string &	import,
		bool	ismain
	)

Definition at line 98 of file O3prmrContext_tpl.h.

                                                                                              {
        m_imports.push_back(new ImportCommand(line, import, import));

        if (ismain) m_mainImport = m_imports.back();
      }

addImport() [3/3]

template<typename GUM_SCALAR>

void gum::prm::o3prmr::O3prmrContext< GUM_SCALAR >::addImport ( const ImportCommand &  i )

inline

Definition at line 224 of file O3prmrContext.h.

                                               {
          m_imports.push_back(new ImportCommand(i.line, i.value, i.alias));

          if (i.alias == "default") m_mainImport = m_imports.back();
        }

addSession()

template<typename GUM_SCALAR>

void gum::prm::o3prmr::O3prmrContext< GUM_SCALAR >::addSession

(

const O3prmrSession< GUM_SCALAR > &

session

)

Definition at line 110 of file O3prmrContext_tpl.h.

                                                                                             {
        m_sessions.push_back(new O3prmrSession< GUM_SCALAR >(session));
      }

aliasToImport()

template<typename GUM_SCALAR >

std::string gum::prm::o3prmr::O3prmrContext< GUM_SCALAR >::aliasToImport

(

const std::string &

alias

)

Definition at line 75 of file O3prmrContext_tpl.h.

                                                                                 {
        for (Idx i = Size(m_imports.size()); i > 0; i--)
          if (m_imports[i - 1]->alias == alias) return m_imports[i - 1]->value;

        return std::string();
      }

filename()

template<typename GUM_SCALAR >

std::string gum::prm::o3prmr::O3prmrContext< GUM_SCALAR >::filename

(

)

const

Definition at line 60 of file O3prmrContext_tpl.h.

                                                            {
        return m_filename;
      }

imports()

template<typename GUM_SCALAR >

std::vector< ImportCommand *> gum::prm::o3prmr::O3prmrContext< GUM_SCALAR >::imports

(

)

const

Definition at line 83 of file O3prmrContext_tpl.h.

                                                                             {
        return m_imports;
      }

mainImport()

template<typename GUM_SCALAR>

const ImportCommand* gum::prm::o3prmr::O3prmrContext< GUM_SCALAR >::mainImport ( ) const

inline

Definition at line 213 of file O3prmrContext.h.

{ return m_mainImport; }

operator+=()

template<typename GUM_SCALAR >

O3prmrContext< GUM_SCALAR > & gum::prm::o3prmr::O3prmrContext< GUM_SCALAR >::operator+=

(

const O3prmrContext< GUM_SCALAR > &

c

)

Definition at line 135 of file O3prmrContext_tpl.h.

                                                                                                 {
        const std::vector< ImportCommand* >& imports = c.imports();

        for (std::vector< ImportCommand* >::const_iterator i = imports.begin(); i != imports.end();
             i++)
          addImport(**i);

        const std::vector< O3prmrSession< GUM_SCALAR >* >& sessions = c.sessions();

        if (sessions.size() == 1 && sessions.back()->name() == "default") {
          *(this->m_sessions.back()) += *(sessions.back());
        } else
          for (auto i = sessions.begin(); i != sessions.end(); i++)
            addSession(**i);

        return *this;
      }

package()

template<typename GUM_SCALAR >

std::string gum::prm::o3prmr::O3prmrContext< GUM_SCALAR >::package

(

)

const

Definition at line 65 of file O3prmrContext_tpl.h.

                                                           {
        return m_package;
      }

sessions()

template<typename GUM_SCALAR >

std::vector< O3prmrSession< GUM_SCALAR > *> gum::prm::o3prmr::O3prmrContext< GUM_SCALAR >::sessions

(

)

const

Definition at line 105 of file O3prmrContext_tpl.h.

                                                                                            {
        return m_sessions;
      }

setPackage()

template<typename GUM_SCALAR >

void gum::prm::o3prmr::O3prmrContext< GUM_SCALAR >::setPackage

(

const std::string &

package

)

Definition at line 70 of file O3prmrContext_tpl.h.

                                                                           {
        m_package = package;
      }

toString()

template<typename GUM_SCALAR >

std::string gum::prm::o3prmr::O3prmrContext< GUM_SCALAR >::toString ( ) const

virtual

Definition at line 115 of file O3prmrContext_tpl.h.

                                                            {
        std::string output;

        if (!m_package.empty()) {
          output += "package " + m_package + ";\n";
          output += "\n";
        }

        for (auto i = m_imports.begin(); i < m_imports.end(); i++)
          output += (*i)->toString() + "\n";

        output += "\n";

        for (auto i = m_sessions.begin(); i < m_sessions.end(); i++)
          output += (*i)->toString() + "\n";

        return output;
      }

Member Data Documentation

m_filename

template<typename GUM_SCALAR>

std::string gum::prm::o3prmr::O3prmrContext< GUM_SCALAR >::m_filename

private

Definition at line 202 of file O3prmrContext.h.

Referenced by gum::prm::o3prmr::O3prmrContext< double >::filename(), and gum::prm::o3prmr::O3prmrContext< double >::O3prmrContext().

m_imports

template<typename GUM_SCALAR>

std::vector< ImportCommand* > gum::prm::o3prmr::O3prmrContext< GUM_SCALAR >::m_imports

private

Definition at line 205 of file O3prmrContext.h.

m_mainImport

template<typename GUM_SCALAR>

ImportCommand* gum::prm::o3prmr::O3prmrContext< GUM_SCALAR >::m_mainImport

private

Definition at line 206 of file O3prmrContext.h.

Referenced by gum::prm::o3prmr::O3prmrContext< double >::mainImport(), and gum::prm::o3prmr::O3prmrContext< double >::O3prmrContext().

m_package

template<typename GUM_SCALAR>

std::string gum::prm::o3prmr::O3prmrContext< GUM_SCALAR >::m_package

private

Definition at line 203 of file O3prmrContext.h.

Referenced by gum::prm::o3prmr::O3prmrContext< double >::package(), gum::prm::o3prmr::O3prmrContext< double >::setPackage(), and gum::prm::o3prmr::O3prmrContext< double >::toString().

m_sessions

template<typename GUM_SCALAR>

std::vector< O3prmrSession< GUM_SCALAR >* > gum::prm::o3prmr::O3prmrContext< GUM_SCALAR >::m_sessions

private

Definition at line 204 of file O3prmrContext.h.

---

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

• agrum/PRM/o3prmr/O3prmrContext.h
• agrum/PRM/o3prmr/O3prmrContext_tpl.h