com.ohrasys.cad.gds
Class GDSBoxtypeRecord

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

public class GDSBoxtypeRecord
extends GDSRecord

Represents a GDSII BOXTYPE record.

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

Since:
1.5

Field Summary
 
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
GDSBoxtypeRecord(GDSRecord rec)
          Creates a new GDSBoxtypeRecord object based on an existing record.
GDSBoxtypeRecord(short boxtype)
          Creates a new GDSBoxtypeRecord object.
GDSBoxtypeRecord(short length, byte rectype, byte dattype, byte[] data)
          Creates a new GDSBoxtypeRecord object.
 
Method Summary
 short getBoxtype()
          Returns the boxtype.
 void setBoxtype(short boxtype)
          Sets the boxtype.
 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
 

Constructor Detail

GDSBoxtypeRecord

public GDSBoxtypeRecord(GDSRecord rec)
                 throws GDSRecordException
Creates a new GDSBoxtypeRecord object based on an existing record.

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

GDSBoxtypeRecord

public GDSBoxtypeRecord(short boxtype)
                 throws GDSRecordException
Creates a new GDSBoxtypeRecord object.

Parameters:
boxtype - The boxtype.
Throws:
GDSRecordException - If the record is malformed.

GDSBoxtypeRecord

public GDSBoxtypeRecord(short length,
                        byte rectype,
                        byte dattype,
                        byte[] data)
                 throws GDSRecordException
Creates a new GDSBoxtypeRecord 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

getBoxtype

public short getBoxtype()
Returns the boxtype.

Returns:
The boxtype.

setBoxtype

public void setBoxtype(short boxtype)
                throws GDSRecordException
Sets the boxtype.

Parameters:
boxtype - The new boxtype.
Throws:
GDSRecordException - If the boxtype isn't in the range of 0:255.

toString

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

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