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/classCDat.html | 919 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 919 insertions(+) create mode 100644 ue4/doxygen/classCDat.html (limited to 'ue4/doxygen/classCDat.html') diff --git a/ue4/doxygen/classCDat.html b/ue4/doxygen/classCDat.html new file mode 100644 index 0000000..40c2ba4 --- /dev/null +++ b/ue4/doxygen/classCDat.html @@ -0,0 +1,919 @@ + + +mycpu: CDat< T > Class Template Reference + + + + +
+ +
+
+ +
+

CDat< T > Class Template Reference

#include <cdat.h> +

+ +

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

Public Member Functions

 CDat ()
 Default ctor.
virtual ~CDat ()
 Default dtor.
 CDat (const CDat &other)
 Copy constructor for CDat.
 CDat (const T newval)
 Copy constructor for T.
T getValue () const
 returns value of CDat
 operator T ()
 convert to T
bool operator< (const CDat &x) const
 implementation of operator <
bool operator== (const CDat &x) const
 implementation of operator ==
CDat & operator+= (const CDat &x)
 implementation of operator +=
CDat & operator-= (const CDat &x)
 implementation of operator -=
CDat & operator *= (const CDat &x)
 implementation of operator *=
CDat & operator/= (const CDat &x)
 implementation of operator /=
CDat & operator%= (const CDat &x)
 implementation of operator %=
CDat & operator|= (const CDat &x)
 implementation of operator |=
CDat & operator &= (const CDat &x)
 implementation of operator &=
CDat & operator^= (const CDat &x)
 implementation of operator ^=
CDat & operator++ ()
 implementation of operator ++
CDat & operator-- ()
 implementation of operator --

Protected Attributes

T m_value

Friends

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

Detailed Description

+

template<class T>
+ class CDat< T >

+ +Datatype template for CCPU and CMem.

Constructor & Destructor Documentation

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

+Default ctor. +

+

Methodname:
CDat
+
Parameters:
+ + +
- 
+
+
Returns:
-
+
Global variables used:
none
+
Exceptions:
+ + +
bad_alloc 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+ +

+
+
+template<class T>
+ + + + + + + + +
virtual CDat< T >::~CDat (  )  [inline, virtual]
+
+
+ +

+Default dtor. +

+

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

+ +

+
+
+template<class T>
+ + + + + + + + + +
CDat< T >::CDat (const CDat< T > &  other  )  [inline]
+
+
+ +

+Copy constructor for CDat. +

+

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

+ +

+
+
+template<class T>
+ + + + + + + + + +
CDat< T >::CDat (const T  newval  )  [inline]
+
+
+ +

+Copy constructor for T. +

+

Methodname:
CDat
+
Parameters:
+ + +
newval new value for CDat
+
+
Returns:
-
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Precondition:
none
+
Postcondition:
none
+ +
+

+

Member Function Documentation

+ +
+
+
+template<class T>
+ + + + + + + + +
T CDat< T >::getValue (  )  const [inline]
+
+
+ +

+returns value of CDat +

+

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

+ +

+
+
+template<class T>
+ + + + + + + + +
CDat< T >::operator T (  )  [inline]
+
+
+ +

+convert to T +

+

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

+ +

+
+
+template<class T>
+ + + + + + + + + +
bool CDat< T >::operator< (const CDat< T > &  x  )  const [inline]
+
+
+ +

+implementation of operator < +

+

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

+ +

+
+
+template<class T>
+ + + + + + + + + +
bool CDat< T >::operator== (const CDat< T > &  x  )  const [inline]
+
+
+ +

+implementation of operator == +

+

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

+ +

+
+
+template<class T>
+ + + + + + + + + +
CDat& CDat< T >::operator+= (const CDat< T > &  x  )  [inline]
+
+
+ +

+implementation of operator += +

+

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

+ +

+
+
+template<class T>
+ + + + + + + + + +
CDat& CDat< T >::operator-= (const CDat< T > &  x  )  [inline]
+
+
+ +

+implementation of operator -= +

+

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

+ +

+
+
+template<class T>
+ + + + + + + + + +
CDat& CDat< T >::operator *= (const CDat< T > &  x  )  [inline]
+
+
+ +

+implementation of operator *= +

+

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

+ +

+
+
+template<class T>
+ + + + + + + + + +
CDat& CDat< T >::operator/= (const CDat< T > &  x  )  [inline]
+
+
+ +

+implementation of operator /= +

+

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

+ +

+
+
+template<class T>
+ + + + + + + + + +
CDat& CDat< T >::operator%= (const CDat< T > &  x  )  [inline]
+
+
+ +

+implementation of operator %= +

+

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

+ +

+
+
+template<class T>
+ + + + + + + + + +
CDat& CDat< T >::operator|= (const CDat< T > &  x  )  [inline]
+
+
+ +

+implementation of operator |= +

+

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

+ +

+
+
+template<class T>
+ + + + + + + + + +
CDat& CDat< T >::operator &= (const CDat< T > &  x  )  [inline]
+
+
+ +

+implementation of operator &= +

+

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

+ +

+
+
+template<class T>
+ + + + + + + + + +
CDat& CDat< T >::operator^= (const CDat< T > &  x  )  [inline]
+
+
+ +

+implementation of operator ^= +

+

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

+ +

+
+
+template<class T>
+ + + + + + + + +
CDat& CDat< T >::operator++ (  )  [inline]
+
+
+ +

+implementation of operator ++ +

+

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

+ +

+
+
+template<class T>
+ + + + + + + + +
CDat& CDat< T >::operator-- (  )  [inline]
+
+
+ +

+implementation of operator -- +

+

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

+

Friends And Related Function Documentation

+ +
+
+
+template<class T>
+ + + + + + + + + + + + + + + + + + +
std::ostream& operator<< (std::ostream &  stream,
CDat< T >  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
+ +
+

+ +

+
+
+template<class T>
+ + + + + + + + + + + + + + + + + + +
std::istream& operator>> (std::istream &  stream,
CDat< T > &  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

+ +
+
+
+template<class T>
+ + + + +
T CDat< T >::m_value [protected]
+
+
+ +

+internal value 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