Package org.robwork.sdurw_pathplanning

Class StopCriteriaCPtr

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

    • Constructor Summary

      Constructors 
      Constructor Description
      StopCriteriaCPtr()
      Default constructor yielding a NULL-pointer.
      StopCriteriaCPtr​(long cPtr, boolean cMemoryOwn)  
      StopCriteriaCPtr​(StopCriteria 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
      StopCriteria __ref__()
      Dereferencing operator.
      void delete()  
      StopCriteria deref()
      The pointer stored in the object.
      boolean equals​(StopCriteria p)  
      static long getCPtr​(StopCriteriaCPtr obj)  
      StopCriteria getDeref()
      Member access operator.
      StopCriteriaPtr instance()
      A new instance of the property constructed to match the
      original initial state of the criteria.

      This implies, for example, that instance() called for a time criteria
      creates a new criteria that stops after the same amount of time that
      was specified for the original stop criteria.

      Not all stop criteria returned are required to behave this way.
      boolean isNull()
      checks if the pointer is null
      boolean isShared()
      check if this Ptr has shared ownership or none
      ownership
      boolean stop()
      True is returned when the computation should be stopped.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • StopCriteriaCPtr

        public StopCriteriaCPtr​(long cPtr,
                        boolean cMemoryOwn)

      • StopCriteriaCPtr

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

      • StopCriteriaCPtr

        public StopCriteriaCPtr​(StopCriteria ptr)
        Do not take ownership of ptr.

        ptr can be null.

        The constructor is implicit on purpose.

    • Method Detail

      • delete

        public void delete()

      • deref

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

      • __ref__

        public StopCriteria __ref__()
        Dereferencing operator.

      • getDeref

        public StopCriteria getDeref()
        Member access operator.

      • 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

      • stop

        public boolean stop()
        True is returned when the computation should be stopped.

      • instance

        public StopCriteriaPtr instance()
        A new instance of the property constructed to match the
        original initial state of the criteria.

        This implies, for example, that instance() called for a time criteria
        creates a new criteria that stops after the same amount of time that
        was specified for the original stop criteria.

        Not all stop criteria returned are required to behave this way. For
        some types of stop criteria, the instances of the stop criteria will
        be effectively identical to the stop criteria itself.