com.ohrasys.cad.gds
Class GDSFormatRecord

java.lang.Object
  extended by com.ohrasys.cad.gds.GDSRecord
      extended by com.ohrasys.cad.gds.GDSFormatRecord

public class GDSFormatRecord
extends GDSRecord

Represents a GDSII FORMAT record.

Please see The GDSII techincal reference for a more complete discussion of the GDSII stream syntax.

Since:
1.5

Field Summary
static short EDSIII_ARCHIVED
          Indicates the library is an EDSIII archived library
static short EDSIII_FILTERED
          Indicates the library is an EDSIII filtered library
static short GDSII_ARCHIVED
          Indicates the library is a GDSII archived library
static short GDSII_FILTERED
          Indicates the library is a GDSII filtered library
 
Fields inherited from class com.ohrasys.cad.gds.GDSRecord
ANGLE, AREF, AREF_ELEM_TYPE, ATTRTABLE, BGNEXTN, BGNLIB, BGNSTR, BIT_ARRAY_TYPE, BORDER, BOUNDARY, BOUNDARY_ELEM_TYPE, BOX, BOX_ELEM_TYPE, BOXTYPE, COLROW, CONTACT, CONTACT_ELEM_TYPE, data, DATATYPE, dattype, DOUBLE_TYPE, ELFLAGS, ELKEY, ENDEL, ENDEXTN, ENDLIB, ENDMASKS, ENDSTR, FLOAT_TYPE, FONTS, FORMAT, GENERATIONS, HARDFENCE, HARDWIRE, HEADER, i18n, INT_TYPE, LAYER, length, LIBDIRSIZE, LIBNAME, LIBSECUR, LINKKEYS, LINKTYPE, MAG, MASK, MAX_REC_LEN, NO_DATA_TYPE, NODE, NODE_ELEM_TYPE, NODEPORT, NODETYPE, NULL, PATH, PATH_ELEM_TYPE, PATHPORT, PATHTYPE, PLEX, PRESENTATION, PROPATTR, PROPVALUE, rectype, REFLIBS, RESERVED, SHORT_TYPE, SNAME, SOFTFENCE, SOFTWIRE, SPACER_ERROR, SPACING, SREF, SREF_ELEM_TYPE, SRFNAME, STRANS, STRCLASS, STRING, STRING_TYPE, STRNAME, STRTYPE, STYPTABLE, TAPECODE, TAPENUM, TEXT, TEXT_ELEM_TYPE, TEXTNODE, TEXTTYPE, UINTEGER, UNITS, USERCONSTRAINT, USTRING, WIDTH, XY
 
Constructor Summary
GDSFormatRecord(GDSRecord rec)
          Creates a new GDSFormatRecord object from an existing record.
GDSFormatRecord(short format)
          Creates a new GDSFormatRecord object.
GDSFormatRecord(short length, byte rectype, byte dattype, byte[] data)
          Creates a new GDSFormatRecord object.
 
Method Summary
 short getFormat()
          Returns the format of the library.
 void setFormat(short format)
          Sets the library format.
 java.lang.String toString()
          Returns a description of the record.
 
Methods inherited from class com.ohrasys.cad.gds.GDSRecord
getData, getDattype, getLength, getRectype, toBytes, validateBitarrayRec, validateDoubleRec, validateDoubleRec, validateDoubleRec, validateFloatRec, validateFloatRec, validateFloatRec, validateIntRec, validateIntRec, validateIntRec, validateNodataRec, validateShortRec, validateShortRec, validateShortRec, validateStringRec, validateStringRec
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

GDSII_ARCHIVED

public static final short GDSII_ARCHIVED
Indicates the library is a GDSII archived library

See Also:
Constant Field Values

GDSII_FILTERED

public static final short GDSII_FILTERED
Indicates the library is a GDSII filtered library

See Also:
Constant Field Values

EDSIII_ARCHIVED

public static final short EDSIII_ARCHIVED
Indicates the library is an EDSIII archived library

See Also:
Constant Field Values

EDSIII_FILTERED

public static final short EDSIII_FILTERED
Indicates the library is an EDSIII filtered library

See Also:
Constant Field Values
Constructor Detail

GDSFormatRecord

public GDSFormatRecord(GDSRecord rec)
                throws GDSRecordException
Creates a new GDSFormatRecord object from an existing record.

Parameters:
rec - The base record.
Throws:
GDSRecordException - If the record is not a valid FORMAT record.

GDSFormatRecord

public GDSFormatRecord(short format)
                throws GDSRecordException
Creates a new GDSFormatRecord object.

Parameters:
format - The library format.
Throws:
GDSRecordException - If the format is not one of GDSII_ARCHIVE, GDSII_FILTERED, EDSIII_ARCHIVE, EDSIII_FILTERED.

GDSFormatRecord

public GDSFormatRecord(short length,
                       byte rectype,
                       byte dattype,
                       byte[] data)
                throws GDSRecordException
Creates a new GDSFormatRecord object.

Parameters:
length - The record length.
rectype - The record type.
dattype - The data type.
data - The record data.
Throws:
GDSRecordException - If the record is malformed.
Method Detail

getFormat

public short getFormat()
Returns the format of the library.

Returns:
one of GDSII_ARCHIVE, GDSII_FILTERED, EDSIII_ARCHIVE, EDSIII_FILTERED.

setFormat

public void setFormat(short format)
               throws GDSRecordException
Sets the library format.

Parameters:
format - The format.
Throws:
GDSRecordException - If the format is not one of GDSII_ARCHIVE, GDSII_FILTERED, EDSIII_ARCHIVE, EDSIII_FILTERED.

toString

public java.lang.String toString()
Returns a description of the record.

Overrides:
toString in class GDSRecord
Returns:
A string representation of the record.