lestes::std::multi_action Class Reference

Action that holds a list of other actions; it runs them in its run() method. More...

#include <action.g.hh>

Inheritance diagram for lestes::std::multi_action:

List of all members.

Public Member Functions
bool	running_get () const
	The method running_get returns the value of the field multi_action::running.
void	running_set (bool)
	The method running_set sets the field multi_action::running to the given value.
ptr< ::lestes::std::list< srp< action > > >	action_list_get () const
	The method action_list_get returns the value of the field multi_action::action_list.
void	attach (ptr< action >)
void	detach (ptr< action >)
void	trigger ()
	Non-virtual shortcut for run().
virtual void	run ()
virtual ptr< reflection_list >	reflection_get () const
	for purposes of dumping
virtual ptr< field_list_list >	field_values_get () const
	for purposes of dumping
Static Public Member Functions
static ptr< multi_action >	create (bool a__multi_action__running, ptr< ::lestes::std::list< srp< action > > > a__multi_action__action_list)
	First generated factory method for class multi_action.
static ptr< multi_action >	create ()
	Second generated factory method for class multi_action.
Protected Member Functions
	multi_action (bool a__multi_action__running, ptr< ::lestes::std::list< srp< action > > > a__multi_action__action_list)
	Generated constructor for class multi_action.
virtual void	gc_mark ()
	Marking routine for class multi_action.
Private Attributes
bool	running
srp< ::lestes::std::list< srp< action > > >	action_list
Static Private Attributes
static ptr< reflection_list >	reflection = reflection

---

Detailed Description

Action that holds a list of other actions; it runs them in its run() method.

Definition at line 45 of file action.g.hh.

---

Constructor & Destructor Documentation

lestes::std::multi_action::multi_action	(	bool	a__multi_action__running,
		ptr< ::lestes::std::list< srp< action > > >	a__multi_action__action_list
	)			[protected]

Generated constructor for class multi_action.

Generated constructor for class multi_action.

Author:

lsg

Definition at line 107 of file action.g.cc.

Referenced by create().

        : action(), running(a__multi_action__running), action_list(checked(a__multi_action__action_list))
{}

---

Member Function Documentation

bool lestes::std::multi_action::running_get

(

)

const

The method running_get returns the value of the field multi_action::running.

Returns:

The value of multi_action::running.

Author:

lsg

Definition at line 60 of file action.g.cc.

References running.

{
        return running;
}

void lestes::std::multi_action::running_set

(

bool

x

)

The method running_set sets the field multi_action::running to the given value.

Parameters:

[in]

x

The new value to set multi_action::running to.

Author:

lsg

Definition at line 69 of file action.g.cc.

References running.

{
        multi_action::running = x;
}

ptr<::lestes::std::list< srp< action > > > lestes::std::multi_action::action_list_get

(

)

const

The method action_list_get returns the value of the field multi_action::action_list.

Returns:

The value of multi_action::action_list.

Author:

lsg

Definition at line 78 of file action.g.cc.

References action_list.

Referenced by attach(), and run().

{
        return action_list;
}

void lestes::std::multi_action::attach

(

ptr< action >

)

Definition at line 53 of file action.cc.

References a, action_list_get(), and lassert2.

{
        lassert2( a, "Tried to attach a NULL action." );
        action_list_get()->push_back( a );
}

void lestes::std::multi_action::detach

(

ptr< action >

)

Definition at line 59 of file action.cc.

References lassert2.

{
        lassert2( false, "Not implemented yet. Will anyone ever need this?" );
}

void lestes::std::multi_action::trigger

(

)

Non-virtual shortcut for run().

Definition at line 48 of file action.cc.

References run().

{
        run();
}

void lestes::std::multi_action::run

(

)

[virtual]

Implements lestes::std::action.

Definition at line 36 of file action.cc.

References action_list_get(), lassert, and running.

Referenced by trigger().

{
        lassert( !running );

        running = true;
        typedef list< srp<action> > al_type;
        ptr<al_type> al = action_list_get();
        for ( al_type::const_iterator it = al->begin(); it != al->end(); ++it )
                (*it)->run();
        running = false;
}

ptr< multi_action > lestes::std::multi_action::create	(	bool	a__multi_action__running,
		ptr< ::lestes::std::list< srp< action > > >	a__multi_action__action_list
	)			[static]

First generated factory method for class multi_action.

This factory method for class multi_action takes values of all fields as arguments.

Author:

lsg

Definition at line 87 of file action.g.cc.

References multi_action().

{
        return ptr< multi_action > ( new multi_action(a__multi_action__running,
                a__multi_action__action_list) );
}

ptr< multi_action > lestes::std::multi_action::create

(

void

)

[static]

Second generated factory method for class multi_action.

This factory method for class multi_action uses initializers.

Author:

lsg

Definition at line 98 of file action.g.cc.

References multi_action().

{
        return ptr< multi_action > ( new multi_action(false, ::lestes::std::list< srp< action > > ::create()) );
}

ptr< object::reflection_list > lestes::std::multi_action::reflection_get

(

)

const [virtual]

for purposes of dumping

Reimplemented from lestes::std::action.

Definition at line 112 of file action.g.cc.

References lestes::std::class_reflection::create(), lestes::std::list< T >::create(), reflection, and lestes::std::action::reflection_get().

{
        if (!reflection) {
                typedef class_reflection::field_metadata md;
                typedef class_reflection::field_metadata_list mdlist;
                ptr<mdlist> mdl = mdlist::create();
                mdl->push_back( md::create( "running", "bool" ) );
                mdl->push_back( md::create( "action_list", "list&lt; srp&lt; action &gt; &gt;" ) );
                reflection = reflection_list::create( action::reflection_get() );
                reflection->push_back( class_reflection::create( "multi_action", mdl ) );
        }
        return reflection;
}

ptr< object::field_list_list > lestes::std::multi_action::field_values_get

(

)

const [virtual]

for purposes of dumping

Reimplemented from lestes::std::action.

Definition at line 126 of file action.g.cc.

References lestes::std::list< T >::create(), and lestes::std::action::field_values_get().

{
        ptr < field_list_list > result = action::field_values_get();
        result->push_back( value_list::create() );
        result->back()->push_back( objectize< bool > ::create( this->running ) );
        result->push_back( value_list::create() );
        result->back()->push_back( this->action_list );
        return result;
}

void lestes::std::multi_action::gc_mark

(

void

)

[protected, virtual]

Marking routine for class multi_action.

Marking routine is used for garbage collection.

Author:

lsg

Reimplemented from lestes::std::action.

Definition at line 141 of file action.g.cc.

References lestes::std::action::gc_mark().

{
        action::gc_mark();
}

---

Member Data Documentation

bool lestes::std::multi_action::running [private]

Definition at line 92 of file action.g.hh.

Referenced by run(), running_get(), and running_set().

srp< ::lestes::std::list< srp< action > > > lestes::std::multi_action::action_list [private]

Definition at line 93 of file action.g.hh.

Referenced by action_list_get().

ptr< object::reflection_list > lestes::std::multi_action::reflection = reflection [static, private]

Reimplemented from lestes::std::action.

Definition at line 94 of file action.g.hh.

Referenced by reflection_get().

---

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

• action.g.hh
• action.cc
• action.g.cc

---