Package com.piketec.tpt.api.cplatform

Interface FunctionSchedulingItem

  • All Superinterfaces:
    IdentifiableRemote, java.rmi.Remote, TptRemote
    public interface FunctionSchedulingItem
extends IdentifiableRemote
    A function that can be used for scheduling in the C\C++ platform in TPT
    Author:
    Copyright (c) 2014-2024 Piketec GmbH - MIT License (MIT) - All rights reserved

    • Method Detail

      • isScheduled

        boolean isScheduled()
             throws java.rmi.RemoteException
        Returns:
        Will this function be scheduled by the generated code
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setScheduled

        void setScheduled​(boolean isScheduled)
           throws java.rmi.RemoteException
        Set if this function will be scheduled by the generated code
        Parameters:
        isScheduled - Will the function be scheduled
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getName

        java.lang.String getName()
                  throws java.rmi.RemoteException
        Returns:
        The name of the function
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setName

        void setName​(java.lang.String name)
      throws java.rmi.RemoteException
        Sets the name of the function, only supported if the function is not imported from the source code
        Parameters:
        name - The name of the function
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getPeriod

        java.lang.String getPeriod()
                    throws java.rmi.RemoteException
        Gets the period of the function
        Returns:
        The period of the function
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setPeriod

        void setPeriod​(java.lang.String period)
        throws java.rmi.RemoteException
        Set the period to schedule the function
        Parameters:
        period - The desired period for this function
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getFunctionKind

        CCodeFunctionKind getFunctionKind()
                           throws java.rmi.RemoteException
        Returns:
        The function kind of the associated function
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setFunctionKind

        void setFunctionKind​(CCodeFunctionKind cCodeFunctionKind)
              throws java.rmi.RemoteException
        Set the desired function kind of this scheduling item
        Parameters:
        cCodeFunctionKind - The desired function kind
        Throws:
        java.rmi.RemoteException - remote communication problem

      • isImportedFromCCodeSource

        boolean isImportedFromCCodeSource()
                           throws java.rmi.RemoteException
        Was this scheduling item imported from the sources or manually added
        Returns:
        Was this scheduling item imported from the sources
        Throws:
        java.rmi.RemoteException - remote communication problem

      • getDelay

        java.lang.String getDelay()
                   throws java.rmi.RemoteException
        Get the delay before the scheduling starts
        Returns:
        the current delay
        Throws:
        java.rmi.RemoteException - remote communication problem

      • setDelay

        void setDelay​(java.lang.String delay)
       throws java.rmi.RemoteException
        Set the delay before the scheduling starts
        Parameters:
        delay - The new delay
        Throws:
        java.rmi.RemoteException - remote communication problem