Using the SDK Generator

You can create a unit jar file using the SDK Generator.

  1. Launch the SDK Generator using one of the following methods:

    • Windows: Execute the sdkGenerator.exe file located in the <Isight_install_directory>\<operating_system>\code\bin directory.

    • Linux: Execute the sdkGenerator file located in the <Isight_install_directory>/<operating_system>/code/bin directory.

    You can also access this interface from the Design Gateway by selecting SDK Generator from the Tools menu.

    The Generator dialog box appears in the default configuration for generating components. The steps below describe how to add a unit.

  2. From the File menu, click New and select Unit.

    The Unit Creation Method dialog box appears.

  3. Determine how you want to create a new unit.

    • Create Unit Manually

      1. From the editor that appears, click Category on the left side and select one of the following options:

        • Create a new Unit. Click this option if you want to create a new unit.

          Enter the path to the parent category in the Parent Category text box. You can accept the default, enter another parent category, or click Select to locate a parent category.

        • Create a new Unit Category. Click this option if you want to create a new unit category.

      2. Click Name on the left side of the editor.
      3. Enter the following information in the Name editor that appears:
        Full Name Enter the full name of the unit category. This option is available only if you are creating a new unit category. The name you enter is the name that appears in the library.
        Display Name Enter the name that you want to appear in the Isight interface, which is the name of the Unit/Unit Category (e.g., meter or length).
        Version Enter the version number.
        Description (Short) Enter a brief description of the sub category, unit, or unit category (optional).
        (Full) Enter a detailed description of the sub-category, unit, or unit category (optional).
      4. Click Details on the left side of the editor.
      5. Enter the following information in the Details editor that appears. Depending on what you are creating, some of the options may not be available.
        Unit Category Enter the Base Unit class path in the text box and click Create. A dialog box appears where you can create a single base unit.
        Unit Specify the following information:
        • Base Unit. Displays the unit that defines this category.
        • Abbreviation. Define the abbreviation for this unit (e.g., “m” for meter).
        • Factor. The value used to convert to and from the base unit (parameters value times this value will covert to the base unit).
        • Sample. Displays an example of the converting value.
        • Use specialized class to convert values (Advanced). Toggle on to use a specialized Java class that must extend from class UnitProper in the SDK instead of using a multiplicative factor.
        • File Location. Enter the path of the file you want to use or click Browse to locate the file.
        • Package Name. The package where the file is to be placed (automatically generated, but can be edited).
      6. Once you have defined all the necessary settings, or at any time during the unit creation process, select the Save option from the File menu to save the jar file for your unit. You can also click Save on the SDK Generator toolbar.

    • Generate From File

      1. Enter the path of the *.unit file.
      2. Select one of the following:
        Save jars to disk Enter the target location. Isight creates a separate jar file for the unit category and each unit within that category, along with a puborder file.
        Publish to Library Isight adds a separate library object for the unit category and each unit within that category.

  4. If desired, click to publish the unit to the library.