About the Simcode API

This Simcode component provides an API for programmatically configuring the Simcode component using a Java program.

For more information about component APIs, see Component APIs.

The Simcode component API consists of the following methods:

  • get("inputdataexchange"). This method allows you to get the DtPlugin object for the input Data Exchange plug-in used for this Simcode.

  • get("outputdataexchange"). This method allows you to get the DtPlugin object for the output Data Exchange plug-in used for this Simocde.

  • get("oscommand"). This method allows you to get the DtPlugin object for the OSCommand plug-in used for this Simcode.

  • get("oscommandapi"). This method returns the PluginAPI object that can be used to configure the OSCommand plug-in used for this Simcode. This is equivalent to call get("oscommand"), casting it to a DtPlugin, and calling getAPI() on that object.

Note: Because the get method for a ComponentAPI simply returns Object, you will need to cast to the specific type mentioned for each of the API methods listed above. In addition, because the OSCommand plug-in is the most commonly configured programmatically, the method to get its API is provided directly. For the input and output Data Exchange plug-ins, only the method to get the DtPlugin object is provided and you need to call getAPI() on that object to get an API object for configuring them.