blue_sky::event_base< strategy_t > Class Template Reference

Base class for model events. More...

#include <event_base.h>

Inheritance diagram for blue_sky::event_base< strategy_t >:

Collaboration diagram for blue_sky::event_base< strategy_t >:

List of all members.

Public Types

typedef reservoir< strategy_t > reservoir_t

typedef rs_mesh_iface< strategy_t > mesh_iface_t

typedef calc_model< strategy_t > calc_model_t

typedef smart_ptr
< mesh_iface_t, true > sp_mesh_iface_t

typedef smart_ptr< reservoir_t,
true > sp_top

typedef smart_ptr
< calc_model_t, true > sp_calc_model_t

typedef smart_ptr< named_pbase,
true > sp_named_pbase

typedef event_base< strategy_t > self_t

typedef self_t this_t

typedef named_pbase::ndt_t ndt_t

typedef
named_pbase::named_pbase_idxs named_pbase_idxs

Public Member Functions

BLUE_SKY_TYPE_DECL (event_base)

blue-sky type declaration

virtual ~event_base ()

destructor

virtual void apply (const sp_top &top, const sp_mesh_iface_t &mesh, const sp_calc_model_t &calc_model) const

Applies actions from event.

void init (const std::string &event_name, const std::string &params)

Inits event.

void add_next_line (const std::string &event_name, const std::string &params)

Adds subevent.

virtual bool is_multi_line () const

Checks is keyword (or event) is multiline.

Protected Member Functions

virtual sp_named_pbase main_params () const

Returns pointer to main_params instance.

virtual sp_named_pbase add_next_line_params ()

Creates params for new subevent and returns it.

void parse (const std::string &params_str, const sp_named_pbase &params)

Parses event parameters.

void save_def (const sp_named_pbase &params, const char c= '_')

Saves default value in parameters holder.

void clear_num (const sp_named_pbase &params, const char *begin=0, const char *end=0)

Resets num (internal parser state).

void save_value (const sp_named_pbase &params, char const *first, char const *last)

Saves parsed value to holder.

Private Attributes

int num

temporary variables to store a number of same parameters

int index

index of parameter which is parsed in this moment

bool no_error_

Detailed Description

template<typename strategy_t>
class blue_sky::event_base< strategy_t >

Base class for model events.

Member Typedef Documentation

template<typename strategy_t>

typedef calc_model<strategy_t> blue_sky::event_base< strategy_t >::calc_model_t

template<typename strategy_t>

typedef rs_mesh_iface<strategy_t> blue_sky::event_base< strategy_t >::mesh_iface_t

template<typename strategy_t>

typedef named_pbase::named_pbase_idxs blue_sky::event_base< strategy_t >::named_pbase_idxs

template<typename strategy_t>

typedef named_pbase::ndt_t blue_sky::event_base< strategy_t >::ndt_t

template<typename strategy_t>

typedef reservoir<strategy_t> blue_sky::event_base< strategy_t >::reservoir_t

template<typename strategy_t>

typedef event_base<strategy_t> blue_sky::event_base< strategy_t >::self_t

template<typename strategy_t>

typedef smart_ptr<calc_model_t, true> blue_sky::event_base< strategy_t >::sp_calc_model_t

template<typename strategy_t>

typedef smart_ptr<mesh_iface_t , true> blue_sky::event_base< strategy_t >::sp_mesh_iface_t

template<typename strategy_t>

typedef smart_ptr<named_pbase, true> blue_sky::event_base< strategy_t >::sp_named_pbase

template<typename strategy_t>

typedef smart_ptr<reservoir_t, true> blue_sky::event_base< strategy_t >::sp_top

template<typename strategy_t>

typedef self_t blue_sky::event_base< strategy_t >::this_t

Constructor & Destructor Documentation

template<typename strategy_t>

virtual blue_sky::event_base< strategy_t >::~event_base ( ) [virtual]

destructor

Member Function Documentation

template<typename strategy_t>

void blue_sky::event_base< strategy_t >::add_next_line	(	const std::string &	event_name,
		const std::string &	params
	)

Adds subevent.

Parameters:

	event_name	Name of event
	params	String with event params

template<typename strategy_t>

virtual sp_named_pbase blue_sky::event_base< strategy_t >::add_next_line_params ( ) [inline, protected, virtual]

Creates params for new subevent and returns it.

Returns:: Instance of named_pbase

template<typename strategy_t>

virtual void blue_sky::event_base< strategy_t >::apply	(	const sp_top &	top,
		const sp_mesh_iface_t &	mesh,
		const sp_calc_model_t &	calc_model
	)			const `[virtual]`

Applies actions from event.

Parameters:

	top	Pointer to reservoir instance
	mesh	Pointer to mesh instance
	calc_model	Pointer to calc_model instance

Returns:

Reimplemented in blue_sky::well_event< strategy_t >, and blue_sky::well_event< strategy_t >.

template<typename strategy_t>

blue_sky::event_base< strategy_t >::BLUE_SKY_TYPE_DECL ( event_base< strategy_t > )

blue-sky type declaration

template<typename strategy_t>

void blue_sky::event_base< strategy_t >::clear_num	(	const sp_named_pbase &	params,
		const char *	begin = `0`,
		const char *	end = `0`
	)			`[protected]`

Resets num (internal parser state).

Parameters:

	params	Parameters holder
	begin	Begin of chunk of parsed string
	end	End of chunk of parsed stringsimple ..

template<typename strategy_t>

void blue_sky::event_base< strategy_t >::init	(	const std::string &	event_name,
		const std::string &	params
	)

Inits event.

Parameters:

	event_name	Name of event
	params	String with event params

template<typename strategy_t>

virtual bool blue_sky::event_base< strategy_t >::is_multi_line ( ) const [inline, virtual]

Checks is keyword (or event) is multiline.

Returns:: True is event is multiline

template<typename strategy_t>

virtual sp_named_pbase blue_sky::event_base< strategy_t >::main_params ( ) const [inline, protected, virtual]

Returns pointer to main_params instance.

Returns:: Instance of named_pbase

template<typename strategy_t>

void blue_sky::event_base< strategy_t >::parse	(	const std::string &	params_str,
		const sp_named_pbase &	params
	)			`[protected]`

Parses event parameters.

Parameters:

	params_str	String with event parameters that should be parsed
	params	Parameters holder

template<typename strategy_t>

void blue_sky::event_base< strategy_t >::save_def	(	const sp_named_pbase &	params,
		const char	c = `'_'`
	)			`[protected]`

Saves default value in parameters holder.

Parameters:

	params	Parameters holder
	c	_not_used_ skip a default value

template<typename strategy_t>

void blue_sky::event_base< strategy_t >::save_value	(	const sp_named_pbase &	params,
		char const *	first,
		char const *	last
	)			`[protected]`

Saves parsed value to holder.

Parameters:

	params	Parameters holder
	first	Begin of chunk of parsed string
	last	End of chunk of parsed string

Member Data Documentation

template<typename strategy_t>

int blue_sky::event_base< strategy_t >::index [private]

index of parameter which is parsed in this moment

template<typename strategy_t>

bool blue_sky::event_base< strategy_t >::no_error_ [private]

template<typename strategy_t>

int blue_sky::event_base< strategy_t >::num [private]

temporary variables to store a number of same parameters

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

event_base.h


Public Types
typedef reservoir< strategy_t >	reservoir_t
typedef rs_mesh_iface< strategy_t >	mesh_iface_t
typedef calc_model< strategy_t >	calc_model_t
typedef smart_ptr < mesh_iface_t, true >	sp_mesh_iface_t
typedef smart_ptr< reservoir_t, true >	sp_top
typedef smart_ptr < calc_model_t, true >	sp_calc_model_t
typedef smart_ptr< named_pbase, true >	sp_named_pbase
typedef event_base< strategy_t >	self_t
typedef self_t	this_t
typedef named_pbase::ndt_t	ndt_t
typedef named_pbase::named_pbase_idxs	named_pbase_idxs
Public Member Functions
	BLUE_SKY_TYPE_DECL (event_base)
	blue-sky type declaration
virtual	~event_base ()
	destructor
virtual void	apply (const sp_top &top, const sp_mesh_iface_t &mesh, const sp_calc_model_t &calc_model) const
	Applies actions from event.
void	init (const std::string &event_name, const std::string &params)
	Inits event.
void	add_next_line (const std::string &event_name, const std::string &params)
	Adds subevent.
virtual bool	is_multi_line () const
	Checks is keyword (or event) is multiline.
Protected Member Functions
virtual sp_named_pbase	main_params () const
	Returns pointer to main_params instance.
virtual sp_named_pbase	add_next_line_params ()
	Creates params for new subevent and returns it.
void	parse (const std::string &params_str, const sp_named_pbase &params)
	Parses event parameters.
void	save_def (const sp_named_pbase &params, const char c= '_')
	Saves default value in parameters holder.
void	clear_num (const sp_named_pbase &params, const char begin=0, const char end=0)
	Resets num (internal parser state).
void	save_value (const sp_named_pbase &params, char const first, char const last)
	Saves parsed value to holder.
Private Attributes
int	num
	temporary variables to store a number of same parameters
int	index
	index of parameter which is parsed in this moment
bool	no_error_

blue_sky::event_base< strategy_t > Class Template Reference

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

template<typename strategy_t> class blue_sky::event_base< strategy_t >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename strategy_t>
class blue_sky::event_base< strategy_t >