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::Array< T > Class Template Reference

#include <igtlNDArrayMessage.h>

Inheritance diagram for igtl::Array< T >:
Inheritance graph
[legend]
Collaboration diagram for igtl::Array< T >:
Collaboration graph
[legend]

Public Types

typedef std::vector< igtlUint16 > IndexType
 

Public Member Functions

int GetDimension ()
 
void * GetRawArray ()
 
igtlUint64 GetRawArraySize ()
 
IndexType GetSize ()
 
int GetValue (IndexType index, T &value)
 
int SetArray (void *array)
 
int SetSize (IndexType size)
 
int SetValue (IndexType index, T value)
 

Protected Member Functions

igtlUint32 Get1DIndex (IndexType index)
 
virtual int GetElementSize ()
 
igtlUint32 GetNumberOfElements ()
 

Detailed Description

template<typename T>
class igtl::Array< T >

Definition at line 87 of file igtlNDArrayMessage.h.

Member Typedef Documentation

◆ IndexType

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

Vector type for an index of N-D array.

Definition at line 35 of file igtlNDArrayMessage.h.

Member Function Documentation

◆ Get1DIndex()

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

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 ( )
inlineinherited

Gets the dimension of the N-D array.

Definition at line 50 of file igtlNDArrayMessage.h.

◆ GetElementSize()

template<typename T >
virtual int igtl::Array< T >::GetElementSize ( )
inlineprotectedvirtual

Gets the size of elements (e.g. 1 byte in case of 8-bit integer)

Implements igtl::ArrayBase.

Definition at line 117 of file igtlNDArrayMessage.h.

◆ GetNumberOfElements()

igtlUint32 igtl::ArrayBase::GetNumberOfElements ( )
protectedinherited

Gets the number of elements in the array.

◆ GetRawArray()

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

Gets the raw byte array stored in the class.

Definition at line 60 of file igtlNDArrayMessage.h.

◆ GetRawArraySize()

igtlUint64 igtl::ArrayBase::GetRawArraySize ( )
inherited

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

◆ GetSize()

IndexType igtl::ArrayBase::GetSize ( )
inlineinherited

Gets the size of the N-D array.

Definition at line 47 of file igtlNDArrayMessage.h.

◆ GetValue()

template<typename T >
int igtl::Array< T >::GetValue ( IndexType  index,
T &  value 
)
inline

Gets a value of the element specified by 'index'.

Definition at line 103 of file igtlNDArrayMessage.h.

◆ SetArray()

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

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)
inherited

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

◆ SetValue()

template<typename T >
int igtl::Array< T >::SetValue ( IndexType  index,
value 
)
inline

Sets a value of the element specified by 'index'.

Definition at line 91 of file igtlNDArrayMessage.h.


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