seq::scope Namespace Reference

Functions
void	push (const std::string &scope)
	Pushes a new scope to the stack.
void	pop ()
	Pops the current scope from the stack.
void	close (const std::string &scope)
	Closes the specified scope.
void	clear ()
	Clears all scopes from the stack.
auto	get_current () -> const std::string &
	Gets the name of the current scope.
void	stop_all (const std::string &scope)
	Stops all actions within the specified scope.
void	pause_all (const std::string &scope)
	Pauses all actions within the specified scope.
void	resume_all (const std::string &scope)
	Resumes all actions within the specified scope.
void	pause_all (const std::string &scope, const std::string &key)
	Pauses all actions within the specified scope and key.
void	resume_all (const std::string &scope, const std::string &key)
	Resumes all actions within the specified scope and key.
void	stop_and_finish_all (const std::string &scope)
	Stops and finishes all actions within the specified scope.
void	stop_when_finished_all (const std::string &scope)
	Marks all actions within the specified scope to stop when they finish.

Function Documentation

clear()

void seq::scope::clear

(

)

Clears all scopes from the stack.

Definition at line 144 of file seq.cpp.

close()

void seq::scope::close

(

const std::string &

scope

)

Closes the specified scope.

Parameters

scope

The name of the scope to close.

Definition at line 139 of file seq.cpp.

get_current()

auto seq::scope::get_current

(

)

-> const std::string &

Gets the name of the current scope.

Returns

The name of the current scope.

Definition at line 149 of file seq.cpp.

pause_all() [1/2]

void seq::scope::pause_all

(

const std::string &

scope

)

Pauses all actions within the specified scope.

Parameters

scope

The name of the scope.

Definition at line 159 of file seq.cpp.

pause_all() [2/2]

void seq::scope::pause_all	(	const std::string &	scope,
		const std::string &	key )

Pauses all actions within the specified scope and key.

Parameters

scope	The name of the scope.
key	The key associated with the actions.

Definition at line 169 of file seq.cpp.

pop()

void seq::scope::pop

(

)

Pops the current scope from the stack.

Definition at line 134 of file seq.cpp.

push()

void seq::scope::push

(

const std::string &

scope

)

Pushes a new scope to the stack.

Parameters

scope

The name of the scope to push.

Definition at line 129 of file seq.cpp.

resume_all() [1/2]

void seq::scope::resume_all

(

const std::string &

scope

)

Resumes all actions within the specified scope.

Parameters

scope

The name of the scope.

Definition at line 164 of file seq.cpp.

resume_all() [2/2]

void seq::scope::resume_all	(	const std::string &	scope,
		const std::string &	key )

Resumes all actions within the specified scope and key.

Parameters

scope	The name of the scope.
key	The key associated with the actions.

Definition at line 174 of file seq.cpp.

stop_all()

void seq::scope::stop_all

(

const std::string &

scope

)

Stops all actions within the specified scope.

Parameters

scope

The name of the scope.

Definition at line 154 of file seq.cpp.

stop_and_finish_all()

void seq::scope::stop_and_finish_all

(

const std::string &

scope

)

Stops and finishes all actions within the specified scope.

Parameters

scope

The name of the scope.

Definition at line 179 of file seq.cpp.

stop_when_finished_all()

void seq::scope::stop_when_finished_all

(

const std::string &

scope

)

Marks all actions within the specified scope to stop when they finish.

Parameters

scope

The name of the scope.

Definition at line 184 of file seq.cpp.