#include <StateVector.h>

Inheritance diagram for Core::StateVector< T >:

Public Types
typedef std::vector< T >	value_type

typedef boost::shared_ptr< StateVector< T > >	handle_type

typedef boost::signals2::signal< void(std::vector< T >, Core::ActionSource) >	values_changed_signal_type
	Signal when the data in the state is changed.

Public Types inherited from Core::StateBase
enum	{ DO_NOT_LOAD_E = -1, LOAD_LAST_E = 0, DEFAULT_LOAD_E = 100 }

typedef boost::signals2::signal< void() >	state_changed_signal_type
	This signal is triggered when the state is changed.

Public Member Functions
	StateVector (const std::string &stateid, const std::vector< T > &default_value)
	CONSTRUCTOR.

	StateVector (const std::string &stateid)

virtual	~StateVector ()
	DESTRUCTOR.

virtual std::string	export_to_string () const
	Convert the contents of the State into a string.

virtual bool	import_from_string (const std::string &str, ActionSource source=ActionSource::NONE_E)
	Set the State from a string.

const std::vector< T > &	get () const
	Get the value of the state variable.

virtual size_t	size () const
	Return the number of elements in the vector.

bool	set (const std::vector< T > &value, ActionSource source=ActionSource::NONE_E)

bool	set_at (size_t index, const T &value, ActionSource source=ActionSource::NONE_E)

bool	add (const T &value, ActionSource source=ActionSource::NONE_E)

bool	remove (const T &value, ActionSource source=ActionSource::NONE_E)

virtual void	clear (ActionSource source=ActionSource::NONE_E)
	Clear the vector.

Public Member Functions inherited from Core::StateVectorBase
	StateVectorBase (const std::string &stateid)

Public Member Functions inherited from Core::StateBase
	StateBase (const std::string &stateid)

virtual bool	import_from_string (const std::string &str, Core::ActionSource source=Core::ActionSource::NONE_E)=0
	Set the State from a string.

void	set_is_project_data (bool is_project_data)
	Set whether the data is part of the project data.

void	set_locked (bool locked)

bool	get_locked () const
	Query whether the variable has been designated as locked.

int	get_session_priority () const
	Get the priority in which loading sets the states.

void	set_session_priority (int priority)
	By default the priority is set to DEAFULT_LOAD_E.

std::string	get_stateid () const
	Get the unique id assigned to the state variable.

bool	is_project_data () const
	Whether the data is tagged as project data that is saved in a session.

Public Attributes
values_changed_signal_type	value_changed_signal_

Public Attributes inherited from Core::StateBase
state_changed_signal_type	state_changed_signal_

Protected Member Functions
virtual void	export_to_variant (Variant &variant) const
	Export the state data to a variant parameter.

virtual bool	import_from_variant (Variant &variant, Core::ActionSource source=Core::ActionSource::NONE_E)
	Import the state data from a variant parameter.

virtual bool	add (Variant &variant, Core::ActionSource source=Core::ActionSource::NONE_E)

virtual bool	set_at (size_t index, Variant &variant, ActionSource source=ActionSource::NONE_E)
	Set a value at a certain index.

virtual bool	remove (Variant &variant, Core::ActionSource source=Core::ActionSource::NONE_E)

virtual bool	validate_element_variant (Variant &variant, std::string &error)
	validate whether the variant data is of the right type

virtual bool	validate_variant (Variant &variant, std::string &error)

Protected Member Functions inherited from Core::StateVectorBase
virtual bool	add (Variant &variant, ActionSource source=ActionSource::NONE_E)=0
	Add variant data to the state vector.

virtual bool	remove (Variant &variant, ActionSource source=ActionSource::NONE_E)=0
	Remove variant data from the vector.

Protected Member Functions inherited from Core::StateBase
void	enable_signals (bool signals_enabled)

bool	signals_enabled ()
	Check whether signals are enabled.

void	set_initializing (bool initializing)

bool	get_initializing () const
	Query whether the state variable and its parent are still being initialized.

virtual void	invalidate ()

Detailed Description

template<class T>
class Core::StateVector< T >

This class is a specification of State that is used to hold a single unbound instance of a value.

Member Function Documentation

template<class T>

bool Core::StateVector< T >::set	(	const std::vector< T > &	value,
		ActionSource	source = `ActionSource::NONE_E`
	)

inline

Set the value of the state variable NOTE: this function by passes the action mechanism and should only be used to enforce a constraint from another action.

template<class T>

virtual bool Core::StateVector< T >::validate_variant	(	Variant &	variant,
		std::string &	error
	)

inlineprotectedvirtual

Validate a variant parameter This function returns false if the parameter is invalid or cannot be converted and in that case error will describe the error.

Implements Core::StateBase.

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

Core/State/StateVector.h

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

template<class T> class Core::StateVector< T >

Member Function Documentation

template<class T>
class Core::StateVector< T >