From 3563c6dfd0f5f102cb748ecc6ad318601990515e Mon Sep 17 00:00:00 2001 From: manuel Date: Thu, 14 May 2009 18:21:15 +0200 Subject: adding doxygen docs --- ue3/doxygen/classCDatT.html | 879 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 879 insertions(+) create mode 100644 ue3/doxygen/classCDatT.html (limited to 'ue3/doxygen/classCDatT.html') diff --git a/ue3/doxygen/classCDatT.html b/ue3/doxygen/classCDatT.html new file mode 100644 index 0000000..017eda0 --- /dev/null +++ b/ue3/doxygen/classCDatT.html @@ -0,0 +1,879 @@ + + +mycpu: CDatT< T > Class Template Reference + + + + +
+ +
+
+ +
+

CDatT< T > Class Template Reference

#include <cdat.h> +

+ +

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

Public Member Functions

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

Friends

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

Detailed Description

+

template<class T>
+ class CDatT< T >

+ +Datatype template for CCPU and CMem.

Constructor & Destructor Documentation

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

+Default ctor. +

+

Methodname:
CDatT
+
Parameters:
+ + +
- 
+
+
Returns:
-
+
Global variables used:
none
+
Exceptions:
+ + +
bad_alloc 
+
+
Conditions:
none
+ +
+

+ +

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

+Default dtor. +

+

Methodname:
~CDatT
+
Parameters:
+ + +
- 
+
+
Returns:
-
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +
+

+ +

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

+Copy constructor for CDatT. +

+

Methodname:
CDatT
+
Parameters:
+ + +
other reference to CDatT which will be copied
+
+
Returns:
-
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +
+

+ +

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

+Copy constructor for int. +

+

Methodname:
CDatT
+
Parameters:
+ + +
newval new value for CDatT
+
+
Returns:
-
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +
+

+

Member Function Documentation

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

+returns value of CDatT +

+

Methodname:
getValue
+
Parameters:
+ + +
- 
+
+
Returns:
value of CDatT
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +
+

+ +

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

+convert to T +

+

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

+ +

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

+implementation of operator < +

+

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

+ +

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

+implementation of operator == +

+

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

+ +

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

+implementation of operator += +

+

Methodname:
operator+=
+
Parameters:
+ + +
x reference to CDatT
+
+
Returns:
refecence to CDatT
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +
+

+ +

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

+implementation of operator -= +

+

Methodname:
operator-=
+
Parameters:
+ + +
x reference to CDatT
+
+
Returns:
refecence to CDatT
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +
+

+ +

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

+implementation of operator *= +

+

Methodname:
operator*=
+
Parameters:
+ + +
x reference to CDatT
+
+
Returns:
refecence to CDatT
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +
+

+ +

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

+implementation of operator /= +

+

Methodname:
operator/=
+
Parameters:
+ + +
x reference to CDatT
+
+
Returns:
refecence to CDatT
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +
+

+ +

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

+implementation of operator %= +

+

Methodname:
operator%=
+
Parameters:
+ + +
x reference to CDatT
+
+
Returns:
refecence to CDatT
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +
+

+ +

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

+implementation of operator |= +

+

Methodname:
operator|=
+
Parameters:
+ + +
x reference to CDatT
+
+
Returns:
refecence to CDatT
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +
+

+ +

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

+implementation of operator &= +

+

Methodname:
operator&=
+
Parameters:
+ + +
x reference to CDatT
+
+
Returns:
refecence to CDatT
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +
+

+ +

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

+implementation of operator ^= +

+

Methodname:
operator^=
+
Parameters:
+ + +
x reference to CDatT
+
+
Returns:
refecence to CDatT
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +
+

+ +

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

+implementation of operator ++ +

+

Methodname:
operator++
+
Parameters:
+ + +
- 
+
+
Returns:
refecence to CDatT
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +
+

+ +

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

+implementation of operator -- +

+

Methodname:
operator--
+
Parameters:
+ + +
- 
+
+
Returns:
refecence to CDatT
+
Global variables used:
none
+
Exceptions:
+ + +
none 
+
+
Conditions:
none
+ +
+

+

Friends And Related Function Documentation

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

+ +

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

+

The documentation for this class was generated from the following file: +
Generated on Thu May 14 18:19:17 2009 for mycpu by  + +doxygen 1.5.3
+ + -- cgit v1.2.3