com.ansys.ingress.client.api

## Class ModelSpecUtils

- java.lang.Object
- - com.ansys.ingress.client.api.ModelSpecUtils

-     public final class ModelSpecUtils
      extends java.lang.Object

  ModelSpecUtils is used to get information about EKM object types.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `ModelSpecUtils()`

  - ### Method Summary

    All Methods Static Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static java.util.Set<java.lang.String>` | `getConcreteTypeNames()` Gets the concrete type names that are defined.
    `static ModelSpec` | `getSpecFromTypeName(java.lang.String typeName)` Gets an object type for the given type name.
    `static java.util.Set<java.lang.String>` | `getSubTypeNames(java.lang.String typeName)` Gets the subtypes of the specified type.
    `static java.util.Set<java.lang.String>` | `getSuperTypeNames(java.lang.String typeName)` Gets the set of supertypes for the given type.
    `static com.ansys.ingress.commons.model.Units.Unit` | `getUnitForPropertySpec(com.ansys.ingress.commons.model.properties.PropertySpec propertySpec)` Gets the unit for the given proprty.
    `static boolean` | `isFileType(ModelSpec spec)` Determines if the given type is a file type or not.
    `static void` | `setDataManager(DataManager dm)` Initializes the `DataManager`.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### ModelSpecUtils

          public ModelSpecUtils()

  - ### Method Detail

    - #### getSubTypeNames

          public static java.util.Set<java.lang.String> getSubTypeNames(java.lang.String typeName)
                                                                 throws DataException

      Gets the subtypes of the specified type.
      Parameters:
        `typeName` - the type
      Returns:
        Returns the names of the types that are subtypes of the specified type.
      Throws:
        `DataException` - if the names could not be retrieved.

    - #### getSuperTypeNames

          public static java.util.Set<java.lang.String> getSuperTypeNames(java.lang.String typeName)
                                                                   throws DataException

      Gets the set of supertypes for the given type.
      Parameters:
        `typeName` - the type.
      Returns:
        Returns the names of the types that are supertypes of the specified type.
      Throws:
        `DataException` - if the names could not be retrieved.

    - #### isFileType

          public static boolean isFileType(ModelSpec spec)
                                    throws DataException

      Determines if the given type is a file type or not.
      Parameters:
        `spec` - the type to check
      Returns:
        Returns true if the type is a file type.
      Throws:
        `DataException` - if the type could not be determined.

    - #### getUnitForPropertySpec

          public static com.ansys.ingress.commons.model.Units.Unit getUnitForPropertySpec(com.ansys.ingress.commons.model.properties.PropertySpec propertySpec)
                                                                                   throws DataException

      Gets the unit for the given proprty.
      Parameters:
        `propertySpec` - the property
      Returns:
        Returns the unit.
      Throws:
        `DataException` - if the unit could not be determined.

    - #### getSpecFromTypeName

          public static ModelSpec getSpecFromTypeName(java.lang.String typeName)

      Gets an object type for the given type name.
      Parameters:
        `typeName` - the type name
      Returns:
        Returns the type name or null.

    - #### getConcreteTypeNames

          public static java.util.Set<java.lang.String> getConcreteTypeNames()
                                                                      throws DataException

      Gets the concrete type names that are defined.
      Returns:
        Returns the type names.
      Throws:
        `DataException` - if the type names could not be retrieved.

    - #### setDataManager

          public static void setDataManager(DataManager dm)

      Initializes the `DataManager`.
      Parameters:
        `dm` - the `DataManager` to set