org.ptolemy.fmi

Class FMIEventInfo

java.lang.Object

com.sun.jna.Structure

org.ptolemy.fmi.FMIEventInfo

Direct Known Subclasses:

FMIEventInfo.ByReference, FMIEventInfo.ByValue

public class FMIEventInfo
extends com.sun.jna.Structure

Functional Mock-up Interface (FMI) event information for FMI-1.0.

The C language interface to Functional Mock-up Unit (FMU) files includes an structure that represents event information. This class represents that structure.

This file is based on a file that was autogenerated by JNAerator,
a tool written by Olivier Chafik that uses a few opensource projects..

Since:

Ptolemy II 10.0

Version:

$Id$, $Id$

Author:

Christopher Brooks

Pt.AcceptedRating:

Red (cxh)

Pt.ProposedRating:

Red (cxh)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FMIEventInfo.ByReference Access the structure by reference.
static class	FMIEventInfo.ByValue Access the structure by value.

Nested classes/interfaces inherited from class com.sun.jna.Structure

com.sun.jna.Structure.StructField

Field Summary

Fields

Modifier and Type	Field and Description
byte	iterationConverged C type: fmiBoolean.
double	nextEventTime C type: fmiReal.
byte	stateValueReferencesChanged C type: fmiBoolean.
byte	stateValuesChanged C type: fmiBoolean.
byte	terminateSimulation C type: fmiBoolean.
byte	upcomingTimeEvent C type: fmiBoolean.

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor and Description
FMIEventInfo() Instantiate a Java structure that that represents the C structure that contains information about events.
FMIEventInfo(byte iterationConverged, byte stateValueReferencesChanged, byte stateValuesChanged, byte terminateSimulation, byte upcomingTimeEvent, double nextEventTime) Instantiate a Java structure that that represents the C structure that contains information about events.

Method Summary

Modifier and Type	Method and Description
protected java.util.List	getFieldOrder() Return the field names in the proper order.
protected void	initFieldOrder() Deprecated. As of jna-3.5.0, use getFieldOrder() instead.

Methods inherited from class com.sun.jna.Structure

allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, clear, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setFieldOrder, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

iterationConverged

public byte iterationConverged

C type: fmiBoolean.

stateValueReferencesChanged

public byte stateValueReferencesChanged

C type: fmiBoolean.

stateValuesChanged

public byte stateValuesChanged

C type: fmiBoolean.

terminateSimulation

public byte terminateSimulation

C type: fmiBoolean.

upcomingTimeEvent

public byte upcomingTimeEvent

C type: fmiBoolean.

nextEventTime

public double nextEventTime

C type: fmiReal.

Constructor Detail

FMIEventInfo

public FMIEventInfo()

Instantiate a Java structure that that represents the C structure that contains information about events.

FMIEventInfo

public FMIEventInfo(byte iterationConverged,
                    byte stateValueReferencesChanged,
                    byte stateValuesChanged,
                    byte terminateSimulation,
                    byte upcomingTimeEvent,
                    double nextEventTime)

Instantiate a Java structure that that represents the C structure that contains information about events.

This is for FMI-1.0

Parameters:

iterationConverged - C type: fmiBoolean

stateValueReferencesChanged - C type: fmiBoolean

stateValuesChanged - C type: fmiBoolean

terminateSimulation - C type: fmiBoolean

upcomingTimeEvent - C type: fmiBoolean

nextEventTime - C type: fmiReal

Method Detail

getFieldOrder

protected java.util.List getFieldOrder()

Return the field names in the proper order.

This is new in jna-3.5.0.

Specified by:

getFieldOrder in class com.sun.jna.Structure

Returns:

a list of strings that name the fields in order.

initFieldOrder

@Deprecated
protected void initFieldOrder()

Deprecated. As of jna-3.5.0, use getFieldOrder() instead.

Set the initialization order of the fields so that the order matches the order of the C structure.