Huygens Remote Manager
  • Namespace
  • Class
  • Tree
  • Todo

Namespaces

  • hrm
    • job
    • param
      • base
    • setting
      • base
    • shell
    • stats
    • user
      • proxy

Classes

  • AnalysisSetting
  • AnalysisSettingEditor
  • JobAnalysisSetting
  • JobParameterSetting
  • JobTaskSetting
  • ParameterSetting
  • ParameterSettingEditor
  • TaskSetting
  • TaskSettingEditor

Class ParameterSettingEditor

Implements an Editor for ParameterSetting.

hrm\setting\base\SettingEditor
Extended by hrm\setting\ParameterSettingEditor
Namespace: hrm\setting
Package: hrm
Located at setting/ParameterSettingEditor.php

Methods summary

public
# __construct( hrm\user\UserV2 $user )

SettingEditor constructor.

SettingEditor constructor.

Parameters

$user
Current User.
public string
# table( )

Returns the name of the database table in which the ParameterSetting are stored.

Returns the name of the database table in which the ParameterSetting are stored.

Returns

string
The table name.
public hrm\setting\ParameterSetting
# newSettingObject( )

Creates and returns a new ParameterSetting.

Creates and returns a new ParameterSetting.

Returns

hrm\setting\ParameterSetting
A new ParameterSetting.
public boolean
# image2hrmTemplate( hrm\setting\ParameterSetting $setting, string $dirName, string $fileName )

Creates a new ParameterSetting based on parsing the given file through HuCore.

Creates a new ParameterSetting based on parsing the given file through HuCore.

Parameters

$setting
The ParameterSetting object to fill.
$dirName
Full path to the containing folder.
$fileName
File name without path.

Returns

boolean

True if the new template creation was successful, false otherwise.

Todo

This method always returns false: it should return true at the end and also interpret the output of the call to HuygensTools::askHuCore() to decide whether it was successful or not!


Methods inherited from hrm\setting\base\SettingEditor

checkNewSettingName(), checkSelectedSetting(), copyPublicSetting(), copySelectedSetting(), createNewSetting(), deleteSelectedSetting(), getValidNewSettingName(), huTemplate2hrmTemplate(), loadSelectedSetting(), makeSelectedSettingDefault(), message(), selected(), setSelected(), setting(), settings(), shareSelectedSetting(), user()

Huygens Remote Manager API documentation generated by ApiGen