wxArt2D
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
a2dIOHandlerGDSIn Class Reference

Input driver for GDSII files. More...

#include <gdsio.h>

Inheritance diagram for a2dIOHandlerGDSIn:
Inheritance graph
[legend]
Collaboration diagram for a2dIOHandlerGDSIn:
Collaboration graph
[legend]

Public Member Functions

bool LinkReferences ()
 
virtual bool CanLoad (a2dDocumentInputStream &stream, const wxObject *obj=NULL, wxClassInfo *docClassInfo=NULL)
 Should return true if the handler can read from the stream. More...
 
virtual bool Load (a2dDocumentInputStream &stream, wxObject *doc)
 override to read the stream and store (part of) the contents in to a specific a2dDocument or othere object. More...
 
virtual void InitializeLoad ()
 Inits the handler for reading.
 
virtual void ResetLoad ()
 Reset the handler after loading.
 
void SetFontType (a2dFontType fontType)
 
void SetReadAsCameleon (bool asCameleons)
 
bool GetReadAsCameleon ()
 
- Public Member Functions inherited from a2dIOHandlerStrIn
 a2dIOHandlerStrIn (wxMBConv &conv=wxConvUTF8)
 constructor
 
 ~a2dIOHandlerStrIn ()
 destructor
 
wxClassInfo * GetDocumentClassInfo () const
 class info for the (document) class this handler reads data into.
 
void SetDocumentClassInfo (wxClassInfo *docClassInfo)
 class info for the (document) class this handler reads data into.
 
void SetFileName (const wxFileName &filename)
 
const wxFileName & GetFileName () const
 
- Public Member Functions inherited from a2dIOHandler
 a2dIOHandler ()
 constructor
 
 ~a2dIOHandler ()
 destructor
 
virtual wxObject * CreateObject (const wxString &symbolicName)
 Creates an specific object by name. More...
 
- Public Member Functions inherited from a2dRefMap
 a2dRefMap ()
 constructor
 
 ~a2dRefMap ()
 destructor
 
virtual void Initialize ()
 initialize mapping tables
 
a2dHashMapIntToObject & GetObjectHashMap ()
 This is used to find multiple referenced objects by id.
 
a2dHashMapCreateObject & GetObjectCreateHashMap ()
 has to map symbolic names to real classnames.
 
a2dResolveIdList & GetResolveIdList ()
 list of not resolved objects
 
bool ResolveOrAdd (a2dSmrtPtr< a2dObject > *storedHere, const wxString &id=wxT(""))
 try to resolve the object that is in storedHere when it is a reference. More...
 
bool ResolveOrAdd (a2dAutoZeroPtr< a2dObject > *storedHere, const wxString &id=wxT(""))
 try to resolve the object that is in storedHere when it is a reference.
 
bool ResolveOrAddLink (a2dObject *obj, const wxString &id=wxT(""))
 try to resolve an object referenced by obj using the LinkReference function
 
void ResolveInform (a2dObject *obj)
 call the objects LinkReference function (ptr=0) to inform it that links are done
 
void SetLastObjectLoadedId (const wxString &lastid)
 set by RefObject when finding a reference id during loading.
 
virtual bool LinkReferences (bool ignoreNonResolved=false)
 link references to their destination More...
 
bool RemoveReference (const wxString &idToRemove)
 remove given reference if from reference map.
 
a2dError GetLastError () const
 get last error encountered
 
void SetLastError (a2dError error)
 set last error encountered
 
- Public Member Functions inherited from a2dObject
virtual bool ProcessEvent (wxEvent &event)
 
bool SearchDynamicEventTable (wxEvent &event)
 
void Connect (int winid, int lastId, int eventType, wxObjectEventFunction func, wxObject *userData=(wxObject *) NULL, wxEvtHandler *eventSink=(wxEvtHandler *) NULL)
 
bool Disconnect (int winid, int lastId, wxEventType eventType, wxObjectEventFunction func=NULL, wxObject *userData=(wxObject *) NULL, wxEvtHandler *eventSink=(wxEvtHandler *) NULL)
 
void ProcessConnectedEvent (wxEvent &event)
 wxCHECK_VERSION(2,9,0) More...
 
void ConnectEvent (wxEventType type, wxEvtHandler *eventSink)
 
bool DisconnectEvent (wxEventType type, wxEvtHandler *eventSink)
 
bool DisconnectEventAll (wxEvtHandler *eventSink)
 Remove all dynamic events in classA, going to classB (eventSink) More...
 
 a2dObject ()
 constructor
 
virtual ~a2dObject ()
 destructor
 
void operator= (const a2dObject &other)
 assignment operator
 
int GetOwnedBy ()
 like it to be protected, but this does not work with wxList macros More...
 
virtual a2dObjectSetNonDynamic ()
 Call to mark this object as non-dynamic (static/local/auto) More...
 
void CheckReferences ()
 Check zero reference count and delete if count is 0. More...
 
a2dObjectClone (CloneOptions options, a2dRefMap *refs=NULL) const
 create an exact copy of this property
 
 a2dObject (const a2dObject &other, CloneOptions options, a2dRefMap *refs)
 
virtual wxString GetName () const
 Returns the name of this object, if no name is given the internal id will be returned. More...
 
virtual void SetName (const wxString &name)
 Creates the a2dStringProperty PROPID_Name. More...
 
virtual bool IsTemporary_DontSave () const
 Check if this is a temporary object, which should not be saved.
 
void SaveAsDocument (a2dIOHandlerXmlSerOut &out)
 Save this object and all below as an XML document. More...
 
virtual void Save (wxObject *parent, a2dIOHandlerXmlSerOut &out, a2dObjectList *towrite)
 write all needed to an XML type of file called the CVG format More...
 
void LoadFromDocument (a2dIOHandlerXmlSerIn &parser)
 Load this object and all below from an XML document. More...
 
virtual void Load (wxObject *parent, a2dIOHandlerXmlSerIn &parser)
 load object from CVG file More...
 
wxInt64 GetUniqueSerializationId () const
 return a unique id for this object More...
 
virtual bool AlwaysWriteSerializationId () const
 If true, always write an id. More...
 
virtual bool LinkReference (a2dObject *other)
 link a reference in the object to the given value More...
 
virtual void ResolveInform ()
 inform an object that reference resolution was done More...
 
void Walker (wxObject *parent, a2dWalkerIOHandler &handler)
 This is used to recursively walk through an object tree.
 
void SetCheck (bool check)
 general flag use at will. More...
 
bool GetCheck () const
 general flag use at will.
 
void SetRelease (bool value)
 set release flag More...
 
bool GetRelease () const
 get release flag More...
 
a2dAutoZeroPtr< a2dObject > ** GetAutoZeroPtrList ()
 return the list head pointer for autozero pointers to this object More...
 
 DECLARE_PROPERTIES ()
 
a2dNamedPropertyGetProperty (const a2dPropertyId *propertyId, a2dPropertyId::Flags flags=a2dPropertyId::flag_none) const
 get property on this object More...
 
void SetProperty (a2dNamedProperty *propertyHolder, a2dPropertyId::SetFlags flags=a2dPropertyId::set_none)
 Set the property to the this object. More...
 
void SetProperty (const a2dNamedProperty &propertyHolder, a2dPropertyId::SetFlags flags=a2dPropertyId::set_none)
 Set the property to the this object and if enabled, to all childs and object members. More...
 
virtual a2dNamedPropertyFindProperty (const a2dPropertyId *id, a2dPropertyId::Flags flags=a2dPropertyId::flag_none)
 Find a dynamic property with given id in the property list. More...
 
virtual const a2dNamedPropertyFindProperty (const a2dPropertyId *id, a2dPropertyId::Flags flags=a2dPropertyId::flag_none) const
 Find a dynamic property with given id in the property list. More...
 
virtual bool HasProperty (const a2dPropertyId *id, const wxString &stringvalue=wxEmptyString) const
 Check if the object has a property with given id and string representation. More...
 
virtual void OnPropertyChanged (const a2dPropertyId *id)
 This function is called after a property changed. More...
 
virtual bool EditProperties (const a2dPropertyId *id, bool withUndo=true)
 edit properties of the object More...
 
void TakeOverProperties (a2dObject *from, a2dPropertyIdList *listOfIds)
 Properties in the id list are taken from the given object, en set to this. More...
 
wxURI GetURI () const
 quick way to get to PROPID_URI property More...
 
void SetURI (const wxURI &url)
 quickly set a property PROPID_URI More...
 
const a2dNamedPropertyListGetPropertyList () const
 Get the Property List. More...
 
bool HasDynamicProperties () const
 test if there are dynamic properties in the m_propertylist
 
virtual bool RemoveProperty (const a2dPropertyId *id, bool all=true)
 This function is called by a2dPropertyId to remove a property from the list. More...
 
void RemoveTemporaryProperties ()
 remove all temporary properties
 
virtual bool AddProperty (a2dNamedProperty *property)
 This function is called by a2dPropertyId to add a property to the list. More...
 

Protected Member Functions

void SetDataTypeProperty (a2dCanvasObject *toobject, wxUint16 type)
 
unsigned int ReadUnsignedInt ()
 
int ReadInt ()
 
long ReadLong ()
 
float ReadFloat ()
 
double ReadDouble ()
 
void gds2double (unsigned char fb[])
 convert a gdsii real to a machine real More...
 
void ReadGdsII ()
 
bool ReadBgnlib ()
 
bool ReadProperty ()
 
bool ReadBoundary (a2dCanvasObject *parent)
 
bool ReadPath (a2dCanvasObject *parent)
 
bool ReadText (a2dCanvasObject *parent)
 
bool ReadStructureReference (a2dCanvasObject *parent)
 
bool ReadStructureCameleonReference (a2dCanvasObject *parent)
 
bool ReadArrayReference (a2dCanvasObject *parent)
 
bool ReadNode (a2dCanvasObject *parent)
 
bool ReadBox (a2dCanvasObject *parent)
 
bool ReadElflags (a2dCanvasObject *object)
 
bool ReadGdsHeader ()
 
bool ReadLayer (a2dCanvasObject *object)
 
bool ReadLayer (int &layer)
 
bool ReadLibraryName ()
 
bool ReadLibrarySettings ()
 
bool Read (a2dPoint2D &_Point)
 
bool ReadStrans (Strans &_Strans)
 
bool ReadStructure (a2dCanvasObject *parent)
 
bool ReadCameleonStructure (a2dCanvasObject *parent)
 
bool ReadElement (a2dCanvasObject *parent)
 
bool ReadTextBody ()
 
bool Read (a2dVertexList *segments)
 
bool Read (a2dPolygonL *polygon)
 
bool ReadHeader (int type)
 
void SkipData ()
 skip the date of the last read record
 
void ReadString (wxString &a_string)
 read string data for Text element, structure names etc.
 
- Protected Member Functions inherited from a2dIOHandlerStrIn
void SetMode (wxEOL mode=wxEOL_NATIVE)
 define the line end mode for textual files
 
wxEOL GetMode ()
 get line end mode for textual files
 
char Peek ()
 
char GetC ()
 
a2dIOHandlerStrInSeekI (wxFileOffset pos)
 set stream at a position
 
bool Eof () const
 
bool IsOk () const
 
size_t Read (char *buffer, size_t size)
 
- Protected Member Functions inherited from a2dObject
virtual bool DoIgnoreIfNotMember (const a2dPropertyId *id) const
 used to decide if a property shall be ignored, if it is not a member More...
 
virtual void DoWalker (wxObject *parent, a2dWalkerIOHandler &handler)
 iterate over this object and its children More...
 

Protected Attributes

bool m_back
 last read record is stored
 
TWO_G_BYTE_UNSIGNED_INTEGER m_recordsize
 size of the last read record
 
G_BYTE m_recordtype
 recordtype of last read record
 
G_BYTE m_datatype
 the type of the data in the last read record
 
std::vector< int > m_mapping
 mapping of GDSII layers to internal layers
 
a2dCanvasDocumentm_doc
 the document to store/load the data found into
 
double m_userunits_out
 
int m_objectFlags
 
a2dFontType m_fontType
 
wxString m_strucname
 structure that is being read at the moment
 
int m_refMaxx
 
int m_dx
 
int m_dy
 
bool m_asCameleons
 
- Protected Attributes inherited from a2dIOHandlerStrIn
wxFileName m_filename
 
wxMBConv & m_conv
 unicode conversion
 
a2dDocumentInputStreamm_streami
 file or other string stream containing the format to parse.
 
wxClassInfo * m_docClassInfo
 Run-time class information that allows document instances to be constructed dynamically.
 
wxEOL m_mode
 end of line mode
 
- Protected Attributes inherited from a2dRefMap
a2dHashMapIntToObject m_objecthashmap
 This is used to find multiple referenced objects by id.
 
a2dHashMapCreateObject m_objectCreate
 This is used to find a classname using a symbolic name.
 
a2dResolveIdList m_toResolve
 refernces to object which have not bin resolved yet ( e.g not read yet, but already referenced )
 
wxString m_lastObjectId
 
a2dError m_lastError
 set to last error found when parsing
 
- Protected Attributes inherited from a2dObject
a2dNamedPropertyList m_propertylist
 properties
 
int m_refcount
 how many references to this object do exist
 
bool m_check: 1
 used for linking multiple referenced objects when serializing
 
bool m_release: 1
 when set object is treated as being deleted, and wil be deleted in idle time.
 
bool m_recursion_active: 1
 this is used as a recursion stopper
 
bool m_pendingDisconnects: 1
 
unsigned int m_iteratorCount
 
a2dAutoZeroPtr< a2dObject > * m_autozeroptrlist
 this is a list of all a2dAutoZeroPtr object pointing to this object
 

Additional Inherited Members

- Public Types inherited from a2dObject
enum  CloneOptions {
  clone_members = 0x00000001, clone_properties = 0x00000002, clone_childs = 0x00000004, clone_unused = 0x00000008,
  clone_setoriginal = 0x00000010, clone_seteditcopy = 0x00000020, clone_noReference = 0x00000040, clone_noCameleonRef = 0x00000080,
  clone_toDrag = 0x00000100, clone_flat = 0x00000000, clone_deep = clone_members | clone_properties | clone_childs
}
 options for cloning More...
 
typedef a2dAutoZeroPtr< a2dObjectTAutoZeroPtrListClass
 this is needed inside the smart pointer template code
 
- Static Public Attributes inherited from a2dObject
static a2dPropertyIdBoolPROPID_Check = NULL
 used for linking multiple referenced objects when serializing
 
static a2dPropertyIdUriPROPID_URI = NULL
 attach an URL to the object
 
static a2dPropertyIdStringPROPID_Name = NULL
 Name property, to return name of this object.
 
static a2dPropertyIdVoidPtrPROPID_autozeroptrlist = NULL
 
static const a2dSignal sm_Edit_properties = wxNewId()
 edit properties event, see EditProperties()
 
- Protected Types inherited from a2dObject
enum  { refcount_nondynamic = 0x76543210 }
 special refcount value for non-dynamic objects
 

Detailed Description

Input driver for GDSII files.

Every record in the GDSII file is read/mapped into the right internal structure The GDSII file is parsed according to the BNF of the GDSII format. Info on the different record types that are read can be found in the GDSII format manual All basic data types are read using a specialized function that now how those types are stored in GDSII. For layers settings this handler checks for a file with the same name as the document that is loaded, but with extension ".cvg", if it does exist it will be used to read layers (in CVG format).

Definition at line 223 of file gdsio.h.

Member Function Documentation

bool a2dIOHandlerGDSIn::CanLoad ( a2dDocumentInputStream stream,
const wxObject *  obj = NULL,
wxClassInfo *  docClassInfo = NULL 
)
virtual

Should return true if the handler can read from the stream.

A typical implementation is to read the first part of the file, to see if the contents is right for this handler. Then it resets the file pointer to the beginning again.

In general a handler is written with a certain type of document in mind, since that is where the information will be stored. The document view framework, uses document templates to get to input handlers. The last 2 parameters can be checked if set. Use SetDocumentClassInfo() to set the right classinfo, in case of a derived document object, which still can be read with the this handler. Like:

keyhin->SetDocumentClassInfo( &MyDocument::ms_classInfo );
Parameters
streamthe open stream which its header can be tested
objto check and load the data into, needs to be casted to the right one internal.
docClassInfoto check if the inout handler is indeed able to read document of m_docClassInfo.

Implements a2dIOHandlerStrIn.

Definition at line 902 of file gdsio.cpp.

void a2dIOHandlerGDSIn::gds2double ( unsigned char  fb[])
protected

convert a gdsii real to a machine real

convert a gds double to a machine double input arguments : unsigned char fb[] 8byte array with gds double output arguments : unsigned char fb[] 8byte array with machine double

Definition at line 287 of file gdsio.cpp.

bool a2dIOHandlerGDSIn::Load ( a2dDocumentInputStream stream,
wxObject *  obj 
)
virtual

override to read the stream and store (part of) the contents in to a specific a2dDocument or othere object.

Understand that a a2dDocument itself is useless for storing data, so it needs to be casted internal.

Parameters
streamthe open stream to load from
objto load the data into, needs to be casted to the right one internal.

Implements a2dIOHandlerStrIn.

Definition at line 951 of file gdsio.cpp.

bool a2dIOHandlerGDSIn::ReadHeader ( int  type)
protected

read the specified record type from the GDSII file if the last record is not this type, it is stored for the next read

Definition at line 1184 of file gdsio.cpp.


The documentation for this class was generated from the following files:
a2dIOHandlerGDSIn Class Reference -- Sun Oct 12 2014 17:04:40 -- Sun Oct 12 2014 -- 1.8.5 -- wxArt2D -- . -- Main Page Reference Documentation