BinaryEDIFWriter

Object
- com.xilinx.rapidwright.edif.BinaryEDIFWriter

```
public class BinaryEDIFWriter
extends Object
```
A Writer for the RapidWright Binary EDIF Format Provides a binary alternative to textual EDIF that is ~10-15X smaller and loads 5-10X faster. This is intended as a cached version of text-based EDIF as it cannot be read by Vivado. One additional tradeoff is that it takes about 2.5-3X longer to write than text-based EDIF.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`EDIF_BINARY_FILE_TAG`
`static String`	`EDIF_BINARY_FILE_VERSION`
`static int`	`EDIF_DIR_INOUT_MASK`
`static int`	`EDIF_DIR_INPUT_MASK`
`static int`	`EDIF_DIR_OUTPUT_MASK`
`static int`	`EDIF_HAS_OWNER`
`static int`	`EDIF_MACRO_LIB`
`static int`	`EDIF_NAME_FLAG`
`static int`	`EDIF_NULL_INST`
`static int`	`EDIF_PROP_FLAG`
`static int`	`EDIF_PROP_TYPE_BIT`
`static int`	`EDIF_PROP_VALUE_MASK`
`static int`	`EDIF_RENAME_MASK`
`static int`	`EDIF_SAME_LIB_FLAG`
`static int`	`EDIF_UNIQUE_VIEW_FLAG`
`static int`	`PORT_WIDTH_MASK`

Constructor Summary

Constructors
Constructor and Description

BinaryEDIFWriter()

Constructors
Constructor and Description
`BinaryEDIFWriter()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Map<String,Integer>`	`createStringMap(EDIFNetlist netlist)` This method iterates over an entire EDIFNetlist to enumerate all Strings.
`static void`	`writeBinaryEDIF(OutputStream outputStream, EDIFNetlist netlist)`
`static void`	`writeBinaryEDIF(Path path, EDIFNetlist netlist)` Writes the provided netlist as a binary EDIF file (.bedf).
`static void`	`writeBinaryEDIF(String fileName, EDIFNetlist netlist)` Writes the provided netlist as a binary EDIF file (.bedf).
`static void`	`writeEDIFCell(EDIFCell c, com.esotericsoftware.kryo.io.Output os, Map<String,Integer> stringMap)` Writes the provided EDIFCell to Kryo-based output stream.

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

- Field Detail
  - EDIF_BINARY_FILE_TAG
```
public static final String EDIF_BINARY_FILE_TAG
```
    See Also:
    
    Constant Field Values
  - EDIF_BINARY_FILE_VERSION
```
public static final String EDIF_BINARY_FILE_VERSION
```
    See Also:
    
    Constant Field Values
  - EDIF_NAME_FLAG
```
public static final int EDIF_NAME_FLAG
```
    See Also:
    
    Constant Field Values
  - EDIF_UNIQUE_VIEW_FLAG
```
public static final int EDIF_UNIQUE_VIEW_FLAG
```
    See Also:
    
    Constant Field Values
  - EDIF_SAME_LIB_FLAG
```
public static final int EDIF_SAME_LIB_FLAG
```
    See Also:
    
    Constant Field Values
  - EDIF_PROP_FLAG
```
public static final int EDIF_PROP_FLAG
```
    See Also:
    
    Constant Field Values
  - EDIF_HAS_OWNER
```
public static final int EDIF_HAS_OWNER
```
    See Also:
    
    Constant Field Values
  - EDIF_DIR_INPUT_MASK
```
public static final int EDIF_DIR_INPUT_MASK
```
    See Also:
    
    Constant Field Values
  - EDIF_DIR_OUTPUT_MASK
```
public static final int EDIF_DIR_OUTPUT_MASK
```
    See Also:
    
    Constant Field Values
  - EDIF_DIR_INOUT_MASK
```
public static final int EDIF_DIR_INOUT_MASK
```
    See Also:
    
    Constant Field Values
  - EDIF_RENAME_MASK
```
public static final int EDIF_RENAME_MASK
```
    See Also:
    
    Constant Field Values
  - PORT_WIDTH_MASK
```
public static final int PORT_WIDTH_MASK
```
    See Also:
    
    Constant Field Values
  - EDIF_PROP_TYPE_BIT
```
public static final int EDIF_PROP_TYPE_BIT
```
    See Also:
    
    Constant Field Values
  - EDIF_PROP_VALUE_MASK
```
public static final int EDIF_PROP_VALUE_MASK
```
    See Also:
    
    Constant Field Values
  - EDIF_NULL_INST
```
public static final int EDIF_NULL_INST
```
    See Also:
    
    Constant Field Values
  - EDIF_MACRO_LIB
```
public static final int EDIF_MACRO_LIB
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BinaryEDIFWriter
```
public BinaryEDIFWriter()
```
- Method Detail
  - createStringMap
```
public static Map<String,Integer> createStringMap(EDIFNetlist netlist)
```
    This method iterates over an entire EDIFNetlist to enumerate all Strings. This is done to provide a fast lookup array at the front of the file when loading the Binary EDIF.
    
    Parameters:
    
    netlist - The netlist to include in the String map.
    
    Returns:
    
    A new map keyed by all unique strings in the netlist mapped to unique integers.
  - writeEDIFCell
```
public static void writeEDIFCell(EDIFCell c,
                                 com.esotericsoftware.kryo.io.Output os,
                                 Map<String,Integer> stringMap)
```
    Writes the provided EDIFCell to Kryo-based output stream.
    
    Parameters:
    
    c - The current cell to write
    
    os - The Kryo-based output stream
    
    stringMap - Map of string to integer enumerations to use to reference strings
    
    See Also:
    
    BinaryEDIFReader.readEDIFCell(Input, String[], EDIFLibrary, EDIFNetlist)
  - writeBinaryEDIF
```
public static void writeBinaryEDIF(String fileName,
                                   EDIFNetlist netlist)
```
    Writes the provided netlist as a binary EDIF file (.bedf). This has the advantage of being an order of magnitude smaller in size and faster to load.
    
    Parameters:
    
    fileName - Name of the file to write
    
    netlist - The current netlist to write
    
    See Also:
    
    BinaryEDIFReader.readBinaryEDIF(String)
  - writeBinaryEDIF
```
public static void writeBinaryEDIF(Path path,
                                   EDIFNetlist netlist)
```
    Writes the provided netlist as a binary EDIF file (.bedf). This has the advantage of being an order of magnitude smaller in size and faster to load.
    
    Parameters:
    
    path - Path to the file to write
    
    netlist - The current netlist to write
    
    See Also:
    
    BinaryEDIFReader.readBinaryEDIF(Path)
  - writeBinaryEDIF
```
public static void writeBinaryEDIF(OutputStream outputStream,
                                   EDIFNetlist netlist)
```

Class BinaryEDIFWriter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

EDIF_BINARY_FILE_TAG

EDIF_BINARY_FILE_VERSION

EDIF_NAME_FLAG

EDIF_UNIQUE_VIEW_FLAG

EDIF_SAME_LIB_FLAG

EDIF_PROP_FLAG

EDIF_HAS_OWNER

EDIF_DIR_INPUT_MASK

EDIF_DIR_OUTPUT_MASK

EDIF_DIR_INOUT_MASK

EDIF_RENAME_MASK

PORT_WIDTH_MASK

EDIF_PROP_TYPE_BIT

EDIF_PROP_VALUE_MASK

EDIF_NULL_INST

EDIF_MACRO_LIB

Constructor Detail

BinaryEDIFWriter

Method Detail

createStringMap

writeEDIFCell

writeBinaryEDIF

writeBinaryEDIF

writeBinaryEDIF