using the simio api · simio api forum (for examples, community help) simio api overview...

6/5/2018 Copyright 2018 Simio LLC 1

Using the Simio APIOverview and Use

Dan Houck

Sr. Software Engineer

User Group 2018


Impart a sense of what is possible

Show how Simio is extended by the API

Introduce some software concepts

Demonstrate the workflow

Objectives


Why API? A Brief Overview

How the Simio API is organized and used

What is installed with Simio

What is needed to build an API▪ The Work Flow. Visual Studio and .NET

▪ References, Tools, and Tips

The Future: Plans for the next year

Questions, Answers, Feedback

Topics


A set of clearly defined methods of communications between software components.

Particularly useful to Simio which is data-driven

Allows Simio to extend to more solutions▪ Incorporate existing or complex logic

Allows Simio to communicate with other Software▪ Use for building large / complex / variable models

Examples of API Usage:▪ Import or Export Data

▪ Interface with existing logic

▪ Modify the behavior of Simio objects

▪ Interface with other Systems/Packages/Legacy Logic

▪ Build and modify models from external data

Application Programming Interface


User Extensions▪ Design Time Add-Ins

▪ User Defined Steps (Run-Time)

“Headless” or “Back-End” Simio Engine▪ Controlling the “black box”

API Uses Discussed


Users > {you} > Documents

SimioModels▪ SimioUserExtensions

Users > Public Documents > Documents▪ Simio

▪ Examples

o User Extensions (A folder for each, E.g. TextFileReadWrite)

▪ Reports, Skins, …

Program Files (x86)▪ Simio Executable

Visual Studio Templates

Simio Installation: What You Get


General Programming Knowledge

Modern Programming Concepts: ▪ Objects

▪ Interfaces

Knowledge of .NET Concepts

Familiarity with C#

Familiarity with Visual Studio

General Fearlessness

Simio API: What you Need


Simio API Forum (for examples, community help)

Simio API Overview (referenced on Forum)

StackOverflow (for .NET programming advice)

Simio Examples (from Simio installation)

Simio API Reference Guide

Resources


Examples Under Public Documents:

Simio Installation: Examples


TextFileReadWrite

Simio Installation: Example


Where they appear on the UI:

Design Time Add-Ins


Usages: Anything that should be done during design▪ Building Models Dynamically

▪ Read/Write Model Data Dynamically

▪ Setting up context for Run-Time

Design-Time Add-Ins


Create Routes Interactively with GIS Web interface (GIF)

Add-In: Real-Time Model Building


Add-In Fully Built Model


Usages: When Special Run-Time Logic is Required▪ Special I/O

▪ Creating Simio Events

▪ Custom Logic (e.g. Routing)

User Steps (Run-Time)


Where they appear on the UI:

User Step


Starting Framework (VS Templates)

Understanding some basic .NET object concepts▪ Object, Inheritance, Collections

▪ What is an Interface

Discovering how to use the Interfaces

A good example as a reference helps… a lot.

Building: Using the API to Create…


Creating a DLL (for User Extensions)

Creating an EXE (for the Headless Simulation

Building: Two Models


Building a DLL


Building an EXE


A defined way to “see” an object:IEngine might have properties like cubic inches, HP, …

IManufacturer might have Model, Make, Year, …

What is an Interface


Simio API: Know Your Objects


How to debug (breakpoints, watch points)

Intellisense

Use included tools: object browser, NuGet, etc..

Simio API: Know your IDE (VS)


Simio API Reference

External Tools to Examine the Simio DLLs

Simio API: Know your Interfaces


API Reference Guide


Using the Simio API Reference Guide

Examining the Interface


Examining the Interface

Using the DLL and a Tool like DotPeek


DotPeek (JetBrains)

StackOverflow

C# In Depth (Jon Skeet)

API Helper (Simio Forum)

My API Toolbox


Two basic Modes:1. You are building a DLL to be run by Simio

▪ For Steps and Design Add-Ins

2. You are controlling Simio as an EXE▪ Running the Back-End Engine

Visual Studio Workflow


Place the DLL Where Simio Can Find It:

VS Adjustment #1


Start Simio.exe (which will find and call your DLL)

VS Adjustment #2


Export-Import Demonstrates Simio Objects:▪ Table Data

▪ Objects and Links

▪ Object Types

▪ Vertices

▪ Networks

▪ Elements

▪ Lists

▪ Model Property Values

▪ Table Property Values

Forum Favorite


Example Export-Import


Don’t forget to “Unblock” and download (before unzipping)

Run your extensions in the Visual Studio debugger

Use error handling

Don’t reinvent; E.g. NuGet (113K+ unique packages)

Don’t start from scratch; check the examples and forums

Tips and Checklist


There is website, but easiest within Visual Studio…

Code: Use NuGet


Via Visual Studio: Tools > NuGet Package Manager

Code: NuGet


Several options are available:▪ 1. Use the Simio error methods

▪ 2. Log to a file

▪ 3. Use a MessageBox

▪ 4. Throw an ApplicationException (Simio will catch it)

Coding: Use Error Handling


Add Tools/Techniques to assist with debugging

More Examples and Improved Search

More Data Interfaces to support Industry 4.0

Evolve with C# and .NET

Simio API: The Future


Discrete Part Prod. with On Run-Ending Export

Contains Several Examples:▪Running “Headless” Simio Engine as a Service

▪Importing Property (WorkPeriodExceptions)

▪Using .NET FileWatcher to look for files

▪Exporting results

Case Study: Complex


Overall Structure

SDPP with Ending Export


Setup (Main)…



OnStart (as a service, this would be called automatically)



Facility Picture:



Data > Tables > Resources



Main Code Body:



Code to insert WorkPeriodExceptions
