Class/Object

com.alpine.plugin.core

OperatorStatus

Related Docs: object OperatorStatus | package core

Permalink

case class OperatorStatus(isValid: Boolean, msg: Option[String], outputMetadata: IOMetadata) extends Product with Serializable

This is the required return type for the onInputOrParameterChange function in OperatorGUINode class. If the schemas of connected inputs or selected parameters are invalid, this should be false, along with an optional message about why this is false.

isValid

true if the operator is valid. false otherwise.

msg

An optional message that will show up in the UI. You can return a message even if the operator is valid.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OperatorStatus
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OperatorStatus(isValid: Boolean, msg: Option[String])

    Permalink
  2. new OperatorStatus(isValid: Boolean, msg: Option[String], outputMetadata: IOMetadata)

    Permalink

    isValid

    true if the operator is valid. false otherwise.

    msg

    An optional message that will show up in the UI. You can return a message even if the operator is valid.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  8. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  9. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  10. val isValid: Boolean

    Permalink

    true if the operator is valid.

    true if the operator is valid. false otherwise.

  11. val msg: Option[String]

    Permalink

    An optional message that will show up in the UI.

    An optional message that will show up in the UI. You can return a message even if the operator is valid.

  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. val outputMetadata: IOMetadata

    Permalink
  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped