PLMD::vesselbase::VesselRegister Class Reference

#include <VesselRegister.h>

Public Member Functions
	~VesselRegister ()
	The destructor. More...
void	add (std::string keyword, creator_pointer, keyword_pointer k, keyword_pointer ik)
	Add a new distribution function option to the register of distribution functions. More...
void	remove (creator_pointer f)
	Remove a distribution function from the register of distribution functions. More...
bool	check (std::string keyname)
	Verify if a distribution keyword is present in the register. More...
Vessel *	create (std::string keyword, const VesselOptions &da)
	Create a distribution function of the specified type. More...
Keywords	getKeywords ()
	Return the keywords. More...

Private Types
typedef Vessel *(*	creator_pointer )(const VesselOptions &)
	Pointer to a function which, given the keyword for a distribution function, creates it. More...
typedef void(*	keyword_pointer )(Keywords &)
	Pointer to the function that reserves the keyword for the distribution. More...

Private Attributes
std::map< std::string, creator_pointer >	m
	The set of possible distribution functions we can work with. More...
std::map< std::string, keyword_pointer >	mk
	Map action to a function which documents the related object. More...
Keywords	keywords
	A vector of function pointers - this is used to create the documentation. More...

Detailed Description

Definition at line 38 of file VesselRegister.h.

Member Typedef Documentation

typedef Vessel*(* PLMD::vesselbase::VesselRegister::creator_pointer)(const VesselOptions &)

private

Pointer to a function which, given the keyword for a distribution function, creates it.

Definition at line 41 of file VesselRegister.h.

typedef void(* PLMD::vesselbase::VesselRegister::keyword_pointer)(Keywords &)

private

Pointer to the function that reserves the keyword for the distribution.

Definition at line 43 of file VesselRegister.h.

Constructor & Destructor Documentation

PLMD::vesselbase::VesselRegister::~VesselRegister

(

)

The destructor.

Definition at line 29 of file VesselRegister.cpp.

Member Function Documentation

void PLMD::vesselbase::VesselRegister::add	(	std::string	keyword,
		creator_pointer	f,
		keyword_pointer	k,
		keyword_pointer	ik
	)

Add a new distribution function option to the register of distribution functions.

Definition at line 50 of file VesselRegister.cpp.

bool PLMD::vesselbase::VesselRegister::check

(

std::string

keyname

)

Verify if a distribution keyword is present in the register.

Definition at line 60 of file VesselRegister.cpp.

Vessel * PLMD::vesselbase::VesselRegister::create	(	std::string	keyword,
		const VesselOptions &	da
	)

Create a distribution function of the specified type.

Definition at line 65 of file VesselRegister.cpp.

Keywords PLMD::vesselbase::VesselRegister::getKeywords

(

)

Return the keywords.

Definition at line 77 of file VesselRegister.cpp.

void PLMD::vesselbase::VesselRegister::remove

(

creator_pointer

f

)

Remove a distribution function from the register of distribution functions.

Definition at line 42 of file VesselRegister.cpp.

Member Data Documentation

Keywords PLMD::vesselbase::VesselRegister::keywords

private

A vector of function pointers - this is used to create the documentation.

Definition at line 49 of file VesselRegister.h.

std::map<std::string,creator_pointer> PLMD::vesselbase::VesselRegister::m

private

The set of possible distribution functions we can work with.

Definition at line 45 of file VesselRegister.h.

std::map<std::string,keyword_pointer> PLMD::vesselbase::VesselRegister::mk

private

Map action to a function which documents the related object.

Definition at line 47 of file VesselRegister.h.

---

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

• vesselbase/VesselRegister.h
• vesselbase/VesselRegister.cpp