rndm::SeedMasterHelper::EngineId Struct Reference

Identifier for a engine, made of module name and optional instance name. More...

#include "EngineId.h"

Classes
struct	Global_t
	structure to identify a "global" flavour constructor More...

Public Member Functions
	EngineId (std::string const &mod, std::string const &inst=std::string())
	Constructor (module name is required) More...
	EngineId (std::string const &inst, Global_t)
	Constructor (module name is required) More...
bool	isGlobal () const
	Returns whether the label is "global" (no module context) More...
bool	hasInstanceName () const
	Returns whether the instance label is defined. More...
void	setGlobal (std::string inst)
	Sets this ID to the specified global instance. More...
bool	operator== (EngineId const &rhs) const
	Returns true if both module and instance names match. More...
bool	operator< (EngineId const &rhs) const
	Lexicographic sort (module name first, then instance name) More...
	operator std::string () const
	Converts the information in a module_name[.instance_name] string. More...
std::string	artName () const
	Converts the information in a module_name:instance_name string. More...

Public Attributes
std::string	moduleLabel
	module label More...
std::string	instanceName
	instance name More...

Static Public Attributes
static constexpr Global_t	global {}
	A constant to select a "global" flavour constructor. More...

Detailed Description

Identifier for a engine, made of module name and optional instance name.

Definition at line 22 of file EngineId.h.

Constructor & Destructor Documentation

rndm::SeedMasterHelper::EngineId::EngineId ( std::string const &  mod, std::string const &  inst = std::string()  )

inline

Constructor (module name is required)

Definition at line 31 of file EngineId.h.

                                                                         :
        moduleLabel(mod),
        instanceName(inst)
        {}

rndm::SeedMasterHelper::EngineId::EngineId ( std::string const &  inst, Global_t    )

inline

Constructor (module name is required)

Definition at line 37 of file EngineId.h.

                                               :
        moduleLabel(),
        instanceName(inst)
        {}

Member Function Documentation

std::string rndm::SeedMasterHelper::EngineId::artName ( ) const

inline

Converts the information in a module_name:instance_name string.

Definition at line 82 of file EngineId.h.

References instanceName, and moduleLabel.

{ return moduleLabel + ':' + instanceName; }

bool rndm::SeedMasterHelper::EngineId::hasInstanceName ( ) const

inline

Returns whether the instance label is defined.

Definition at line 48 of file EngineId.h.

References instanceName.

Referenced by operator std::string().

{ return !instanceName.empty(); }

bool rndm::SeedMasterHelper::EngineId::isGlobal ( ) const

inline

Returns whether the label is "global" (no module context)

Definition at line 45 of file EngineId.h.

References moduleLabel.

Referenced by rndm::SeedMaster< SEED >::print().

{ return moduleLabel.empty(); }

rndm::SeedMasterHelper::EngineId::operator std::string ( ) const

inline

Converts the information in a module_name[.instance_name] string.

Definition at line 74 of file EngineId.h.

References hasInstanceName(), instanceName, and moduleLabel.

        {
          std::string id = moduleLabel;
          if (hasInstanceName()) id.append(1, '.').append(instanceName);
          return id;
        } // operator std::string()

bool rndm::SeedMasterHelper::EngineId::operator< ( EngineId const &  rhs ) const

inline

Lexicographic sort (module name first, then instance name)

Definition at line 64 of file EngineId.h.

References instanceName, and moduleLabel.

        {
          if (moduleLabel  < rhs.moduleLabel) return true;
          if (moduleLabel == rhs.moduleLabel) {
            if (instanceName < rhs.instanceName) return true;
          }
          return false;
        } // operator< ()

bool rndm::SeedMasterHelper::EngineId::operator== ( EngineId const &  rhs ) const

inline

Returns true if both module and instance names match.

Definition at line 56 of file EngineId.h.

References instanceName, and moduleLabel.

        {
          if ( moduleLabel  != rhs.moduleLabel  ) return false;
          if ( instanceName != rhs.instanceName ) return false;
          return true;
        } // operator== ()

void rndm::SeedMasterHelper::EngineId::setGlobal ( std::string  inst )

inline

Sets this ID to the specified global instance.

Definition at line 51 of file EngineId.h.

References instanceName, and moduleLabel.

        { moduleLabel.clear(); instanceName = inst; }

Member Data Documentation

constexpr Global_t rndm::SeedMasterHelper::EngineId::global {}

static

A constant to select a "global" flavour constructor.

Definition at line 28 of file EngineId.h.

std::string rndm::SeedMasterHelper::EngineId::instanceName

instance name

Definition at line 85 of file EngineId.h.

Referenced by artName(), hasInstanceName(), operator std::string(), operator<(), operator==(), and setGlobal().

std::string rndm::SeedMasterHelper::EngineId::moduleLabel

module label

Definition at line 84 of file EngineId.h.

Referenced by artName(), isGlobal(), operator std::string(), operator<(), operator==(), and setGlobal().

---

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

• nurandom/RandomUtils/Providers/EngineId.h