Package Overview
The External Simulation Access (ESA) package contains functions used in cosimulation to link Riverbed analysis software models with external code (either an external simulator or a link to another simulation) in a cosimulation. For details about cosimulations, see “External System Domain“ on page 332.
The APIs in this package fall into four functional areas: flow control, interface access, input/output, and miscellaneous. They are typically used in a process model of an esys node.
Note: You must call Esa_Init() before using any other ESA functions.
Flow Control Functions
Flow control functions are used to set up a simulation, let it process events, and deal with simulation time-keeping.
- Esa_Current_Event_Time_Get()
- Esa_Current_Event_Time_Set()
- Esa_Execute_Until()
- Esa_Init()
- Esa_Interrupt()
- Esa_Load()
- Esa_Main()
- Esa_Next_Event_Time_Get()
- Esa_Terminate()
Interface Access Functions
Interface access functions deal with the interfaces used to communicate between internal application nodes and the cosimulation code.
- Esa_Interface_Array_Get()
- Esa_Interface_Array_Set()
- Esa_Interface_Attr_Get()
- Esa_Interface_Callback_Register()
- Esa_Interface_Get()
- Esa_Interface_Group_Free()
- Esa_Interface_Group_Get()
- Esa_Interface_Name_Get()
- Esa_Interface_Value_Get()
- Esa_Interface_Value_Set()
- Esa_String_From_Type()
Input/Output Functions
Input/output functions deal with reading text into and writing it out of a simulation.
- Esa_Text_Input()
- Esa_Text_Input_Callback_Register()
- Esa_Text_Output()
- Esa_Text_Output_Callback_Register()
- Esa_Text_Prompt_Callback_Register()
Miscellaneous Functions
Miscellaneous functions handle memory deallocation and interaction with the OPNET Debugger (ODB).
Function Descriptions
Detailed descriptions of the functions follow.