From dcd1c9a6e1fbb7462db67a15b9e0dfd22d4f6a4f Mon Sep 17 00:00:00 2001 From: manuel Date: Sat, 30 May 2009 16:32:43 +0200 Subject: adding doxygen --- ue4/doxygen/classCCPU.html | 632 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 632 insertions(+) create mode 100644 ue4/doxygen/classCCPU.html (limited to 'ue4/doxygen/classCCPU.html') diff --git a/ue4/doxygen/classCCPU.html b/ue4/doxygen/classCCPU.html new file mode 100644 index 0000000..b4698e0 --- /dev/null +++ b/ue4/doxygen/classCCPU.html @@ -0,0 +1,632 @@ + + +mycpu: CCPU< T > Class Template Reference + + + + +
+ +
+
+ +
+

CCPU< T > Class Template Reference

#include <ccpu.h> +

+ +

+List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

 CCPU (const unsigned cnt, T &datatype)
 Default ctor.
 ~CCPU ()
 Default dtor.
const unsigned getRegisterCount () const
 get number of registers
std::vector< T > & getRegisters ()
 get reference to registers vector
void setMemory (CMem< T > *memory)
 set memory of cpu
CMem< T > * getMemory () const
 get pointer to memory
void setProgram (const CProgram< T > *program)
 set program to execute
const CProgram< T > * getProgram ()
 get pointer to program
const std::set
+< CDisplay< T > * > & 		getDisplays ()
 get set of pointers to displays
void setFlagZero (const bool value)
 set zero flag
const bool getFlagZero ()
 get value of zero flag
void setFlagSign (const bool value)
 set sign flag
const bool getFlagSign ()
 get value of sign flag
void run ()
 execute current program
+

Detailed Description

+

template<class T>
+ class CCPU< T >

+ +CPU implementation. Used as a container for memory and instructions. Implements a run method to execute the program (= the instructions).

Constructor & Destructor Documentation

+ +
+
+
+template<class T>
+ + + + + + + + + + + + + + + + + + +
CCPU< T >::CCPU (const unsigned  cnt,
T &  datatype 
) [inline]
+
+
+ +

+Default ctor. +

+

Methodname:
CCPU
+
Parameters:
+ + + +
cnt number of registers to allocate for this cpu
datatype reference instance of datatype to copy from
+
+
Returns:
-
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+
+template<class T>
+ + + + + + + + +
CCPU< T >::~CCPU (  )  [inline]
+
+
+ +

+Default dtor. +

+

Methodname:
~CCPU
+
Parameters:
+ + +
- 
+
+
Returns:
-
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+

Member Function Documentation

+ +
+
+
+template<class T>
+ + + + + + + + +
const unsigned CCPU< T >::getRegisterCount (  )  const [inline]
+
+
+ +

+get number of registers +

+

Methodname:
getRegisterCount
+
Parameters:
+ + +
- 
+
+
Returns:
number of registers
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+
+template<class T>
+ + + + + + + + +
std::vector<T>& CCPU< T >::getRegisters (  )  [inline]
+
+
+ +

+get reference to registers vector +

+

Methodname:
getRegisters
+
Parameters:
+ + +
- 
+
+
Returns:
reference to registers vector
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+
+template<class T>
+ + + + + + + + + +
void CCPU< T >::setMemory (CMem< T > *  memory  )  [inline]
+
+
+ +

+set memory of cpu +

+

Methodname:
setMemory
+
Parameters:
+ + +
memory pointer to memory
+
+
Returns:
-
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+
+template<class T>
+ + + + + + + + +
CMem<T>* CCPU< T >::getMemory (  )  const [inline]
+
+
+ +

+get pointer to memory +

+

Methodname:
getMemory
+
Parameters:
+ + +
- 
+
+
Returns:
pointer to memory
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+
+template<class T>
+ + + + + + + + + +
void CCPU< T >::setProgram (const CProgram< T > *  program  )  [inline]
+
+
+ +

+set program to execute +

+

Methodname:
setProgram
+
Parameters:
+ + +
program pointer to program
+
+
Returns:
-
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+
+template<class T>
+ + + + + + + + +
const CProgram<T>* CCPU< T >::getProgram (  )  [inline]
+
+
+ +

+get pointer to program +

+

Methodname:
getProgram
+
Parameters:
+ + +
- 
+
+
Returns:
pointer to program
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+
+template<class T>
+ + + + + + + + +
const std::set<CDisplay<T> *>& CCPU< T >::getDisplays (  )  [inline]
+
+
+ +

+get set of pointers to displays +

+

Methodname:
getDisplays
+
Parameters:
+ + +
- 
+
+
Returns:
reference to set of pointers to displays
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+
+template<class T>
+ + + + + + + + + +
void CCPU< T >::setFlagZero (const bool  value  )  [inline]
+
+
+ +

+set zero flag +

+

Methodname:
setFlagZero
+
Parameters:
+ + +
value new value of zero flag
+
+
Returns:
-
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+
+template<class T>
+ + + + + + + + +
const bool CCPU< T >::getFlagZero (  )  [inline]
+
+
+ +

+get value of zero flag +

+

Methodname:
getFlagZero
+
Parameters:
+ + +
- 
+
+
Returns:
value of zero flag
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+
+template<class T>
+ + + + + + + + + +
void CCPU< T >::setFlagSign (const bool  value  )  [inline]
+
+
+ +

+set sign flag +

+

Methodname:
setFlagSign
+
Parameters:
+ + +
value new value of sign flag
+
+
Returns:
-
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+
+template<class T>
+ + + + + + + + +
const bool CCPU< T >::getFlagSign (  )  [inline]
+
+
+ +

+get value of sign flag +

+

Methodname:
getFlagSign
+
Parameters:
+ + +
- 
+
+
Returns:
value of sign flag
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+
+template<class T>
+ + + + + + + + +
void CCPU< T >::run (  )  [inline]
+
+
+ +

+execute current program +

+

Methodname:
run
+
Parameters:
+ + +
- 
+
+
Returns:
-
+
Global variables used:
none
+
Exceptions:
+ + +
CCPUError 
+
+
Precondition:
m_memory and m_program still exist
+
Postcondition:
none
+ +
+

+

The documentation for this class was generated from the following file: +
Generated on Sat May 30 16:32:35 2009 for mycpu by  + +doxygen 1.5.3
+ + -- cgit v1.2.3