Class TaskParameterInstance

java.lang.Object
mgui.pipelines.TaskParameterInstance
All Implemented Interfaces:
java.io.Serializable, InterfaceObject, NamedObject, TreeObject, CleanableObject

public class TaskParameterInstance
extends java.lang.Object
implements InterfaceObject, java.io.Serializable
An instance of a task parameter.
Since:
1.0
Version:
1.0
Author:
Andrew Reid
See Also:
TaskParameter, Serialized Form
  • Field Summary

    Fields
    Modifier and Type Field Description
    boolean apply  
    java.lang.String name  
    java.lang.String value  
  • Constructor Summary

    Constructors
    Constructor Description
    TaskParameterInstance​(TaskParameter p)  
  • Method Summary

    Modifier and Type Method Description
    java.util.ArrayList<java.lang.String> asArgs()  
    java.util.ArrayList<java.lang.String> asArgs​(java.lang.String instance, java.lang.String root_dir)  
    java.util.ArrayList<java.lang.String> asArgs​(java.lang.String instance, InterfaceProject project)  
    void clean()
    Instructs this object to search its members for any object which has been destroyed, and release the pointer to it.
    void destroy()
    Destroy this object (prepare it to be removed from memory)
    java.lang.String getName()
    Gets the name for this object.
    java.lang.String getPipelineTreeLabel()  
    java.lang.String getTreeLabel()
    Returns the label text to appear in a tree node.
    java.lang.String getXML​(int tab)  
    boolean isDestroyed()
    Test whether this object has been destroyed
    InterfaceTreeNode issueTreeNode()
    Issues a new InterfaceTreeNode for this object.
    void setFromParamaterInstance​(TaskParameterInstance instance)  
    void setName​(java.lang.String name)
    Sets the name for this object.
    void setTreeNode​(InterfaceTreeNode node)
    Sets the children for this node's InterfaceTreeNode.
    java.lang.String toString()  

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Field Details

    • name

      public java.lang.String name
    • apply

      public boolean apply
    • value

      public java.lang.String value
  • Constructor Details

    • TaskParameterInstance

      public TaskParameterInstance​(TaskParameter p)
  • Method Details

    • setFromParamaterInstance

      public void setFromParamaterInstance​(TaskParameterInstance instance)
    • clean

      public void clean()
      Description copied from interface: CleanableObject
      Instructs this object to search its members for any object which has been destroyed, and release the pointer to it.
      Specified by:
      clean in interface CleanableObject
    • getXML

      public java.lang.String getXML​(int tab)
    • asArgs

      public java.util.ArrayList<java.lang.String> asArgs()
    • asArgs

      public java.util.ArrayList<java.lang.String> asArgs​(java.lang.String instance, InterfaceProject project)
    • asArgs

      public java.util.ArrayList<java.lang.String> asArgs​(java.lang.String instance, java.lang.String root_dir)
    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object
    • destroy

      public void destroy()
      Description copied from interface: InterfaceObject
      Destroy this object (prepare it to be removed from memory)
      Specified by:
      destroy in interface InterfaceObject
    • getName

      public java.lang.String getName()
      Description copied from interface: NamedObject
      Gets the name for this object.
      Specified by:
      getName in interface NamedObject
      Returns:
    • isDestroyed

      public boolean isDestroyed()
      Description copied from interface: InterfaceObject
      Test whether this object has been destroyed
      Specified by:
      isDestroyed in interface InterfaceObject
      Returns:
    • setName

      public void setName​(java.lang.String name)
      Description copied from interface: NamedObject
      Sets the name for this object.
      Specified by:
      setName in interface NamedObject
    • getTreeLabel

      public java.lang.String getTreeLabel()
      Description copied from interface: TreeObject
      Returns the label text to appear in a tree node.
      Specified by:
      getTreeLabel in interface TreeObject
      Returns:
    • getPipelineTreeLabel

      public java.lang.String getPipelineTreeLabel()
    • issueTreeNode

      public InterfaceTreeNode issueTreeNode()
      Description copied from interface: TreeObject
      Issues a new InterfaceTreeNode for this object. The object is responsible for maintaining, updating, and destroying the tree nodes it issues, or notifying containers -- i.e., parent trees -- of changes which require the tree nodes to be modified or destroyed.
      Specified by:
      issueTreeNode in interface TreeObject
      Returns:
    • setTreeNode

      public void setTreeNode​(InterfaceTreeNode node)
      Description copied from interface: TreeObject
      Sets the children for this node's InterfaceTreeNode.
      Specified by:
      setTreeNode in interface TreeObject