gum::prm::NameGenerator Class Reference

This is a name generator for classes, types, systems, instances and class elements. More...

#include <agrum/PRM/generator/PRMGenerator.h>

Public Member Functions
Constructors and destructor.
	NameGenerator ()
	Default constructor. More...
	NameGenerator (const NameGenerator &source)
	Copy constructor. More...
virtual	~NameGenerator ()
	Destructor. More...
NameGenerator &	operator= (const NameGenerator &source)
	Affectation operator. More...
std::string	nextName (PRMObject::prm_type type)
	Getters and setters. More...

Detailed Description

This is a name generator for classes, types, systems, instances and class elements.

The generation simply use an unsigned int starting at 1 and increasing for each new name. Different numbers are used for each different type of PRMObject.

Definition at line 52 of file nameGenerator.h.

Constructor & Destructor Documentation

NameGenerator() [1/2]

INLINE gum::prm::NameGenerator::NameGenerator

(

)

Default constructor.

Definition at line 33 of file nameGenerator_inl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

: _counters_(3, 1) { GUM_CONSTRUCTOR(NameGenerator); }

Here is the call graph for this function:

NameGenerator() [2/2]

INLINE gum::prm::NameGenerator::NameGenerator

(

const NameGenerator &

source

)

Copy constructor.

Definition at line 35 of file nameGenerator_inl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                                                   :
        _counters_(source._counters_) {
      GUM_CONS_CPY(NameGenerator);
    }

Here is the call graph for this function:

~NameGenerator()

INLINE gum::prm::NameGenerator::~NameGenerator ( )

virtual

Destructor.

Definition at line 40 of file nameGenerator_inl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                         {
      GUM_DESTRUCTOR(NameGenerator);
      ;
    }

Here is the call graph for this function:

Member Function Documentation

nextName()

INLINE std::string gum::prm::NameGenerator::nextName

(

PRMObject::prm_type

type

)

Getters and setters.

Returns the next name w.r.t. the given PRMType.

Definition at line 52 of file nameGenerator_inl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                                            {
      std::stringstream s;

      switch (type) {
        case PRMObject::prm_type::ALL:
        case PRMObject::prm_type::CLASS: {
          s << "class_" << ++(_counters_[0]);
          break;
        }

        case PRMObject::prm_type::PRM_INTERFACE: {
          s << "iface_" << ++(_counters_[0]);
          break;
        }

        case PRMObject::prm_type::SYSTEM: {
          s << "sys_" << ++(_counters_[0]);
          break;
        }

        case PRMObject::prm_type::TYPE: {
          s << "type_" << ++(_counters_[0]);
          break;
        }

        case PRMObject::prm_type::CLASS_ELT: {
          s << "elt_" << ++(_counters_[1]);
          break;
        }

        case PRMObject::prm_type::INSTANCE: {
          s << "inst_" << ++(_counters_[2]);
          break;
        }

        default: {
          GUM_ERROR(FatalError, "unknown PRMObject type")
        }
      }

      return s.str();
    }

Here is the call graph for this function:

operator=()

INLINE NameGenerator & gum::prm::NameGenerator::operator=

(

const NameGenerator &

source

)

Affectation operator.

Definition at line 46 of file nameGenerator_inl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                                                       {
      _counters_ = source._counters_;
      return *this;
    }

Here is the call graph for this function:

Member Data Documentation

_counters_

std::vector< Size > gum::prm::NameGenerator::_counters_

private

The vector of counters.

Definition at line 80 of file nameGenerator.h.

---

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

• agrum/PRM/generator/nameGenerator.h
• agrum/PRM/generator/nameGenerator_inl.h