Package edu.wpi.grip.ui.codegeneration.data

Class TSocket

  • Direct Known Subclasses:
    TInput, TOutput
    public class TSocket
extends java.lang.Object
    This class is a socket for a step and is extended by TOutput and TInput.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected TSocket​(java.lang.String type, java.lang.String name)
      The default constructor for a Socket.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String baseType()
      This checks if a step is mutable and returns the type.
      protected java.lang.String baseTypeHelper​(java.lang.String type)
      Can be overridden by a subclass.
      boolean mutable()
      Checks to see if the socket is mutable.
      java.lang.String name()
      the String that represents the socket.
      boolean number()
      checks to see if the socket is a number type.
      void setType​(java.lang.String type)
      Sets the type of the socket to a value.
      java.lang.String type()
      gets the type of the socket.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • TSocket

        protected TSocket​(java.lang.String type,
                  java.lang.String name)
        The default constructor for a Socket. Assigns member variable to values.
        Parameters:
        type - the type of the socket. eg: (String, Mat).
        name - the GRIP name of the socket.

    • Method Detail

      • setType

        public void setType​(java.lang.String type)
        Sets the type of the socket to a value.
        Parameters:
        type - The new type of the socket

      • type

        public java.lang.String type()
        gets the type of the socket.
        Returns:
        the type of the socket.

      • name

        public java.lang.String name()
        the String that represents the socket.
        Returns:
        the name of the socket.

      • baseType

        public java.lang.String baseType()
        This checks if a step is mutable and returns the type. Used in Templates.
        Returns:
        The type of the socket.

      • baseTypeHelper

        protected java.lang.String baseTypeHelper​(java.lang.String type)
        Can be overridden by a subclass. is overridden by TInput.
        Parameters:
        type - the original type
        Returns:
        the baseType

      • mutable

        public boolean mutable()
        Checks to see if the socket is mutable.
        Returns:
        true if mutable. false if not mutable.

      • number

        public boolean number()
        checks to see if the socket is a number type.
        Returns:
        true if it is a number.