Package org.robwork.sdurw_sensor

Class CameraCPtr

  • public class CameraCPtr
extends java.lang.Object
    Ptr stores a pointer and optionally takes ownership of the value.

    • Constructor Summary

      Constructors 
      Constructor Description
      CameraCPtr()
      Default constructor yielding a NULL-pointer.
      CameraCPtr​(long cPtr, boolean cMemoryOwn)  
      CameraCPtr​(Camera ptr)
      Do not take ownership of ptr.

      ptr can be null.

      The constructor is implicit on purpose.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Camera __ref__()
      Dereferencing operator.
      void delete()  
      Camera deref()
      The pointer stored in the object.
      boolean equals​(Camera p)  
      static long getCPtr​(CameraCPtr obj)  
      Camera getDeref()
      Member access operator.
      java.lang.String getDescription()
      returns a description of this sensor
      double getGain()
      Get actual gain value.
      Note: If gain is not available then a dummy implementation
      returning -1 is used and an error message is produced.
      java.lang.String getModelInfo()
      returns the camera model information (version, type, size, etc.)
      java.lang.String getName()
      returns the name of this sensor
      SensorModelPtr getSensorModel()
      The frame to which the sensor is attached.

      The frame can be NULL.
      double getShutter()
      Get actual shutter value.
      Note: If shutter is not available then a dummy implementation
      will throw an error message.
      pair_d_d getShutterBounds()
      gets the shutter bounds.
      Note: If shutter is not available then a dummy implementation
      will throw an error message.
      boolean isGainAvailable()
      Check if gain is available.
      boolean isInitialized()
      returns whether this camera is initialized or not.
      boolean isNull()
      checks if the pointer is null
      boolean isShared()
      check if this Ptr has shared ownership or none
      ownership
      boolean isShutterAvailable()
      Check if shutter is available.
      boolean isStarted()
      returns whether this camera is started or not.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • CameraCPtr

        public CameraCPtr​(long cPtr,
                  boolean cMemoryOwn)

      • CameraCPtr

        public CameraCPtr()
        Default constructor yielding a NULL-pointer.

      • CameraCPtr

        public CameraCPtr​(Camera ptr)
        Do not take ownership of ptr.

        ptr can be null.

        The constructor is implicit on purpose.

    • Method Detail

      • getCPtr

        public static long getCPtr​(CameraCPtr obj)

      • delete

        public void delete()

      • deref

        public Camera deref()
        The pointer stored in the object.

      • __ref__

        public Camera __ref__()
        Dereferencing operator.

      • getDeref

        public Camera getDeref()
        Member access operator.

      • equals

        public boolean equals​(Camera p)

      • isShared

        public boolean isShared()
        check if this Ptr has shared ownership or none
        ownership
        Returns:
        true if Ptr has shared ownership, false if it has no ownership.

      • isNull

        public boolean isNull()
        checks if the pointer is null
        Returns:
        Returns true if the pointer is null

      • getModelInfo

        public java.lang.String getModelInfo()
        returns the camera model information (version, type, size, etc.)
        Returns:
        camera model information

      • isInitialized

        public boolean isInitialized()
        returns whether this camera is initialized or not.
        Returns:
        true if intialized, false otherwise

      • isStarted

        public boolean isStarted()
        returns whether this camera is started or not.
        Returns:
        true if started, false otherwise

      • isShutterAvailable

        public boolean isShutterAvailable()
        Check if shutter is available.
        Returns:
        True if shutter is available

      • getShutter

        public double getShutter()
        Get actual shutter value.
        Note: If shutter is not available then a dummy implementation
        will throw an error message.
        Returns:
        shutter value in micro-seconds.

      • getShutterBounds

        public pair_d_d getShutterBounds()
        gets the shutter bounds.
        Note: If shutter is not available then a dummy implementation
        will throw an error message.
        Returns:
        first value is the min bound and second value is the max bound

      • isGainAvailable

        public boolean isGainAvailable()
        Check if gain is available.
        Returns:
        True if zoom is available

      • getGain

        public double getGain()
        Get actual gain value.
        Note: If gain is not available then a dummy implementation
        returning -1 is used and an error message is produced.
        Returns:
        Gain value.

      • getName

        public java.lang.String getName()
        returns the name of this sensor
        Returns:
        name of sensor

      • getDescription

        public java.lang.String getDescription()
        returns a description of this sensor
        Returns:
        reference to this sensors description

      • getSensorModel

        public SensorModelPtr getSensorModel()
        The frame to which the sensor is attached.

        The frame can be NULL.