VisualDCT Graphical Data Reference
Project:VisualDCT 
Classification:User's Manual
Identification:CSL-MAN-02-xxxxxx
Copyright © 2002 by Cosylab Ltd. All Rights Reserved.

Document History

RevisionDateAuthorSectionModification
0.92002-10-19Matej Sekoranja
allCreated.
1.02003-07-18Matej Sekoranja
allAdded hierarchy related data.

Scope

This document specifies how VisualDCT stores its visual data about graphics layout.

Confidentiality

This document is classified as a public document. Redistribution and use, with or without modification, are permitted provided that:

  1. the copyright notice is retained
  2. a reference to the original document is made in case of modifications
  3. this document may not be distributed for profit except as explicitly permitted by valid licenses.

Audience

The audience of this document are all developers of EPICS tools wishing to create visual VisualDCT EPICS databases.

References

IDAuthorReferenceRevisionDatePublisher
1Matej SekoranjaVisualDCT Project 2002Cosylab, Ltd.
2Matej SekoranjaVisualDCT latest build2.3.12372002Cosylab, Ltd.

Table of Contents

1. Introduction

2. Reference

2.1. Data Types

2.2. EPICS Objects

2.2.1. Record

2.2.2. Group

2.2.3. Field

2.2.4. Visibility

2.2.5. Link

2.2.6. Connector

2.2.7. Template

2.2.8. Template Field

2.2.9. Ports

2.2.10. Macros

2.3. Graphical Objects

2.3.1. Line/Arrow

2.3.2. Box

2.3.3. TextBox

2.4. DBD Info Block

2.4.1. DBD Info Block

2.5. Miscellaneous

2.5.1. Skip

2.5.2. View

3. Conclusion

How to Read this Document

This document's meta-information (authors, revision history, table of contents, ...) can be found above. What follows below is the body of the document. The body is composed of several sections, which may be further composed of subsections.

Typographical styles are used to denote entities of different kinds. For a full list of entities and their respective typographic conventions, please refer to the Styles section of the XML Documentation document.

When viewing the document in a non-printed form, it is possible to submit comments regarding a given section to the document's owner. This is achieved by clicking the mail icon next to the section title. For this to work, your mail must be configured to properly handle the mailto URLs.

1.  Introduction

VisualDCT creates and maintains only one file, the record instance database (.db or .vdb) file, and does not have any additional graphical information file avoiding any possible consistency problems when having multiple files, all necessary visual composition data is stored as comments at the end of the DB file.
All visual VisualDCT data begin with #! prefix.

2.  Reference

2.1.  Data Types

2.2.  EPICS Objects

2.2.1.  Record

				  
			#! Record("recordname", xpos, ypos, color, rotated, "description")
				

Listing 1: Record visual data

2.2.2.  Group

				  
			#! Group("groupname", xpos, ypos, color, "description")
				

Listing 2: Group visual data

2.2.3.  Field

				  
			#! Field("fieldname", color, rotated, "description")
				

Listing 3: Field visual data

2.2.4.  Visibility

				  
			#! Visibility("fieldname", visibility)
			
			visibility:
				0 - NON_DEFAULT_VISIBLE
				1 - ALWAYS_VISIBLE
				2 - NEVER_VISIBLE

Listing 4: Visibility visual data

2.2.5.  Link

				  
			#! Link("fieldname", inLinkID)
				

Listing 5: Link visual data

2.2.6.  Connector

				  
			#! Connector("inLinkID", outLinkID, xpos, ypos, color, "description")
				

Listing 6: Connector visual data

2.2.7.  Template

				  
			#! TemplateInstance("id", x, y, color, "desc")
				

Listing 7: Template visual data

2.2.8.  Template Field

				  
			#! TemplateField("template instance id", "fieldName", color, isRight, visibility)
				

Listing 8: Template field visual data

2.2.9.  Ports

				  
			#! ConstantPort(portname, inLinkID, xpos, ypos, color, defaultVisibility)
			#! InputPort(portname, inLinkID, xpos, ypos, color, defaultVisibility)
			#! OutputPort(portname, inLinkID, xpos, ypos, color, defaultVisibility)
				

Listing 9: Ports field visual data

2.2.10.  Macros

				  
			#! InputMacro(macroname, description, xpos, ypos, color, defaultVisibility, textPositionNorth)
			#! OutputMacro(macroname, description, xpos, ypos, color, defaultVisibility, textPositionNorth)
				

Listing 10: Macros field visual data

2.3.  Graphical Objects

2.3.1.  Line/Arrow

				  
			#! Line(id, xpos, ypos, xpos2, ypos2, dashed, startArrow, endArrow, color, parentBorderID)
				

Listing 11: Line/Arrow visual data

2.3.2.  Box

				  
			#! Box(id, xpos, ypos, xpos2, ypos2, dashed, color, parentBorderID)
				

Listing 12: Box visual data

2.3.3.  TextBox

				  
			#! TextBox(id, xpos, ypos, xpos2, ypos2, border, fontFamilyName, fontSize, fontStyle, color, "text", parentBorderID)
				

Listing 13: TextBox visual data

2.4.  DBD Info Block

2.4.1.  DBD Info Block

				  
			#! DBDSTART
			#! DBD("DBD filename1")
			...
			#! DBD("DBD filenameN")
			#! DBDEND
				

Listing 14: DBD Info Block visual data

2.5.  Miscellaneous

2.5.1.  Skip

				  
			// skip one line
			#! SKIP
			
			// skip n lines
 			#! SKIP(number of lines)
				

Listing 15: Skip visual data

2.5.2.  View

				  
			#! View(xoffset, yoffset, scale)
				

Listing 16: Workspace view

3.  Conclusion

This document will probably change in it the future.