org.bytedeco.depthai

Class Path

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.depthai.Path

All Implemented Interfaces:

AutoCloseable

@Namespace(value="dai")
 @NoOffset
 @Properties(inherit=depthai.class)
public class Path
extends Pointer

\brief Represents paths on a filesystem; accepts utf-8, Windows utf-16 wchar_t, or std::filesystem::path. It is suitable for direct use with OS APIs. Features are limited to character-set conversion of paths. It is not intended as a full replacement for std::filesystem::path

Nested Class Summary

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

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Path() character used by native-encoding of filesystem
Path(ByteBuffer source)
Path(BytePointer source) \brief Construct Path object from source.
Path(CharPointer source) \brief Construct Path object from source.
Path(IntPointer source)
Path(long size) Native array allocator.
Path(Path arg0)
Path(Pointer p) Pointer cast constructor.
Path(String source)

Method Summary

Modifier and Type	Method and Description
BytePointer	_native() \brief Returns native-encoding string by const reference, suitable for use with OS APIs
BytePointer	asBytePointer() \brief Implicitly convert to native-encoding string, suitable for use with OS APIs
boolean	empty() \brief Observes if path is empty (contains no string/folders/filename)
Path	getPointer(long i)
Path	position(long position)
Path	put(Path arg0)
BytePointer	string() \brief Get path in narrow multibyte representation in the current C locale.
BytePointer	u8string() \brief Get path in utf-8.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

Path

public Path(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Path

public Path(long size)

Native array allocator. Access with Pointer.position(long).

Path

public Path()

character used by native-encoding of filesystem

Path

public Path(@Const @ByRef
            Path arg0)

Path

public Path(@StdString
            BytePointer source)

\brief Construct Path object from source.

Parameters:

source - native-encoding character sequence; no conversion

Path

public Path(@StdString
            ByteBuffer source)

Path

public Path(@StdString
            String source)

Path

public Path(@Cast(value="const dai::Path::value_type*")
            CharPointer source)

\brief Construct Path object from source.

Parameters:

source - pointer to null-terminated native-encoding character sequence; no conversion

Path

public Path(@Cast(value="const dai::Path::value_type*")
            IntPointer source)

Method Detail

position

public Path position(long position)

Overrides:

position in class Pointer

getPointer

public Path getPointer(long i)

Overrides:

getPointer in class Pointer

put

@ByRef
 @Name(value="operator =")
public Path put(@Const @ByRef
                                                  Path arg0)

string

@StdString
public BytePointer string()

\brief Get path in narrow multibyte representation in the current C locale. Will throw exception if there is no valid conversion. Could be used to get the narrow ascii representation.

Returns:

std::string in narrow multibyte representation

u8string

@StdString
public BytePointer u8string()

\brief Get path in utf-8. Will throw exception if there is no valid conversion.

Returns:

std::string in utf-8

asBytePointer

@Name(value="operator std::basic_string<dai::Path::value_type>")
 @StdString
 @NoException
public BytePointer asBytePointer()

\brief Implicitly convert to native-encoding string, suitable for use with OS APIs

Returns:

std::string of utf-8 on most OSs, std::wstring of utf-16 on Windows

_native

@StdString
 @Name(value="native")
 @NoException
public BytePointer _native()

\brief Returns native-encoding string by const reference, suitable for use with OS APIs

Returns:

const std::string& of utf-8 on most OSs, const std::wstring& of utf-16 on Windows

empty

@Cast(value="bool")
 @NoException
public boolean empty()

\brief Observes if path is empty (contains no string/folders/filename)

Returns:

bool true if the path is empty, false otherwise