ecl-logo Documentation

RosettaTaskQ

RosettaTaskQ[task]boolean

returns True when task is a valid Rosetta task.

RosettaTaskQ[task,type]boolean

returns True when task is a valid Rosetta task with TaskType type.

Details

  • Valid Rosetta tasks are defined in associations with specific keys and key-values.
  • RosettaTaskQ checks that the input association has the correct keys:
  • Key
    Pattern
    Description
    TaskTypeRosettaTaskTypePThe type of task described by the task association.
    ID_StringA unique identifier used to distinguish the task from other tasks such that procedures can be reset to specific tasks.
    Args_AssociationAn association defining all arguments used by the task. Each task type may have different arguments.
  • Input
    Output

Examples

Basic Examples  (3)

Returns True when input association is a valid Rosetta Task definition:

Specify a specific TaskType that the input association must define:

Returns False if the input association is an invalid task definition:

Additional Examples  (1)

Returns False if the input association is a valid task definition but not of the specified TaskType: