org.bytedeco.javacpp

Class SizeTPointer

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.SizeTPointer

All Implemented Interfaces:

AutoCloseable

@Name(value="size_t")
public class SizeTPointer
extends Pointer

The peer class to native pointers and arrays of size_t. All operations take into account the position and limit, when appropriate.

We need this class because the size differs between 32-bit and 64-bit platforms.

Author:

Samuel Audet

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.DeallocatorReference, Pointer.DeallocatorThread, Pointer.NativeDeallocator

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, deallocatorThread, limit, maxBytes, maxPhysicalBytes, maxRetries, position

Constructor Summary

Constructors

Constructor and Description
SizeTPointer()
SizeTPointer(long size) Allocates a native size_t array of the given size.
SizeTPointer(Pointer p)

Method Summary

Modifier and Type	Method and Description
private void	allocateArray(long size)
SizeTPointer	capacity(long capacity) Sets the capacity and returns this.
long	get()
long	get(long i)
SizeTPointer	limit(long limit) Sets the limit and returns this.
SizeTPointer	position(long position) Sets the position and returns this.
SizeTPointer	put(long s)
SizeTPointer	put(long i, long s) Copies the size_t value to the i-th element of a native array.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, calloc, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, hashCode, init, isNull, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, put, realloc, setNull, sizeof, toString, totalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SizeTPointer

public SizeTPointer(long size)

Allocates a native size_t array of the given size.

Parameters:

size - the number of size_t elements to allocate

SizeTPointer

public SizeTPointer()

See Also:

Pointer.Pointer()

SizeTPointer

public SizeTPointer(Pointer p)

See Also:

Pointer.Pointer(Pointer)

Method Detail

allocateArray

private void allocateArray(long size)

position

public SizeTPointer position(long position)

Description copied from class: Pointer

Sets the position and returns this. That makes the array.position(i) statement sort of equivalent to the array[i] statement in C++.

Overrides:

position in class Pointer

Parameters:

position - the new position

Returns:

this

See Also:

Pointer.position(long)

limit

public SizeTPointer limit(long limit)

Description copied from class: Pointer

Sets the limit and returns this. Used to limit the size of an operation on this object.

Overrides:

limit in class Pointer

Parameters:

limit - the new limit

Returns:

this

See Also:

Pointer.limit(long)

capacity

public SizeTPointer capacity(long capacity)

Description copied from class: Pointer

Sets the capacity and returns this. Should not be called more than once after allocation.

Overrides:

capacity in class Pointer

Parameters:

capacity - the new capacity

Returns:

this

See Also:

Pointer.capacity(long)

get

public long get()

Returns:

get(0)

get

@Cast(value="size_t")
public long get(long i)

Returns:

the i-th size_t value of a native array

put

public SizeTPointer put(long s)

Returns:

put(0, s)

put

public SizeTPointer put(long i,
                        long s)

Copies the size_t value to the i-th element of a native array.

Parameters:

i - the index into the array

s - the size_t value to copy

Returns:

this