org.ptolemy.fmi.driver
Class OutputRow

java.lang.Object
  org.ptolemy.fmi.driver.OutputRow

public class OutputRow
extends java.lang.Object

Given a fmu component, output the current state.

This class is a port of outputRow() from fmusdk/src/shared/sim_support.c which has the following license:

FMU SDK license

Copyright (c) 2008-2011, QTronic GmbH. All rights reserved. The FmuSdk is licensed by the copyright holder under the BSD License (http://www.opensource.org/licenses/bsd-license.html): Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY QTRONIC GMBH "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL QTRONIC GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Version:

$Id: OutputRow.java 64753 2012-10-02 02:05:53Z cxh $

Author:

Christopher Brooks, based on sim_support.c by QTronic GmbH.

Accepted Rating:

Red (cxh)

Proposed Rating:

Red (cxh)

Constructor Summary

private

OutputRow() This class contains only static methods, so there is no public constructor.

Method Summary

static void

outputRow(com.sun.jna.NativeLibrary nativeLibrary, FMIModelDescription fmiModelDescription, com.sun.jna.Pointer fmiComponent, double time, java.io.PrintStream file, char separator, java.lang.Boolean header) Output time and all non-alias variables in CSV format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OutputRow

private OutputRow()

This class contains only static methods, so there is no public constructor.

Method Detail

outputRow

public static void outputRow(com.sun.jna.NativeLibrary nativeLibrary,
                             FMIModelDescription fmiModelDescription,
                             com.sun.jna.Pointer fmiComponent,
                             double time,
                             java.io.PrintStream file,
                             char separator,
                             java.lang.Boolean header)

Output time and all non-alias variables in CSV format. If the separator is ',', columns are separated by ',' and '.' is used for floating-point numbers. Otherwise, the given separator (e.g. ';' or '\t') is to separate columns, and ',' is used as decimal dot in floating-point numbers.

Parameters:

nativeLibrary - The native library that contains the fmi*() functions to be invoked.

fmiModelDescription - An object that represents the modelDescription.xml file.

fmiComponent - The component being invoked.

time - The time of this row.

file - The output file

separator - The separator character.

header - True if the header containing the column names should be printed.