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/classCDatN.html | 902 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 902 insertions(+) create mode 100644 ue4/doxygen/classCDatN.html (limited to 'ue4/doxygen/classCDatN.html') diff --git a/ue4/doxygen/classCDatN.html b/ue4/doxygen/classCDatN.html new file mode 100644 index 0000000..334a66a --- /dev/null +++ b/ue4/doxygen/classCDatN.html @@ -0,0 +1,902 @@ + + +mycpu: CDatN Class Reference + + + + +
+ +
+
+ +
+

CDatN Class Reference

#include <cdatn.h> +

+ +

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

Public Member Functions

virtual ~CDatN ()
 Default dtor.
 CDatN (const CDatN &other)
 Copy constructor for CDatN.
 CDatN (const int newval, unsigned width=31)
 Copy constructor for int.
int getValue () const
 returns value of CDatN
 operator int ()
 convert to int
bool operator< (const CDatN &x) const
 implementation of operator <
bool operator== (const CDatN &x) const
 implementation of operator ==
CDatN & operator= (const int &newval)
 implementation of operator =
CDatN & operator+= (const CDatN &x)
 implementation of operator +=
CDatN & operator-= (const CDatN &x)
 implementation of operator -=
CDatN & operator *= (const CDatN &x)
 implementation of operator *=
CDatN & operator/= (const CDatN &x)
 implementation of operator /=
CDatN & operator%= (const CDatN &x)
 implementation of operator %=
CDatN & operator|= (const CDatN &x)
 implementation of operator |=
CDatN & operator &= (const CDatN &x)
 implementation of operator &=
CDatN & operator^= (const CDatN &x)
 implementation of operator ^=
CDatN & operator++ ()
 implementation of operator ++
CDatN & operator-- ()
 implementation of operator --

Protected Attributes

int m_value
unsigned m_width

Friends

std::ostream & operator<< (std::ostream &stream, CDatN cdat)
 Shift/output operator for outputstream.
std::istream & operator>> (std::istream &stream, CDatN &cdat)
 Shift/read operator for inputstream.
+

Detailed Description

+Datatype template for CCPU and CMem.

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
virtual CDatN::~CDatN (  )  [inline, virtual]
+
+
+ +

+Default dtor. +

+

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

+ +

+
+ + + + + + + + + +
CDatN::CDatN (const CDatN &  other  )  [inline]
+
+
+ +

+Copy constructor for CDatN. +

+

Methodname:
CDatN
+
Parameters:
+ + +
other reference to CDatN which will be copied
+
+
Returns:
-
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
CDatN::CDatN (const int  newval,
unsigned  width = 31 
) [inline]
+
+
+ +

+Copy constructor for int. +

+

Methodname:
CDatN
+
Parameters:
+ + + +
newval new value for CDatN
width maximum width
+
+
Returns:
-
+
Global variables used:
none
+
Exceptions:
+ + +
std::runtime_error 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+

Member Function Documentation

+ +
+
+ + + + + + + + +
int CDatN::getValue (  )  const [inline]
+
+
+ +

+returns value of CDatN +

+

Methodname:
getValue
+
Parameters:
+ + +
- 
+
+
Returns:
value of CDatN
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+ + + + + + + + +
CDatN::operator int (  )  [inline]
+
+
+ +

+convert to int +

+

Methodname:
operator int
+
Parameters:
+ + +
- 
+
+
Returns:
int
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+ + + + + + + + + +
bool CDatN::operator< (const CDatN &  x  )  const [inline]
+
+
+ +

+implementation of operator < +

+

Methodname:
operator<
+
Parameters:
+ + +
x reference to CDatN
+
+
Returns:
true if cdat is less than object x
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+ + + + + + + + + +
bool CDatN::operator== (const CDatN &  x  )  const [inline]
+
+
+ +

+implementation of operator == +

+

Methodname:
operator==
+
Parameters:
+ + +
x reference to CDatN
+
+
Returns:
true if cdat equals object x
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+ + + + + + + + + +
CDatN& CDatN::operator= (const int &  newval  )  [inline]
+
+
+ +

+implementation of operator = +

+

Methodname:
operator=
+
Parameters:
+ + +
newval reference to int
+
+
Returns:
refecence to int
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+ + + + + + + + + +
CDatN& CDatN::operator+= (const CDatN &  x  )  [inline]
+
+
+ +

+implementation of operator += +

+

Methodname:
operator+=
+
Parameters:
+ + +
x reference to CDatN
+
+
Returns:
refecence to CDatN
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+ + + + + + + + + +
CDatN& CDatN::operator-= (const CDatN &  x  )  [inline]
+
+
+ +

+implementation of operator -= +

+

Methodname:
operator-=
+
Parameters:
+ + +
x reference to CDatN
+
+
Returns:
refecence to CDatN
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+ + + + + + + + + +
CDatN& CDatN::operator *= (const CDatN &  x  )  [inline]
+
+
+ +

+implementation of operator *= +

+

Methodname:
operator*=
+
Parameters:
+ + +
x reference to CDatN
+
+
Returns:
refecence to CDatN
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+ + + + + + + + + +
CDatN& CDatN::operator/= (const CDatN &  x  )  [inline]
+
+
+ +

+implementation of operator /= +

+

Methodname:
operator/=
+
Parameters:
+ + +
x reference to CDatN
+
+
Returns:
refecence to CDatN
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+ + + + + + + + + +
CDatN& CDatN::operator%= (const CDatN &  x  )  [inline]
+
+
+ +

+implementation of operator %= +

+

Methodname:
operator%=
+
Parameters:
+ + +
x reference to CDatN
+
+
Returns:
refecence to CDatN
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+ + + + + + + + + +
CDatN& CDatN::operator|= (const CDatN &  x  )  [inline]
+
+
+ +

+implementation of operator |= +

+

Methodname:
operator|=
+
Parameters:
+ + +
x reference to CDatN
+
+
Returns:
refecence to CDatN
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+ + + + + + + + + +
CDatN& CDatN::operator &= (const CDatN &  x  )  [inline]
+
+
+ +

+implementation of operator &= +

+

Methodname:
operator&=
+
Parameters:
+ + +
x reference to CDatN
+
+
Returns:
refecence to CDatN
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+ + + + + + + + + +
CDatN& CDatN::operator^= (const CDatN &  x  )  [inline]
+
+
+ +

+implementation of operator ^= +

+

Methodname:
operator^=
+
Parameters:
+ + +
x reference to CDatN
+
+
Returns:
refecence to CDatN
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+ + + + + + + + +
CDatN& CDatN::operator++ (  )  [inline]
+
+
+ +

+implementation of operator ++ +

+

Methodname:
operator++
+
Parameters:
+ + +
- 
+
+
Returns:
refecence to CDatN
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+ + + + + + + + +
CDatN& CDatN::operator-- (  )  [inline]
+
+
+ +

+implementation of operator -- +

+

Methodname:
operator--
+
Parameters:
+ + +
- 
+
+
Returns:
refecence to CDatN
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+

Friends And Related Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
std::ostream& operator<< (std::ostream &  stream,
CDatN  cdat 
) [friend]
+
+
+ +

+Shift/output operator for outputstream. +

+

Methodname:
operator<<
+
Parameters:
+ + + +
stream reference to outputstream
cdat object which will be printed to stream
+
+
Returns:
reference to outputstream
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
std::istream& operator>> (std::istream &  stream,
CDatN &  cdat 
) [friend]
+
+
+ +

+Shift/read operator for inputstream. +

+

Methodname:
operator>>
+
Parameters:
+ + + +
stream reference to inputstream
cdat reference to object which will be read from stream
+
+
Returns:
reference to inputstream
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+

Member Data Documentation

+ +
+
+ + + + +
int CDatN::m_value [protected]
+
+
+ +

+internal value of datatype +

+

+ +

+
+ + + + +
unsigned CDatN::m_width [protected]
+
+
+ +

+width of datatype +

+

+

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