Sampa::GatedBase Class Reference

Base class for guarded variable (change value on event). More...

#include <gated.h>

Inheritance diagram for Sampa::GatedBase:

List of all members.

Public Member Functions
void	set_gate_event (EventListener &event)
const char *	get_name () const
const char *	get_full_name () const
	name can be ([^. ]+.)*[^. ]+
Object *	get_parent () const
	return object containing this one
Object *	get_sibling () const
	return next object with same parent or NULL if none
Object *	get_first_child () const
	return first child object or NULL if none
int	is_debug () const
Protected Types
enum	Severity { S_INFO, S_WARNING, S_ERROR, S_FATAL }
Protected Member Functions
void	debug (const char *,...)
void	error (Severity severity, const char *,...)
virtual void	complete_restart ()

---

Detailed Description

Base class for guarded variable (change value on event).

See also:

Gated

Definition at line 35 of file gated.h.

---

Member Enumeration Documentation

enum Sampa::Object::Severity [protected, inherited]

Enumerator:

S_INFO
S_WARNING
S_ERROR
S_FATAL

Definition at line 48 of file object.h.

---

Member Function Documentation

void Sampa::GatedBase::set_gate_event

(

EventListener &

event

)

[inline]

set event guarding the variable

Definition at line 88 of file gated.h.

const char* Sampa::Object::get_name

(

)

const [inherited]

returns the local name

const char* Sampa::Object::get_full_name

(

)

const [inherited]

name can be ([^. ]+.)*[^. ]+

Object* Sampa::Object::get_parent

(

)

const [inherited]

return object containing this one

Object* Sampa::Object::get_sibling

(

)

const [inherited]

return next object with same parent or NULL if none

Object* Sampa::Object::get_first_child

(

)

const [inherited]

return first child object or NULL if none

int Sampa::Object::is_debug

(

)

const [inline, inherited]

Definition at line 44 of file object.h.

void Sampa::Object::debug	(	const char *	,
			...
	)			[protected, inherited]

void Sampa::Object::error	(	Severity	severity,
		const char *	,
			...
	)			[protected, inherited]

virtual void Sampa::Object::complete_restart

(

)

[protected, virtual, inherited]

is called to finalize restart. On restart, one shall update pointers, or reopen ressources (files, ...).

Most of pointers are restored by the thanks to the post++ library provided that the CLASSINFO() was correctly set.

However, some pointers are not relocated by the library. These are for example the method pointers used for the processes. Take a look at

See also:

Module::restart_process, to see how this is handled

Reimplemented in Sampa::Bridge, Sampa::Dma, Sampa::FixLatencySlave, Sampa::PeriodicTrafficGenerator, Sampa::TwoPortL1Cpu, and Sampa::StochasticCpu.

---

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

• include/sampa/core/gated.h

---