mic::types::Action2D< ActionType > Class Template Reference

Abstract template class representing an action in 2-D space. More...

#include <Action2D.hpp>

Inheritance diagram for mic::types::Action2D< ActionType >:

Collaboration diagram for mic::types::Action2D< ActionType >:

Public Member Functions
virtual	~Action2D ()
virtual void	setAction (ActionType type_)=0
ActionType	getType ()
Public Member Functions inherited from mic::types::Action2DInterface
	Action2DInterface ()

Protected Member Functions
	Action2D ()

Protected Attributes
ActionType	type

Additional Inherited Members
Public Attributes inherited from mic::types::Action2DInterface
int	dx
	Increment according to x axis. More...
int	dy
	Increment according to y axis. More...

Detailed Description

template<typename ActionType>
class mic::types::Action2D< ActionType >

Abstract template class representing an action in 2-D space.

Template Parameters

actionType

Template parameter defining action type.

Author

tkornuta

Definition at line 88 of file Action2D.hpp.

Constructor & Destructor Documentation

template<typename ActionType>

virtual mic::types::Action2D< ActionType >::~Action2D ( )

inlinevirtual

Virtual destructor. Empty.

Definition at line 93 of file Action2D.hpp.

template<typename ActionType>

mic::types::Action2D< ActionType >::Action2D ( )

inlineprotected

Default constructor. Calls default constructor of parent Action2DInterface class. Protected - to be used by derived classes.

Definition at line 116 of file Action2D.hpp.

Member Function Documentation

template<typename ActionType>

ActionType mic::types::Action2D< ActionType >::getType ( )

inline

Returns the action type.

Returns

Action type.

Definition at line 105 of file Action2D.hpp.

template<typename ActionType>

virtual void mic::types::Action2D< ActionType >::setAction ( ActionType  type_ )

pure virtual

Abstract method - its implementations should set the increments according to action type.

Parameters

ActionType

Type of action.

Implemented in mic::types::NESWAction.

Member Data Documentation

template<typename ActionType>

ActionType mic::types::Action2D< ActionType >::type

protected

Type of the performed action.

Definition at line 111 of file Action2D.hpp.

Referenced by mic::types::Action2D< NESW >::getType().

---

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

• src/types/Action2D.hpp