DX::IDXFileInt32 Struct Reference

#include <IDXFileInt32.h>

Inherits DX::IDXFile.

Collaboration diagram for DX::IDXFileInt32:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual uint DXMCALL GetCount () const =0
virtual DXError DXMCALL Get (uint index, IntPtr out) const =0
virtual DXError DXMCALL Get (IntArray out) const =0
virtual DXError DXMCALL Get (uint start, uint count, IntArray out) const =0
virtual DXError DXMCALL Set (uint index, int value)=0
virtual DXError DXMCALL Set (IntArray values, uint length)=0
virtual DXError DXMCALL Add (int value)=0
virtual DXError DXMCALL Add (IntArray values, uint length)=0
virtual DXError DXMCALL Add (IntArray value, uint length, uint start)=0
virtual DXError DXMCALL Remove (uint index)=0
virtual DXError DXMCALL Remove (uint start, uint count)=0


Detailed Description

File for storing ints.

Member Function Documentation

virtual DXError DXMCALL DX::IDXFileInt32::Add ( IntArray  value,
uint  length,
uint  start 
) [pure virtual]

Add the data in the int array specified to any point in the data.

Parameters:
value A int array to copy data from.
length The amount of data to copy.
start The point to start adding data.
Returns:
Error_NullParam if value was null.
Error_OutOfRange if start was greater than GetCount.

virtual DXError DXMCALL DX::IDXFileInt32::Add ( IntArray  values,
uint  length 
) [pure virtual]

Add the data in the int array specified to the end of the data.

Parameters:
values A int array to copy data from.
length A uint which is the number of ints to copy from the array passed in.
Returns:
Error_NullParam if values was null.
Error_Success if the values were appended,

virtual DXError DXMCALL DX::IDXFileInt32::Add ( int  value  )  [pure virtual]

Add the value to the end of the data.

Parameters:
value The int to add. always.

virtual DXError DXMCALL DX::IDXFileInt32::Get ( uint  start,
uint  count,
IntArray  out 
) const [pure virtual]

Get a group of ints.

Parameters:
start The index of the first element to retrieve.
count The number of elements to retrieve.
out A user allocated array of ints of length at least count.
Returns:
Error_NullParam if out was null.
Error_OutOfRange if start was out of range.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXFileInt32::Get ( IntArray  out  )  const [pure virtual]

Get all the ints.

Parameters:
out A pointer to a user allocated array of ints. Must be of length greater than or equal to GetCount.
Returns:
Error_NullParam if out was null.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXFileInt32::Get ( uint  index,
IntPtr  out 
) const [pure virtual]

Get the int at the specified index.

Parameters:
index The index of the int to retrieve.
out A pointer to a int where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_OutOfRange if index was out of range.
Error_Success if the result was stored in out.

virtual uint DXMCALL DX::IDXFileInt32::GetCount (  )  const [pure virtual]

Get the number of ints in this file.

virtual DXError DXMCALL DX::IDXFileInt32::Remove ( uint  start,
uint  count 
) [pure virtual]

Remove a range of elements from the file.

Parameters:
start The index of the first element to remove.
count The number of elements to remove.
Returns:
Error_OutOfRange if start was out of range.
Error_Success if the element was removed.

virtual DXError DXMCALL DX::IDXFileInt32::Remove ( uint  index  )  [pure virtual]

Remove the element at the specified index.

Parameters:
index The index of the element to remove.
Returns:
Error_OutOfRange if index was out of range.
Error_Success if the element was removed.

virtual DXError DXMCALL DX::IDXFileInt32::Set ( IntArray  values,
uint  length 
) [pure virtual]

Replace all the values in the array with the values in the int array passed in.

Parameters:
values An array of ints.
length The number of ints to copy from the array.
Returns:
Error_NullParam if values was null.
Error_Success if the values were updated.

virtual DXError DXMCALL DX::IDXFileInt32::Set ( uint  index,
int  value 
) [pure virtual]

Set the int at the specified index.

Parameters:
index The index of the int to set.
value The value to set the int to.
Returns:
Error_OutOfRange if index was out of range.
Error_Success if the int was updated.


Generated on Wed Jun 17 17:24:50 2009 for DXMesh API by  doxygen 1.5.7.1