XPRMModule

Method Detail

• getName

  public java.lang.String getName()

  Get module name.

  Returns:

  Name of the module

• getNumber

  public int getNumber()

  Get module number. An order number is assigned to the module when it is loaded into memory.

  Returns:

  Module number

• getVersion

  public XPRMVersion getVersion()

  Get module version.

  Returns:

  Module version as a version object

• getNumberOfReferences

  public int getNumberOfReferences()

  Get number of references to this module. This corresponds to the number of models currently loaded requiring the module.

  Returns:

  Number of references

• getCertificate

  public java.lang.String getCertificate()

  Get the certificate of the module. Certified modules have a certificate string that can be retrieved using this method.

  Returns:

  Certificate as a string

• getPath

  public java.lang.String getPath()

  Get the path of the module. The full path where the module is loaded from.

  Returns:

  Path as a string

• getPriority

  public int getPriority()

  Get the priority of the module. The priority defines an order for module initialization and termination. A module with a lower priority value will be initialized before modules with higher priority values. Inversely, it will be reset before modules with higher priority values. The default priority is 0.

  Returns:

  Priority value as an integer

• procedures

  public XPRMProcedures procedures()

  Get an iterator to enumerate all procedures and functions of the module.

  Returns:

  A procedure/function iterator

• constants

  public XPRMConstants constants()

  Get an iterator to enumerate all constants of the module.

  Returns:

  A constant iterator

• types

  public XPRMNativeTypes types()

  Get an iterator to enumerate all types published by the module.

  Returns:

  A native type iterator

• parameters

  public XPRMParameters parameters()

  Get an iterator to enumerate all control parameters of the module.

  Returns:

  A parameter iterator

• IODrivers

  public XPRMIODrivers IODrivers()

  Get an iterator to enumerate all IO drivers published by the module.

  Returns:

  An IO driver iterator