OpenMI.Standard.Definition.htm

source code comments from the ILinkableComponent.cs file

Source code for the OpenMI.Standard.ILinkableComponent.GetInputExchangeItem(...) method

/// <summary>
/// <para>Returns the InputExchangeItem corresponding to the inputExchangeItemIndex
/// provided in the method arguments.</para>
///
/// <para>This method must be accessible after the Initialize( ) method has been
/// invoked and until the Prepare( ) method has been invoked. If this property
/// is accessed before the Initialize( ) method has been invoked or after the
/// Prepare( ) method has been invoked and the LinkableComponent cannot handle
/// this an exception must be thrown.</para>
///
/// <para>This method basically returns a reference to the InputExchangeItem object.
/// There is no guarantee that this object is not altered by other components
/// after it has been returned. It is the responsibility of the LinkableComponent
/// to make sure that such possible alterations does not subsequently corrupt
/// the LinkableComponent.</para>
/// </summary>
///
/// <param name="inputExchangeItemIndex">
/// Identifies the index-number of the requested InputExchangeItem (indexing starts from zero)
/// This method must accept values of inputExchangeItemIndex in the interval
/// [0, InputExchangeItemCount - 1]. If the inputExchangeItemIndex is outside this
/// interval an exception must be thrown.</param>
///
/// <returns>
/// The InputExchangeItem as identified by inputExchangeItemIndex.
/// </returns>

IInputExchangeItem GetInputExchangeItem(int inputExchangeItemIndex);