CoreFactory

java.lang.Object
- nxm.ice.lib.CoreFactory

Direct Known Subclasses:

AU2C, AWG, CFIR, DDC, DUC, DUC2, FEC, FSVI, HOC, JVM, LRS, MFPP, MOD, None, Noop, PCIe, PKT2DAT, REC, RFP, TFDD, UDAT, UDUC, WBR
```
public class CoreFactory
extends java.lang.Object
```
Structure for a Code-Once-Run-Everywhere library function Structure for a Hardware Abstraction Library Object This function may have implementations in more than one language. The NeXtMidas policy is to code CORE functions in C or Fortran to allow code sharing with other versions of Midas. All other framework and GUI code is in Java for portability and deployment options. Typically, math functions needed by GUIs are included in the SYS tree. Some functions are coded here in Java and in C for performance comparisons. The Java code for each function library exposes methods for setting and getting each of the library's properties. If native code is used, the Java wrapper loads the native code and calls the standard library interface routines as appropriate. This class implements a factory for instantiating alternate implementations. The innerclasses of this factory comprise the supported algorithm implementations. The executable names will adhere to the following naming conventions when compiled by NeXtMidas: Foo$JVM.class - the JDK implementation of the function Foo (Java/Lime) Foo$CPU_xxx.so - the CPU native implementation of Foo (C) Foo$PHI_xxx.so - the Intel Xeon Phi accelerator card (C) Foo$GPU_xxx.so - the GPU implementation of Foo (CUDA/Lime) Foo$VHS_xxx.so - the Verilator Hardware Simulator implementation of Foo (Verilog/Lime) Foo$MLS_xxx.so - the MatLab Simulink implementation of Foo (FPGA) Foo$ICE_xxx.so - the ICE FPGA implementation of Foo (FPGA/Lime) Where xxx is an architecture dependent tag such as lin32 or arm32. These will typically be conditionally compiled from common source code Foo.jv in NeXtMidas but may be compiled differently with custom build scripts.

Author:

Jeff Schoen

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CoreFactory.TypeDef

Nested Classes
Modifier and Type	Class and Description
`static class`	`CoreFactory.TypeDef`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ARRAY`
`static int`	`BC_I`
`static int`	`BC_IIO`
`static int`	`BC_IIOO`
`static int`	`BC_IO`
`static int`	`BC_IOO`
`static int`	`BC_O`
`static int`	`BCI`
`static int`	`BCIIO`
`static int`	`BCIIOO`
`static int`	`BCIO`
`static int`	`BCIOO`
`static int`	`BCO`
`static int`	`BF_ALL`
`static int`	`BF_AXI`
`static int`	`BF_BIT`
`static int`	`BF_CXI`
`static int`	`BF_RAW`
`static int`	`BUFFER`
`static int`	`BUFSTR`
`static int`	`CORE_TYPE_FPGA`
`static int`	`CORE_TYPE_ICE`
`static int`	`CPU`
`static java.lang.String`	`defKeys`
`static java.lang.String`	`factoryList`
`static int`	`FALL`
`static int`	`FAXI`
`static int`	`FBIT`
`static int`	`FCXI`
`static int`	`FRAW`
`static int`	`FSWP`
`static int`	`GPU`
`static int`	`ICE`
`static int`	`JVM`
`static int`	`MLS`
`static int`	`PACKET`
`static int`	`PHI`
`static int`	`STREAM`
`static int`	`VERBOSE`
`static int`	`VHS`

Constructor Summary

Constructors
Constructor and Description

CoreFactory()

Constructors
Constructor and Description
`CoreFactory()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Core`	`getCore(java.lang.String name, nxm.sys.lib.Args args)` Create an instance of the function specified by name and parsing of the Args class
`static Core`	`getCore(java.lang.String path, java.lang.String name, int impl)` Create an instance of the function specified by path, name, and implementation
`static byte`	`getDataType(int impl)` get the natural data format type

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - factoryList
```
public static final java.lang.String factoryList
```
    See Also:
    
    Constant Field Values
  - JVM
```
public static final int JVM
```
    See Also:
    
    Constant Field Values
  - CPU
```
public static final int CPU
```
    See Also:
    
    Constant Field Values
  - PHI
```
public static final int PHI
```
    See Also:
    
    Constant Field Values
  - GPU
```
public static final int GPU
```
    See Also:
    
    Constant Field Values
  - MLS
```
public static final int MLS
```
    See Also:
    
    Constant Field Values
  - VHS
```
public static final int VHS
```
    See Also:
    
    Constant Field Values
  - ICE
```
public static final int ICE
```
    See Also:
    
    Constant Field Values
  - CORE_TYPE_FPGA
```
public static final int CORE_TYPE_FPGA
```
    See Also:
    
    Constant Field Values
  - CORE_TYPE_ICE
```
public static final int CORE_TYPE_ICE
```
    See Also:
    
    Constant Field Values
  - VERBOSE
```
public static final int VERBOSE
```
    See Also:
    
    Constant Field Values
  - ARRAY
```
public static final int ARRAY
```
    See Also:
    
    Constant Field Values
  - STREAM
```
public static final int STREAM
```
    See Also:
    
    Constant Field Values
  - BUFFER
```
public static final int BUFFER
```
    See Also:
    
    Constant Field Values
  - BUFSTR
```
public static final int BUFSTR
```
    See Also:
    
    Constant Field Values
  - PACKET
```
public static final int PACKET
```
    See Also:
    
    Constant Field Values
  - FRAW
```
public static final int FRAW
```
    See Also:
    
    Constant Field Values
  - FCXI
```
public static final int FCXI
```
    See Also:
    
    Constant Field Values
  - FBIT
```
public static final int FBIT
```
    See Also:
    
    Constant Field Values
  - FAXI
```
public static final int FAXI
```
    See Also:
    
    Constant Field Values
  - FALL
```
public static final int FALL
```
    See Also:
    
    Constant Field Values
  - FSWP
```
public static final int FSWP
```
    See Also:
    
    Constant Field Values
  - BCIO
```
public static final int BCIO
```
    See Also:
    
    Constant Field Values
  - BCI
```
public static final int BCI
```
    See Also:
    
    Constant Field Values
  - BCO
```
public static final int BCO
```
    See Also:
    
    Constant Field Values
  - BCIIO
```
public static final int BCIIO
```
    See Also:
    
    Constant Field Values
  - BCIOO
```
public static final int BCIOO
```
    See Also:
    
    Constant Field Values
  - BCIIOO
```
public static final int BCIIOO
```
    See Also:
    
    Constant Field Values
  - BC_IO
```
public static final int BC_IO
```
    See Also:
    
    Constant Field Values
  - BC_I
```
public static final int BC_I
```
    See Also:
    
    Constant Field Values
  - BC_O
```
public static final int BC_O
```
    See Also:
    
    Constant Field Values
  - BC_IIO
```
public static final int BC_IIO
```
    See Also:
    
    Constant Field Values
  - BC_IOO
```
public static final int BC_IOO
```
    See Also:
    
    Constant Field Values
  - BC_IIOO
```
public static final int BC_IIOO
```
    See Also:
    
    Constant Field Values
  - BF_RAW
```
public static final int BF_RAW
```
    See Also:
    
    Constant Field Values
  - BF_CXI
```
public static final int BF_CXI
```
    See Also:
    
    Constant Field Values
  - BF_BIT
```
public static final int BF_BIT
```
    See Also:
    
    Constant Field Values
  - BF_AXI
```
public static final int BF_AXI
```
    See Also:
    
    Constant Field Values
  - BF_ALL
```
public static final int BF_ALL
```
    See Also:
    
    Constant Field Values
  - defKeys
```
public static java.lang.String defKeys
```
- Constructor Detail
  - CoreFactory
```
public CoreFactory()
```
- Method Detail
  - getCore
```
public static Core getCore(java.lang.String name,
                           nxm.sys.lib.Args args)
```
    Create an instance of the function specified by name and parsing of the Args class
    
    Parameters:
    
    name - Name of core
    
    args - Command Args object
    
    Returns:
    
    Core object
  - getCore
```
public static Core getCore(java.lang.String path,
                           java.lang.String name,
                           int impl)
```
    Create an instance of the function specified by path, name, and implementation
    
    Parameters:
    
    path - Jave package path name
    
    name - Name of core
    
    impl - Implementation index
    
    Returns:
    
    Core object
  - getDataType
```
public static byte getDataType(int impl)
```
    get the natural data format type
    
    Parameters:
    
    impl - Implementation index
    
    Returns:
    
    Data type code

Class CoreFactory

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

factoryList

JVM

CPU

PHI

GPU

MLS

VHS

ICE

CORE_TYPE_FPGA

CORE_TYPE_ICE

VERBOSE

ARRAY

STREAM

BUFFER

BUFSTR

PACKET

FRAW

FCXI

FBIT

FAXI

FALL

FSWP

BCIO

BCI

BCO

BCIIO

BCIOO

BCIIOO

BC_IO

BC_I

BC_O

BC_IIO

BC_IOO

BC_IIOO

BF_RAW

BF_CXI

BF_BIT

BF_AXI

BF_ALL

defKeys

Constructor Detail

CoreFactory

Method Detail

getCore

getCore

getDataType