Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  
Public Types | Public Member Functions | Protected Member Functions | List of all members
igtl::ArrayBase Class Referenceabstract

#include <igtlNDArrayMessage.h>

Inheritance diagram for igtl::ArrayBase:
Inheritance graph
[legend]

Public Types

typedef std::vector< igtlUint16 > IndexType
 

Public Member Functions

int GetDimension ()
 
void * GetRawArray ()
 
igtlUint64 GetRawArraySize ()
 
IndexType GetSize ()
 
int SetArray (void *array)
 
int SetSize (IndexType size)
 

Protected Member Functions

 ArrayBase ()
 
igtlUint32 Get1DIndex (IndexType index)
 
virtual int GetElementSize ()=0
 
igtlUint32 GetNumberOfElements ()
 
 ~ArrayBase ()
 

Detailed Description

Definition at line 30 of file igtlNDArrayMessage.h.

Member Typedef Documentation

◆ IndexType

typedef std::vector<igtlUint16> igtl::ArrayBase::IndexType

Vector type for an index of N-D array.

Definition at line 35 of file igtlNDArrayMessage.h.

Constructor & Destructor Documentation

◆ ArrayBase()

igtl::ArrayBase::ArrayBase ( )
protected

◆ ~ArrayBase()

igtl::ArrayBase::~ArrayBase ( )
protected

Member Function Documentation

◆ Get1DIndex()

igtlUint32 igtl::ArrayBase::Get1DIndex ( IndexType  index)
protected

Returns the 1-D index of the element specified by 'index'. This function is used to calculate the index of the element in the raw array.

◆ GetDimension()

int igtl::ArrayBase::GetDimension ( )
inline

Gets the dimension of the N-D array.

Definition at line 50 of file igtlNDArrayMessage.h.

◆ GetElementSize()

virtual int igtl::ArrayBase::GetElementSize ( )
protectedpure virtual

Gets the size of a element of the array.

Implemented in igtl::Array< T >.

◆ GetNumberOfElements()

igtlUint32 igtl::ArrayBase::GetNumberOfElements ( )
protected

Gets the number of elements in the array.

◆ GetRawArray()

void* igtl::ArrayBase::GetRawArray ( )
inline

Gets the raw byte array stored in the class.

Definition at line 60 of file igtlNDArrayMessage.h.

◆ GetRawArraySize()

igtlUint64 igtl::ArrayBase::GetRawArraySize ( )

Gets the size of the raw byte array stored in the class.

◆ GetSize()

IndexType igtl::ArrayBase::GetSize ( )
inline

Gets the size of the N-D array.

Definition at line 47 of file igtlNDArrayMessage.h.

◆ SetArray()

int igtl::ArrayBase::SetArray ( void *  array)

Sets an array from a byte array. Size and dimension must be specified prior to calling the SetArray() function.

◆ SetSize()

int igtl::ArrayBase::SetSize ( IndexType  size)

Sets the size of the N-D array. Returns non-zero value, if success.


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

Generated for OpenIGTLink by Doxygen 1.8.13 written by Dimitri van Heesch, © 1997-2012