Package com.scaleoutsoftware.digitaltwin.core

Class ModelSchema

java.lang.Object
com.scaleoutsoftware.digitaltwin.core.ModelSchema
public class ModelSchema extends Object
The ModelSchema class is used as a Java object representation of the model.json schema file used for deploying a digital twin model to the real-time digital twin cloud service.

  • Constructor Details

    • ModelSchema

      public ModelSchema(String dtClass, String mpClass, String msgClass)
      Creates a model schema from a digital twin class, a message processor class, and a message class.
      Parameters:
      dtClass - the digital twin class implementation.
      mpClass - the message processor class implementation.
      msgClass - a JSON serializable message class.

    • ModelSchema

      public ModelSchema(String dtClass, String mpClass, String msgClass, List<AlertProviderConfiguration> alertingProviders)
      Creates a model schema from a digital twin class, a message processor class, a message class, and alert provider configurations.
      Parameters:
      dtClass - the digital twin class implementation.
      mpClass - the message processor class implementation.
      msgClass - a JSON serializable message class.
      alertingProviders - the alerting provider configurations.

    • ModelSchema

      public ModelSchema(String dtClass, String mpClass, String msgClass, String spClass, List<AlertProviderConfiguration> alertingProviders)
      Creates a model schema from a digital twin class, a message processor class, a message class, and alert provider configurations.
      Parameters:
      dtClass - the digital twin class implementation.
      mpClass - the message processor class implementation.
      msgClass - a JSON serializable message class.
      spClass - the simulation processor class implementation.
      alertingProviders - the alerting provider configurations.

    • ModelSchema

      public ModelSchema(String dtClass, String mpClass, String msgClass, String adtName, PersistenceProviderType persistenceType, List<AlertProviderConfiguration> alertingProviders)
      Creates a model schema from a digital twin class, a message processor class, a message class, and alert provider configurations.
      Parameters:
      dtClass - the digital twin class implementation.
      mpClass - the message processor class implementation.
      msgClass - a JSON serializable message class.
      adtName - the Azure Digital Twin model name.
      persistenceType - the persistence provider type.
      alertingProviders - the alerting provider configurations.

    • ModelSchema

      public ModelSchema(String dtClass, String mpClass, String msgClass, String simulationProcessorClass, String adtName, PersistenceProviderType persistenceType, List<AlertProviderConfiguration> alertingProviders)
      Parameters:
      dtClass - the digital twin class implementation.
      mpClass - the message processor class implementation.
      msgClass - a JSON serializable message class.
      simulationProcessorClass - the simulation processor class implementation.
      adtName - the Azure Digital Twin model name.
      persistenceType - the persistence provider type.
      alertingProviders - the alerting provider configurations.

  • Method Details

    • getModelType

      public String getModelType()
      Retrieve the digital twin model type (a DigitalTwinBase implementation).
      Returns:
      the model type.

    • getMessageType

      public String getMessageType()
      Retrieve the message type (JSON serializable message implementation).
      Returns:
      the message type.

    • getMessageProcessorType

      public String getMessageProcessorType()
      Retrieve the message processor type (a MessageProcessor implementation).
      Returns:
      the message processor type.

    • getSimulationProcessorType

      public String getSimulationProcessorType()
      Retrieve the simulation processor type (a SimulationProcessor implementation).
      Returns:
      the simulation processor type.

    • getAssemblyName

      public String getAssemblyName()
      NOT USED BY JAVA MODEL SCHEMA
      Returns:
      NOT USED BY JAVA MODEL SCHEMA

    • getAlertProviders

      public List<AlertProviderConfiguration> getAlertProviders()
      Retrieve the alert provider configurations.
      Returns:
      the alert provider configurations.

    • getAzureDigitalTwinModelName

      public String getAzureDigitalTwinModelName()
      Retrieve the Azure Digital Twin model name.
      Returns:
      the Azure Digital Twin model name.

    • persistenceEnabled

      public boolean persistenceEnabled()
      Retrieve persistence status. True if persistence is enabled, false otherwise.
      Returns:
      True if persistence is enabled, false otherwise.

    • simulationSupportEnabled

      public boolean simulationSupportEnabled()
      Retrieve simulation support enabled status. True if simulation support is enabled, false otherwise.
      Returns:
      True if simulation support is enabled, false otherwise.

    • getPersistenceProvider

      public PersistenceProviderType getPersistenceProvider()
      Retrieve the persistence provider type.
      Returns:
      the persistence provider type.