com.highqsoft.transformer

Class ASAMODSHelper

java.lang.Object

com.highqsoft.transformer.ASAMODSHelper

public class ASAMODSHelper
extends java.lang.Object

Helper for ASAM ODS definitions.

Since:

$Date: 2017/04/06 13:30:33 $

Version:

$Revision: 1.9 $

Author:

Andreas Hofmann

See Also:

Field Summary

Fields

Modifier and Type	Field and Description
static short	INVALID The invalid flag.
static short	VALID The valid flag.

Constructor Summary

Constructors

Constructor and Description
ASAMODSHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static ApplicationElement	getApplicationElement(ApplicationStructure asObj, java.lang.String name, java.lang.String basename, java.lang.String id) Get the application element belongs to the given description.
static InstanceElement	getInstanceElement(ApplicationStructure asObj, ApplicationElement aeObj, java.lang.String name, java.lang.String path, java.lang.String id) Get the instance element belongs to the given description.
static long	toLong(T_LONGLONG id) Get long presentation of a T_LONGLONG.
static T_LONGLONG	toLongLong(long id) Get T_LONGLONG presentation of a long.
static java.lang.String	toString(AoException aoException) Get the string of the AoException.
static java.lang.String	toString(DataType dt) This method returns the value of a DataType as a string.
static java.lang.String	toString(SeverityFlag sevFlag) Get the string of the SeverityFlag.
static java.lang.String	toString(TS_Union union) Convert a TS_Union structure to a string.

Methods inherited from class java.lang.Object

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

Field Detail

VALID

public static final short VALID

The valid flag.

See Also:

Constant Field Values

INVALID

public static final short INVALID

The invalid flag.

See Also:

Constant Field Values

Constructor Detail

ASAMODSHelper

public ASAMODSHelper()

Method Detail

getApplicationElement

public static ApplicationElement getApplicationElement(ApplicationStructure asObj,
                                       java.lang.String name,
                                       java.lang.String basename,
                                       java.lang.String id)
                                                throws AoException,
                                                       java.text.ParseException

Get the application element belongs to the given description.

Parameters:

asObj - The application structure.

name - The optional name.

basename - The optional basename, if more than one are defined the method returns the first.

id - The optional id.

Returns:

The application element.

Throws:

AoException - If ASAM ODS API returns an error.

java.text.ParseException - If the id was not parseable.

getInstanceElement

public static InstanceElement getInstanceElement(ApplicationStructure asObj,
                                 ApplicationElement aeObj,
                                 java.lang.String name,
                                 java.lang.String path,
                                 java.lang.String id)
                                          throws AoException,
                                                 java.text.ParseException

Get the instance element belongs to the given description.

Parameters:

asObj - The application structure, it is required only if path is available.

aeObj - The application element, it is not required if the path is available.

name - The name of the instance

path - The ASAM path of the instance

id - The id of the instance

Returns:

The instance element.

Throws:

AoException - If ASAM ODS API returns an error.

java.text.ParseException - If the id was not parseable.

toString

public static java.lang.String toString(AoException aoException)

Get the string of the AoException.

Parameters:

aoException - the exception.

Returns:

the string, which represent the AoException.

toString

public static java.lang.String toString(SeverityFlag sevFlag)

Get the string of the SeverityFlag.

Parameters:

sevFlag - the severity flag.

Returns:

the string, which represent the severity flag.

toString

public static java.lang.String toString(DataType dt)

This method returns the value of a DataType as a string.

Parameters:

dt - The datatype.

Returns:

The string of the DataType.

toString

public static java.lang.String toString(TS_Union union)

Convert a TS_Union structure to a string. Currently the sequence values are not supported.

Parameters:

union - the union

Returns:

the string presentation of the union.

toLongLong

public static T_LONGLONG toLongLong(long id)

Get T_LONGLONG presentation of a long. The low part in interpreted as unsigned integer.

Parameters:

id - the long value.

Returns:

the T_LONGLONG structure

toLong

public static long toLong(T_LONGLONG id)

Get long presentation of a T_LONGLONG. The low part in interpreted as unsigned integer.

Parameters:

id - a T_LONGLONG structure

Returns:

is long.