Scope

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

Audience

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

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

References

Document History

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

• color - RGB value representing the color (bits 24-31 are alpha, 16-23 are red, 8-15 are green, 0-7 are blue).
• boolean types - false if 0, true otherwise.

2.2. EPICS Objects

2.2.1. Record

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

2.2.2. Group

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

2.2.3. Field

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

2.2.4. Visibility

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

2.2.5. Link

				  
			#! Link("fieldname", inLinkID)
				

2.2.6. Connector

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

2.2.7. Template

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

2.2.8. Template Field

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

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)
				

2.2.10. Macros

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

2.3. Graphical Objects

2.3.1. Line/Arrow

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

2.3.2. Box

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

2.3.3. TextBox

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

2.4. DBD Info Block

2.4.1. DBD Info Block

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

2.5. Miscellaneous

2.5.1. Skip

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

2.5.2. View

				  
			#! View(xoffset, yoffset, scale)
				

3. Conclusion

This document will probably change in it the future.

Document History

References