org.g_node.nix.util

Class Util

java.lang.Object

org.g_node.nix.util.Util

@Platform(include="<nix/util/util.hpp>") @Platform(value="linux",link="nix@.1",preload="hdf5@.7") @Platform(value="windows",link="nix",preload={"hdf5","msvcp120","msvcr120","szip","zlib"})
 @Namespace(value="nix::util")
public class Util
extends Object

Util

This class contains utility functions.

Constructor Summary

Constructors

Constructor and Description
Util()

Method Summary

Modifier and Type	Method and Description
static void	applyPolynomial(double[] coefficients, double origin, double[] input, double[] output, long n) Apply polynomial.
static double	convertToKelvin(String unit, double value) Converts temperatures given in degrees Celsius of Fahrenheit to Kelvin.
static long	convertToKelvin(String unit, long value) Converts temperatures given in degrees Celsius of Fahrenheit to Kelvin.
static double	convertToSeconds(String unit, double value) Converts temperatures given in degrees Celsius of Fahrenheit to Kelvin.
static long	convertToSeconds(String unit, long value) Converts temperatures given in degrees Celsius of Fahrenheit to Kelvin.
static String	createId() Generates an ID-String.
static String	deblankString(String str) Remove blank spaces from the entire string
static double	getSIScaling(String originUnit, String destinationUnit) Get the scaling between two SI units that are identified by the two strings.
static boolean	isAtomicSIUnit(String unit) Checks if the passed string represents a valid SI unit.
static boolean	isCompoundSIUnit(String unit) Checks if the passed string is a valid combination of SI units.
static boolean	isScalable(List<String> unitsA, List<String> unitsB) Returns whether or not in all cases the units at the same index in the two given unit vectors are scalable versions of the same SI unit.
static boolean	isScalable(String unitA, String unitB) Returns whether or not two units represent scalable versions of the same SI unit.
static boolean	isSetAtSamePos(List<String> stringsA, List<String> stringsB) Returns whether or not in all cases the strings at the same index in the two given string vectors are either both set or both not set (empty).
static boolean	isSIUnit(String unit) Checks if the passed string represents a valid SI unit.
static boolean	nameCheck(String name) Check if the name is legit or needs the nameSanitizer(String)
static String	nameSanitizer(String name) Replace forbidden chars in name string
static List<String>	splitCompoundUnit(String compoundUnit) Splits a SI unit compound into its atomic parts.
static String[]	splitUnit(String fullUnit) Splits an SI unit into prefix, unit and the power components.
static void	splitUnit(String fullUnit, org.bytedeco.javacpp.BytePointer prefix, org.bytedeco.javacpp.BytePointer unit, org.bytedeco.javacpp.BytePointer power)
static <T extends Entity> String	toId(T entity) Extract id from given entity.
static <T extends NamedEntity> String	toName(T entity) Extract name from given entity.
static String	unitSanitizer(String unit) Sanitizer function that deblanks units and replaces mu and µ with the "u" replacement.

Methods inherited from class java.lang.Object

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

Constructor Detail

Util

public Util()

Method Detail

deblankString

public static String deblankString(String str)

Remove blank spaces from the entire string

Parameters:

str - The string to trim.

nameSanitizer

@StdString
public static String nameSanitizer(@StdString
                                              String name)

Replace forbidden chars in name string

Parameters:

name - The string to sanitize

Returns:

The sanitized string

nameCheck

@ByVal
public static boolean nameCheck(@StdString
                                       String name)

Check if the name is legit or needs the nameSanitizer(String)

Parameters:

name - The string to check

Returns:

true if name is legit, false otherwise

createId

@StdString
public static String createId()

Generates an ID-String.

Returns:

The generated id string.

toId

public static <T extends Entity> String toId(T entity)

Extract id from given entity. Does not work for dimensions

Returns:

The entity id.

toName

public static <T extends NamedEntity> String toName(T entity)

Extract name from given entity. Does not work for dimensions

Returns:

The entity name.

unitSanitizer

@StdString
public static String unitSanitizer(@StdString
                                              String unit)

Sanitizer function that deblanks units and replaces mu and µ with the "u" replacement.

Parameters:

unit - The old unit.

Returns:

The sanitized unit.

isSIUnit

public static boolean isSIUnit(@StdString
                               String unit)

Checks if the passed string represents a valid SI unit. The passed unit may be atomic, e.g. 'V' or a compound unit, e.g. 'J/s'.

Parameters:

unit - A string that is supposed to represent an SI unit.

Returns:

True if a valid SI unit, false otherwise.

isAtomicSIUnit

public static boolean isAtomicSIUnit(@StdString
                                     String unit)

Checks if the passed string represents a valid SI unit.

Parameters:

unit - A string that is supposed to represent an SI unit.

Returns:

True if a valid SI unit, false otherwise.

isCompoundSIUnit

public static boolean isCompoundSIUnit(@StdString
                                       String unit)

Checks if the passed string is a valid combination of SI units.

For example mV^2*Hz^-1. Method accepts only the * notation.

Parameters:

unit - A string that should be tested

Returns:

True if a valid compound si unti, false otherwise.

isScalable

public static boolean isScalable(@StdString
                                 String unitA,
                                 @StdString
                                 String unitB)

Returns whether or not two units represent scalable versions of the same SI unit.

Parameters:

unitA - A string representing the first unit.

unitB - A string representing the second unit.

Returns:

True if the units are scalable version of the same unit.

isScalable

public static boolean isScalable(List<String> unitsA,
                                 List<String> unitsB)

Returns whether or not in all cases the units at the same index in the two given unit vectors are scalable versions of the same SI unit.

Parameters:

unitsA - A vector of unit strings.

unitsB - A vector of unit strings.

Returns:

True if the units are scalable version of the same unit.

isSetAtSamePos

public static boolean isSetAtSamePos(List<String> stringsA,
                                     List<String> stringsB)

Returns whether or not in all cases the strings at the same index in the two given string vectors are either both set or both not set (empty).

Parameters:

stringsA - A list of unit strings.

stringsB - A list of unit strings.

Returns:

True if the units are scalable version of the same unit.

getSIScaling

public static double getSIScaling(@StdString
                                  String originUnit,
                                  @StdString
                                  String destinationUnit)

Get the scaling between two SI units that are identified by the two strings.

Parameters:

originUnit - The original unit

destinationUnit - The one into which a scaling should be done

Returns:

A double with the appropriate scaling

splitUnit

public static void splitUnit(@StdString
                             String fullUnit,
                             @ByRef @StdString
                             org.bytedeco.javacpp.BytePointer prefix,
                             @ByRef @StdString
                             org.bytedeco.javacpp.BytePointer unit,
                             @ByRef @StdString
                             org.bytedeco.javacpp.BytePointer power)

splitUnit

public static String[] splitUnit(String fullUnit)

Splits an SI unit into prefix, unit and the power components.

Parameters:

fullUnit - unit

Returns:

array with prefix, unit, power

splitCompoundUnit

public static List<String> splitCompoundUnit(@StdString
                                             String compoundUnit)

Splits a SI unit compound into its atomic parts.

Parameters:

compoundUnit - An SI unit that consists of many atomic units

convertToSeconds

public static double convertToSeconds(@StdString
                                      String unit,
                                      double value)

Converts temperatures given in degrees Celsius of Fahrenheit to Kelvin.

Parameters:

unit - The original unit {"F", "°F", "C", "°C"}

value - The original value

Returns:

The temperature in Kelvin

convertToSeconds

public static long convertToSeconds(@StdString
                                    String unit,
                                    long value)

Converts temperatures given in degrees Celsius of Fahrenheit to Kelvin.

Parameters:

unit - The original unit {"F", "°F", "C", "°C"}

value - The original value

Returns:

The temperature in Kelvin

convertToKelvin

public static double convertToKelvin(@StdString
                                     String unit,
                                     double value)

Converts temperatures given in degrees Celsius of Fahrenheit to Kelvin.

Parameters:

unit - The original unit {"F", "°F", "C", "°C"}

value - The original value

Returns:

The temperature in Kelvin

convertToKelvin

public static long convertToKelvin(@StdString
                                   String unit,
                                   long value)

Converts temperatures given in degrees Celsius of Fahrenheit to Kelvin.

Parameters:

unit - The original unit {"F", "°F", "C", "°C"}

value - The original value

Returns:

The temperature in Kelvin

applyPolynomial

public static void applyPolynomial(@StdVector
                                   double[] coefficients,
                                   double origin,
                                   @Const
                                   double[] input,
                                   double[] output,
                                   @Cast(value="size_t")
                                   long n)

Apply polynomial.

Parameters:

coefficients - coefficients

origin - origin

input - input

output - output

n - n