Interface HPCPlugin

    HPC plugin

    interface HPCPlugin {
        category: "HPC";
        client: {
            configuration: {
                [key: string]: {
                    default?: boolean | number | string;
                    label: string;
                    options?: string[];
                    props?: any;
                    rules?: {
                        max?: number;
                        message?: string;
                        min?: number;
                        required?: boolean;
                    }[];
                    secret?: boolean;
                    tooltip?: string;
                    type: "input" | "textarea" | "password" | "select";
                    value?: boolean | number | string;
                };
            };
            data?: {
                [key: string]: any;
            };
            description: string;
            extra?: {
                [key: string]: {
                    action: string;
                    icon: string;
                    label: string;
                    type: "button";
                };
            };
            haveInit?: true;
            inUseConfiguration?: {
                [key: string]: {
                    label: string;
                    parallelOnly?: boolean;
                    value?: boolean | number | string;
                };
            };
            name: string;
            needReInit?: boolean;
        };
        key: string;
        rootDirectory?: string;
        server: {
            lib: {
                computeSimulation: ((__namedParameters, scheme, keepMesh?) => Promise<void>);
                extra?: ((simulation, configuration, extra) => Promise<void>);
                init?: ((configuration) => Promise<void | {
                    data: undefined | {
                        [key: string]: any;
                    };
                }>);
                monitoring: ((id, pid, __namedParameters, configuration?) => Promise<void>);
                stop: ((id, tasks, configuration) => Promise<void>);
            };
        };
        uuid?: string;
    }

    Hierarchy (view full)

    Properties

    category client key rootDirectory? server uuid?

    Properties

    category

    category: "HPC"

    client

    client: {
        configuration: {
            [key: string]: {
                default?: boolean | number | string;
                label: string;
                options?: string[];
                props?: any;
                rules?: {
                    max?: number;
                    message?: string;
                    min?: number;
                    required?: boolean;
                }[];
                secret?: boolean;
                tooltip?: string;
                type: "input" | "textarea" | "password" | "select";
                value?: boolean | number | string;
            };
        };
        data?: {
            [key: string]: any;
        };
        description: string;
        extra?: {
            [key: string]: {
                action: string;
                icon: string;
                label: string;
                type: "button";
            };
        };
        haveInit?: true;
        inUseConfiguration?: {
            [key: string]: {
                label: string;
                parallelOnly?: boolean;
                value?: boolean | number | string;
            };
        };
        name: string;
        needReInit?: boolean;
    }

    Type declaration

    • configuration: {
          [key: string]: {
              default?: boolean | number | string;
              label: string;
              options?: string[];
              props?: any;
              rules?: {
                  max?: number;
                  message?: string;
                  min?: number;
                  required?: boolean;
              }[];
              secret?: boolean;
              tooltip?: string;
              type: "input" | "textarea" | "password" | "select";
              value?: boolean | number | string;
          };
      }
      • [key: string]: {
            default?: boolean | number | string;
            label: string;
            options?: string[];
            props?: any;
            rules?: {
                max?: number;
                message?: string;
                min?: number;
                required?: boolean;
            }[];
            secret?: boolean;
            tooltip?: string;
            type: "input" | "textarea" | "password" | "select";
            value?: boolean | number | string;
        }
        • Optional default?: boolean | number | string
        • label: string
        • Optional options?: string[]
        • Optional props?: any
        • Optional rules?: {
              max?: number;
              message?: string;
              min?: number;
              required?: boolean;
          }[]
        • Optional secret?: boolean
        • Optional tooltip?: string
        • type: "input" | "textarea" | "password" | "select"
        • Optional value?: boolean | number | string
    • Optional data?: {
          [key: string]: any;
      }
      • [key: string]: any
    • description: string
    • Optional extra?: {
          [key: string]: {
              action: string;
              icon: string;
              label: string;
              type: "button";
          };
      }
      • [key: string]: {
            action: string;
            icon: string;
            label: string;
            type: "button";
        }
        • action: string
        • icon: string
        • label: string
        • type: "button"
    • Optional haveInit?: true
    • Optional inUseConfiguration?: {
          [key: string]: {
              label: string;
              parallelOnly?: boolean;
              value?: boolean | number | string;
          };
      }
      • [key: string]: {
            label: string;
            parallelOnly?: boolean;
            value?: boolean | number | string;
        }
        • label: string
        • Optional parallelOnly?: boolean
        • Optional value?: boolean | number | string
    • name: string
    • Optional needReInit?: boolean

    key

    key: string

    Optional rootDirectory

    rootDirectory?: string

    server

    server: {
        lib: {
            computeSimulation: ((__namedParameters, scheme, keepMesh?) => Promise<void>);
            extra?: ((simulation, configuration, extra) => Promise<void>);
            init?: ((configuration) => Promise<void | {
                data: undefined | {
                    [key: string]: any;
                };
            }>);
            monitoring: ((id, pid, __namedParameters, configuration?) => Promise<void>);
            stop: ((id, tasks, configuration) => Promise<void>);
        };
    }

    Type declaration

    • lib: {
          computeSimulation: ((__namedParameters, scheme, keepMesh?) => Promise<void>);
          extra?: ((simulation, configuration, extra) => Promise<void>);
          init?: ((configuration) => Promise<void | {
              data: undefined | {
                  [key: string]: any;
              };
          }>);
          monitoring: ((id, pid, __namedParameters, configuration?) => Promise<void>);
          stop: ((id, tasks, configuration) => Promise<void>);
      }
      • computeSimulation: ((__namedParameters, scheme, keepMesh?) => Promise<void>)
          • (__namedParameters, scheme, keepMesh?): Promise<void>

          • Parameters

            • __namedParameters: {
                  id: string;
              }
              • id: string
            • scheme: IModel
            • Optional keepMesh: boolean

            Returns Promise<void>

      • Optional extra?: ((simulation, configuration, extra) => Promise<void>)
          • (simulation, configuration, extra): Promise<void>

          • Parameters

            • simulation: {
                  id: string;
              }
              • id: string
            • configuration: {
                  [key: string]: {
                      default?: boolean | number | string;
                      label: string;
                      options?: string[];
                      props?: any;
                      rules?: {
                          max?: number;
                          message?: string;
                          min?: number;
                          required?: boolean;
                      }[];
                      secret?: boolean;
                      tooltip?: string;
                      type: "input" | "textarea" | "password" | "select";
                      value?: boolean | number | string;
                  };
              }
              • [key: string]: {
                    default?: boolean | number | string;
                    label: string;
                    options?: string[];
                    props?: any;
                    rules?: {
                        max?: number;
                        message?: string;
                        min?: number;
                        required?: boolean;
                    }[];
                    secret?: boolean;
                    tooltip?: string;
                    type: "input" | "textarea" | "password" | "select";
                    value?: boolean | number | string;
                }
                • Optional default?: boolean | number | string
                • label: string
                • Optional options?: string[]
                • Optional props?: any
                • Optional rules?: {
                      max?: number;
                      message?: string;
                      min?: number;
                      required?: boolean;
                  }[]
                • Optional secret?: boolean
                • Optional tooltip?: string
                • type: "input" | "textarea" | "password" | "select"
                • Optional value?: boolean | number | string
            • extra: string

            Returns Promise<void>

      • Optional init?: ((configuration) => Promise<void | {
            data: undefined | {
                [key: string]: any;
            };
        }>)
          • (configuration): Promise<void | {
                data: undefined | {
                    [key: string]: any;
                };
            }>

          • Parameters

            • configuration: {
                  [key: string]: {
                      default?: boolean | number | string;
                      label: string;
                      options?: string[];
                      props?: any;
                      rules?: {
                          max?: number;
                          message?: string;
                          min?: number;
                          required?: boolean;
                      }[];
                      secret?: boolean;
                      tooltip?: string;
                      type: "input" | "textarea" | "password" | "select";
                      value?: boolean | number | string;
                  };
              }
              • [key: string]: {
                    default?: boolean | number | string;
                    label: string;
                    options?: string[];
                    props?: any;
                    rules?: {
                        max?: number;
                        message?: string;
                        min?: number;
                        required?: boolean;
                    }[];
                    secret?: boolean;
                    tooltip?: string;
                    type: "input" | "textarea" | "password" | "select";
                    value?: boolean | number | string;
                }
                • Optional default?: boolean | number | string
                • label: string
                • Optional options?: string[]
                • Optional props?: any
                • Optional rules?: {
                      max?: number;
                      message?: string;
                      min?: number;
                      required?: boolean;
                  }[]
                • Optional secret?: boolean
                • Optional tooltip?: string
                • type: "input" | "textarea" | "password" | "select"
                • Optional value?: boolean | number | string

            Returns Promise<void | {
                data: undefined | {
                    [key: string]: any;
                };
            }>

      • monitoring: ((id, pid, __namedParameters, configuration?) => Promise<void>)
          • (id, pid, __namedParameters, configuration?): Promise<void>

          • Parameters

            • id: string
            • pid: undefined | string
            • __namedParameters: UpdateTasksHelper
            • Optional configuration: {
                  [key: string]: {
                      default?: boolean | number | string;
                      label: string;
                      options?: string[];
                      props?: any;
                      rules?: {
                          max?: number;
                          message?: string;
                          min?: number;
                          required?: boolean;
                      }[];
                      secret?: boolean;
                      tooltip?: string;
                      type: "input" | "textarea" | "password" | "select";
                      value?: boolean | number | string;
                  };
              }
              • [key: string]: {
                    default?: boolean | number | string;
                    label: string;
                    options?: string[];
                    props?: any;
                    rules?: {
                        max?: number;
                        message?: string;
                        min?: number;
                        required?: boolean;
                    }[];
                    secret?: boolean;
                    tooltip?: string;
                    type: "input" | "textarea" | "password" | "select";
                    value?: boolean | number | string;
                }
                • Optional default?: boolean | number | string
                • label: string
                • Optional options?: string[]
                • Optional props?: any
                • Optional rules?: {
                      max?: number;
                      message?: string;
                      min?: number;
                      required?: boolean;
                  }[]
                • Optional secret?: boolean
                • Optional tooltip?: string
                • type: "input" | "textarea" | "password" | "select"
                • Optional value?: boolean | number | string

            Returns Promise<void>

      • stop: ((id, tasks, configuration) => Promise<void>)

    Optional uuid

    uuid?: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc and TypeDoc Airthium Plugin