Xrtti::Array Class Reference

#include <Xrtti.h>

Inheritance diagram for Xrtti::Array:

Xrtti::ArrayOrPointer

List of all members.

Public Member Functions

virtual ~Array ()
bool operator== (const ArrayOrPointer &other) const
bool operator!= (const ArrayOrPointer &other) const
bool operator== (const Array &other) const
bool operator!= (const Array &other) const
virtual Type GetType () const
virtual bool IsUnbounded () const =0
virtual u32 GetElementCount () const =0


Detailed Description

************************************************************************** Array describes the element count of a single array dimension of a Type.

Constructor & Destructor Documentation

virtual Xrtti::Array::~Array (  )  [inline, virtual]


Member Function Documentation

bool Xrtti::Array::operator== ( const ArrayOrPointer other  )  const [inline]

Equality operator - returns true if this object is "functionally equivalent" to [other]. The two objects don't have to be exactly identical, but do have to be identical in every meaningful way. Note also that this doesn't test for equality of any base class members; it is a test only at this level of the inheritence hierarcy. To test if an object is completely equals, including for all of its subclasses defined in the Xrtti hierarchy, you must cast this class to its most derived class and call that method.

Parameters:
other is the other object to compare against
Returns:
true if this object is functionally equal to the other, false if not

References Xrtti::ArrayOrPointer::GetType().

bool Xrtti::Array::operator!= ( const ArrayOrPointer other  )  const [inline]

Inequality operator - returns false when the == operator would return true, and vice versa.

Parameters:
other is the other object to compare against
Returns:
false when the == operator would return true, and vice versa.

bool Xrtti::Array::operator== ( const Array other  )  const

Equality operator - returns true if this object is "functionally equivalent" to [other]. The two objects don't have to be exactly identical, but do have to be identical in every meaningful way. Note also that this doesn't test for equality of any base class members; it is a test only at this level of the inheritence hierarcy. To test if an object is completely equals, including for all of its subclasses defined in the Xrtti hierarchy, you must cast this class to its most derived class and call that method.

Parameters:
other is the other object to compare against
Returns:
true if this object is functionally equal to the other, false if not

bool Xrtti::Array::operator!= ( const Array other  )  const [inline]

Inequality operator - returns false when the == operator would return true, and vice versa.

Parameters:
other is the other object to compare against
Returns:
false when the == operator would return true, and vice versa.

virtual Type Xrtti::Array::GetType (  )  const [inline, virtual]

Returns the type of this ArrayOrPointer, which is Type_Array.

Returns:
the type of this ArrayOrPointer, which is Type_Array.

Implements Xrtti::ArrayOrPointer.

virtual bool Xrtti::Array::IsUnbounded (  )  const [pure virtual]

If this returns true, the array dimension is of unbounded size; it may have any element count. If this returns false, the element count is fixed and specified, and can be obtained by calling GetElementCount().

Returns:
true if the array dimension is of unbounded size

virtual u32 Xrtti::Array::GetElementCount (  )  const [pure virtual]

If the array dimension is not unbounded, then this specifies the element count of the array dimension. The index of the last element of the of the array is at this value minus one.

Returns:
the element count of the array dimension


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

Generated on Sat Feb 14 22:48:49 2009 by  doxygen 1.5.7.1