Package org.bytedeco.hdf5

Class PropList

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.hdf5.IdComponent

org.bytedeco.hdf5.PropList

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

DSetMemXferPropList, FileAccPropList, FileCreatPropList, LinkAccPropList, LinkCreatPropList, ObjCreatPropList

@Namespace("H5")
@NoOffset
@Properties(inherit=hdf5.class)
public class PropList
extends IdComponent

\class PropList \brief Class PropList inherits from IdComponent and provides wrappers for the HDF5 generic property list.

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	Description
PropList()
PropList(long plist_id)
PropList(PropList original)
PropList(Pointer p)	Pointer cast constructor.

Method Summary

Modifier and Type	Method	Description
void	_close()
long	_getClass()
void	closeClass()
void	copy(PropList like_plist)
void	copyProp(PropList dest, String name)
void	copyProp(PropList dest, PropList src, String name)
void	copyProp(PropList dest, PropList src, BytePointer name)
void	copyProp(PropList dest, BytePointer name)
static PropList	DEFAULT()	\brief Default property list
static void	deleteConstants()
boolean	equals(PropList rhs)
BytePointer	fromClass()	\brief Returns this class name.
BytePointer	getClassName()
PropList	getClassParent()
long	getId()
long	getNumProps()
String	getProperty(String name)
void	getProperty(String name, Pointer value)
BytePointer	getProperty(BytePointer name)
void	getProperty(BytePointer name, Pointer value)
long	getPropSize(String name)
long	getPropSize(BytePointer name)
boolean	isAClass(PropList prop_class)
boolean	propExist(String name)
boolean	propExist(BytePointer name)	Query the existence of a property in a property object.
PropList	put(PropList rhs)
void	removeProp(String name)
void	removeProp(BytePointer name)
void	setProperty(String name, String charptr)
void	setProperty(String name, BytePointer strg)
void	setProperty(String name, Pointer value)
void	setProperty(BytePointer name, BytePointer charptr)
void	setProperty(BytePointer name, Pointer value)

Methods inherited from class org.bytedeco.hdf5.IdComponent

decRefCount, decRefCount, getCounter, getCounter, getHDFObjType, getHDFObjType, getNumMembers, incRefCount, incRefCount, inMemFunc, inMemFunc, isValid, put, setId, typeExists

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, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, 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

PropList

public PropList(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

PropList

public PropList(@Cast("const hid_t")
                long plist_id)

PropList

public PropList()

PropList

public PropList(@Const @ByRef
                PropList original)

Method Detail

DEFAULT

@MemberGetter
@Const
@ByRef
public static PropList DEFAULT()

\brief Default property list

put

@ByRef
@Name("operator =")
public PropList put(@Const @ByRef
                    PropList rhs)

equals

@Cast("bool")
@Name("operator ==")
public boolean equals(@Const @ByRef
                      PropList rhs)

_close

@Name("close")
public void _close()

Overrides:

_close in class IdComponent

closeClass

public void closeClass()

copy

public void copy(@Const @ByRef
                 PropList like_plist)

copyProp

public void copyProp(@ByRef
                     PropList dest,
                     @Cast("const char*")
                     BytePointer name)

copyProp

public void copyProp(@ByRef
                     PropList dest,
                     String name)

copyProp

public void copyProp(@ByRef
                     PropList dest,
                     @ByRef
                     PropList src,
                     @Cast("const char*")
                     BytePointer name)

copyProp

public void copyProp(@ByRef
                     PropList dest,
                     @ByRef
                     PropList src,
                     String name)

_getClass

@Cast("hid_t")
@Name("getClass")
public long _getClass()

getClassName

@StdString
public BytePointer getClassName()

getClassParent

@ByVal
public PropList getClassParent()

getNumProps

@Cast("size_t")
public long getNumProps()

getProperty

public void getProperty(@Cast("const char*")
                        BytePointer name,
                        Pointer value)

getProperty

public void getProperty(String name,
                        Pointer value)

getProperty

@StdString
public BytePointer getProperty(@Cast("const char*")
                               BytePointer name)

getProperty

@StdString
public String getProperty(String name)

setProperty

public void setProperty(@Cast("const char*")
                        BytePointer name,
                        @Cast("const char*")
                        BytePointer charptr)

setProperty

public void setProperty(String name,
                        String charptr)

setProperty

public void setProperty(@Cast("const char*")
                        BytePointer name,
                        @Const
                        Pointer value)

setProperty

public void setProperty(String name,
                        @Const
                        Pointer value)

setProperty

public void setProperty(String name,
                        @StdString @ByRef
                        BytePointer strg)

getPropSize

@Cast("size_t")
public long getPropSize(@Cast("const char*")
                        BytePointer name)

getPropSize

@Cast("size_t")
public long getPropSize(String name)

isAClass

@Cast("bool")
public boolean isAClass(@Const @ByRef
                        PropList prop_class)

propExist

@Cast("bool")
public boolean propExist(@Cast("const char*")
                         BytePointer name)

Query the existence of a property in a property object.

propExist

@Cast("bool")
public boolean propExist(String name)

removeProp

public void removeProp(@Cast("const char*")
                       BytePointer name)

removeProp

public void removeProp(String name)

fromClass

@StdString
public BytePointer fromClass()

\brief Returns this class name.

Overrides:

fromClass in class IdComponent

getId

@Cast("hid_t")
public long getId()

Overrides:

getId in class IdComponent

deleteConstants

public static void deleteConstants()