Package de.pco.sdk

Class Sdk

java.lang.Object
de.pco.sdk.Sdk
public class Sdk
extends Object
Class that wraps for Java the basic C functions of the pco.sdk
Author:
PCO

  • Constructor Details

    • Sdk

      public Sdk()
      Constructor, loads the necessary DLLs

  • Method Details

    • getCameraHandle

      public long getCameraHandle()
      C pointer of the camera, currently opened in this Sdk class by openCamera or openCameraEx functions
      Returns:
      camera handle

    • getLastCallWarning

      public Warning getLastCallWarning()
      If the last call of a native function of the current Sdk object returned a Warning, it can be obtained from here
      Returns:

    • openCamera

      public long openCamera() throws PcoException
      Wrapped PCO_OpenCamera function. On success, it sets the cameraHandle private variable of the current Sdk object and also returns this cameraHandle
      Returns:
      Handle to the opened camera to be used in the constructor of the Recorder class
      Throws:
      PcoException

    • openCameraEx

      public void openCameraEx​(Interface iface, int cameraNumber) throws PcoException
      Wrapped PCO_OpenCameraEx function. On success, it sets the cameraHandle private variable of the current Sdk object.
      Parameters:
      iface - Desired interface to open camera on
      cameraNumber - Index on the selected interface that will be associated with the opened camera (this index must not be associated previously).
      Throws:
      PcoException

    • closeCamera

      public void closeCamera() throws PcoException
      Wrapped PCO_CloseCamera function. Sets private cameraHandle variable of this Sdk object to zero.
      Throws:
      PcoException

    • resetSettingsToDefault

      public void resetSettingsToDefault() throws PcoException
      Wrapped PCO_ResetSettingsToDefault function.
      Throws:
      PcoException

    • resetLib

      public void resetLib() throws PcoException
      Wrapped PCO_ResetLib function.
      Throws:
      PcoException

    • armCamera

      public void armCamera() throws PcoException
      Wrapped PCO_ArmCamera function.
      Throws:
      PcoException

    • getRecordingState

      public OnOffEnum getRecordingState() throws PcoException
      Wrapped PCO_GetRecordingState function.
      Returns:
      Throws:
      PcoException

    • setRecordingState

      public void setRecordingState​(OnOffEnum state) throws PcoException
      Wrapped PCO_SetRecordingState function.
      Parameters:
      state -
      Throws:
      PcoException

    • getBitAlignment

      public BitAlignment getBitAlignment() throws PcoException
      Wrapped PCO_GetBitAlignment function.
      Returns:
      Throws:
      PcoException

    • setBitAlignment

      public void setBitAlignment​(BitAlignment bitAlignment) throws PcoException
      Wrapped PCO_SetBitAlignment function.
      Parameters:
      bitAlignment -
      Throws:
      PcoException

    • getMetaDataMode

      public OnOffEnum getMetaDataMode() throws PcoException
      Wrapped PCO_GetMetaDataMode function.
      Returns:
      Throws:
      PcoException

    • setMetaDataMode

      public void setMetaDataMode​(OnOffEnum mode) throws PcoException
      Wrapped PCO_SetMetaDataMode function.
      Parameters:
      mode -
      Throws:
      PcoException

    • getTimestampMode

      public TimestampMode getTimestampMode() throws PcoException
      Wrapped PCO_GetTimestampMode function.
      Returns:
      Throws:
      PcoException

    • setTimestampMode

      public void setTimestampMode​(TimestampMode mode) throws PcoException
      Wrapped PCO_SetTimestampMode function.
      Parameters:
      mode -
      Throws:
      PcoException

    • getDelayExposureTime

      public GetDelayExposureTimeReturn getDelayExposureTime() throws PcoException
      Wrapped PCO_GetDelayExposureTime function.
      Returns:
      Throws:
      PcoException

    • setDelayExposureTime

      public void setDelayExposureTime​(long delay, long exposure, Timebase delayTimebase, Timebase exposureTimebase) throws PcoException
      Wrapped PCO_SetDelayExposureTime function.
      Parameters:
      delay -
      exposure -
      delayTimebase -
      exposureTimebase -
      Throws:
      PcoException

    • getRoi

      public Roi getRoi() throws PcoException
      Wrapped PCO_GetRoi function.
      Returns:
      Throws:
      PcoException

    • setRoi

      public void setRoi​(int x0, int y0, int x1, int y1) throws PcoException
      Wrapped PCO_SetRoi function.
      Throws:
      PcoException

    • getDoubleImageMode

      public OnOffEnum getDoubleImageMode() throws PcoException
      Wrapped PCO_GetDoubleImageMode function.
      Returns:
      Throws:
      PcoException

    • setDoubleImageMode

      public void setDoubleImageMode​(OnOffEnum doubleImage) throws PcoException
      Wrapped PCO_SetDoubleImageMode function.
      Throws:
      PcoException

    • getAcquireMode

      public AcquireMode getAcquireMode() throws PcoException
      Wrapped PCO_GetAcquireMode function.
      Returns:
      Throws:
      PcoException

    • setAcquireMode

      public void setAcquireMode​(AcquireMode acquireMode) throws PcoException
      Wrapped PCO_SetAcquireMode function.
      Throws:
      PcoException

    • getTriggerMode

      public TriggerMode getTriggerMode() throws PcoException
      Wrapped PCO_GetTriggerMode function.
      Returns:
      Throws:
      PcoException

    • setTriggerMode

      public void setTriggerMode​(TriggerMode triggerMode) throws PcoException
      Wrapped PCO_SetTriggerMode function.
      Throws:
      PcoException

    • getBinning

      public Binning getBinning() throws PcoException
      Wrapped PCO_GetBinning function.
      Returns:
      Throws:
      PcoException

    • setBinning

      public void setBinning​(byte binningX, byte binningY) throws PcoException
      Wrapped PCO_SetBinning function.
      Throws:
      PcoException

    • getSizes

      public GetSizesReturn getSizes() throws PcoException
      Wrapped PCO_GetSizes function.
      Returns:
      Throws:
      PcoException

    • getCameraDescription

      public PcoDescription getCameraDescription() throws PcoException
      Wrapped PCO_GetCameraDescription function.
      Returns:
      Throws:
      PcoException

    • getCameraType

      public GetCameraTypeReturn getCameraType() throws PcoException
      Wrapped PCO_GetCameraType function.
      Returns:
      Throws:
      PcoException

    • getCameraHealthStatus

      public GetCameraHealthStatusReturn getCameraHealthStatus() throws PcoException
      Wrapped PCO_GetCameraHealthStatus function.
      Returns:
      Throws:
      PcoException

    • getTemperature

      public GetTemperatureReturn getTemperature() throws PcoException
      Wrapped PCO_GetTemperature function.
      Returns:
      Throws:
      PcoException

    • getCameraName

      public String getCameraName() throws PcoException
      Wrapped PCO_GetCameraName function.
      Returns:
      Throws:
      PcoException

    • getPixelRate

      public long getPixelRate() throws PcoException
      Wrapped PCO_GetPixelRate function.
      Returns:
      Throws:
      PcoException

    • setPixelRate

      public void setPixelRate​(long pixelRate) throws PcoException
      Wrapped PCO_SetPixelRate function.
      Throws:
      PcoException

    • finalize

      protected void finalize() throws Throwable
      Overrides:
      finalize in class Object
      Throws:
      Throwable

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals​(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object