org.bytedeco.javacpp

Class FlyCapture2.Error

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.FlyCapture2.Error

Enclosing class:

FlyCapture2

@Namespace(value="FlyCapture2")
 @NoOffset
public static class FlyCapture2.Error
extends Pointer

The Error object represents an error that is returned from the library. Overloaded operators allow comparisons against other Error objects or the ErrorType enumeration.

Nested Class Summary

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

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Error() Default constructor.
Error(FlyCapture2.Error error) Copy constructor.
Error(int size) Native array allocator.
Error(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
BytePointer	CollectSupportInformation() Retrieve the support information.
boolean	equals(FlyCapture2.Error error) Equality operator.
boolean	equals(int errorType) Equality operator.
BytePointer	GetBuildDate() Retrieve the build date of the file where the error originated.
FlyCapture2.Error	GetCause() Get the error which caused this error.
BytePointer	GetDescription() Retrieve the top level description of the error that occurred.
BytePointer	GetFilename() Retrieve the source filename where the error originated.
int	GetLine() Retrieve the line number where the error originated.
int	GetType() Retrieve the ErrorType of the error.
boolean	notEquals(FlyCapture2.Error error) Inequality operator.
boolean	notEquals(int errorType) Inequality operator.
FlyCapture2.Error	position(int position)
void	PrintErrorTrace() Print a formatted log trace to stderr.
FlyCapture2.Error	put(FlyCapture2.Error error) Assignment operator.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, capacity, capacity, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, hashCode, isNull, limit, limit, memchr, memcmp, memcpy, memmove, memset, offsetof, position, put, setNull, sizeof, toString, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

Error

public Error(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

Error

public Error(int size)

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

Error

public Error()

Default constructor.

Error

public Error(@Const @ByRef
             FlyCapture2.Error error)

Copy constructor.

Method Detail

position

public FlyCapture2.Error position(int position)

Overrides:

position in class Pointer

put

@ByRef
 @Name(value="operator=")
public FlyCapture2.Error put(@Const @ByRef
                                                              FlyCapture2.Error error)

Assignment operator.

equals

@Cast(value="bool")
 @Name(value="operator==")
public boolean equals(@Const @ByRef
                                                                     FlyCapture2.Error error)

Equality operator.

equals

@Cast(value="bool")
 @Name(value="operator==")
public boolean equals(@Cast(value="const FlyCapture2::ErrorType")
                                                                     int errorType)

Equality operator. This overloaded operator compares the ErrorType of the Error against the specified ErrorType.

notEquals

@Cast(value="bool")
 @Name(value="operator!=")
public boolean notEquals(@Const @ByRef
                                                                        FlyCapture2.Error error)

Inequality operator.

notEquals

@Cast(value="bool")
 @Name(value="operator!=")
public boolean notEquals(@Cast(value="const FlyCapture2::ErrorType")
                                                                        int errorType)

Inequality operator. This overloaded operator compares the ErrorType of the Error against the specified ErrorType.

GetType

@Cast(value="FlyCapture2::ErrorType")
public int GetType()

Retrieve the ErrorType of the error.

Returns:

The ErrorType of the error.

GetDescription

@Cast(value="const char*")
public BytePointer GetDescription()

Retrieve the top level description of the error that occurred.

Returns:

A string with the error description.

GetLine

@Cast(value="unsigned int")
public int GetLine()

Retrieve the line number where the error originated.

Returns:

The line number.

GetFilename

@Cast(value="const char*")
public BytePointer GetFilename()

Retrieve the source filename where the error originated.

Returns:

A string with the file name.

GetCause

@ByVal
public FlyCapture2.Error GetCause()

Get the error which caused this error.

Returns:

An error object representing the cause of this error.

GetBuildDate

@Cast(value="const char*")
public BytePointer GetBuildDate()

Retrieve the build date of the file where the error originated.

Returns:

A string with the build date and time.

CollectSupportInformation

@Cast(value="const char*")
public BytePointer CollectSupportInformation()

Retrieve the support information. It is not implemented in this release.

Returns:

A string containing support information.

PrintErrorTrace

public void PrintErrorTrace()

Print a formatted log trace to stderr.