org.bytedeco.javacpp

Class BoolPointer

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.BoolPointer

All Implemented Interfaces:

AutoCloseable

@Name(value="bool")
public class BoolPointer
extends Pointer

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

We need this class because C++ does not define the size of the bool type.

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
BoolPointer()
BoolPointer(long size) Allocates a native bool array of the given size.
BoolPointer(Pointer p)

Method Summary

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

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, 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, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

BoolPointer

public BoolPointer(long size)

Allocates a native bool array of the given size.

Parameters:

size - the number of bool elements to allocate

BoolPointer

public BoolPointer()

See Also:

Pointer.Pointer()

BoolPointer

public BoolPointer(Pointer p)

See Also:

Pointer.Pointer(Pointer)

Method Detail

allocateArray

private void allocateArray(long size)

position

public BoolPointer 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 BoolPointer 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 BoolPointer 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 boolean get()

Returns:

get(0)

get

@Cast(value="bool")
public boolean get(long i)

Parameters:

i -

Returns:

the i-th bool value of a native array

put

public BoolPointer put(boolean b)

Returns:

put(0, b)

put

public BoolPointer put(long i,
                       boolean b)

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

Parameters:

i - the index into the array

b - the bool value to copy

Returns:

this