Class SimulatedScanner2DPtr


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

      • SimulatedScanner2DPtr

        public SimulatedScanner2DPtr​(long cPtr,
                                     boolean cMemoryOwn)
      • SimulatedScanner2DPtr

        public SimulatedScanner2DPtr()
        Default constructor yielding a NULL-pointer.
      • SimulatedScanner2DPtr

        public SimulatedScanner2DPtr​(SimulatedScanner2D ptr)
        Do not take ownership of ptr.

        ptr can be null.

        The constructor is implicit on purpose.
    • Method Detail

      • delete

        public void delete()
      • 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
      • setFrameRate

        public void setFrameRate​(double rate)
        set the framerate in frames per sec.
        Parameters:
        rate - [in] frames per sec
      • open

        public void open()
      • isOpen

        public boolean isOpen()
      • close

        public void close()
      • acquire

        public void acquire()
      • isScanReady

        public boolean isScanReady()
      • getFrameRate

        public double getFrameRate()
      • reset

        public void reset​(State state)
      • getScanner2DSensor

        public Scanner2DPtr getScanner2DSensor​(Simulator instance)
        returns a handle to what represents a statefull interface.
        The handle will be locked to the simulator
        Returns:
      • getAngularRange

        public double getAngularRange()
      • getMeasurementCount

        public long getMeasurementCount()
      • getName

        public java.lang.String getName()
        get name of this simulated sensor
      • getFrame

        public Frame getFrame()
        get frame that this sensor is attached to.
        Returns:
        frame
      • getSensorModel

        public SensorModelPtr getSensorModel()
        get the sensor model of this simulated sensor.
      • getSensorHandle

        public SensorPtr getSensorHandle​(SimulatorPtr sim)
        get a handle to controlling an instance of the simulated sensor in a specific
        simulator
        Parameters:
        sim - [in] the simulator in which the handle is active
      • registerIn

        public void registerIn​(State state)
        initialize this stateless data to a specific state
        Parameters:
        state - [in] the state in which to register the data.

        Note: the data will be registered in the state structure of the state
        and any copies or other instances of the state will therefore also
        contain the added states.
      • registerIn

        public void registerIn​(StateStructurePtr state)
        register this stateless object in a statestructure.
      • unregister

        public void unregister()
        unregisters all state data of this stateless object
      • getStateStructure

        public StateStructurePtr getStateStructure()
        Get the state structure.
        Returns:
        the state structure.
      • isRegistered

        public boolean isRegistered()
        Check if object has registered its state.
        Returns:
        true if registered, false otherwise.