V4 Database Definition - Revision history

AndrewJohnson: /* Database Statements */

2005-05-17T21:35:18Z

Database Statements

← Older revision		Revision as of 21:35, 17 May 2005
Line 41:		Line 41:
	* <tt>record</tt> - defines a record type		* <tt>record</tt> - defines a record type
	* <tt>field</tt> - defines a field in a struct or record type		* <tt>field</tt> - defines a field in a struct or record type
			* <tt>view</tt> - defines a view of a record type
			* <tt>property</tt> - maps a property name in a view to a record field
	* <tt>interface</tt> - defines interface to code associated with a struct		* <tt>interface</tt> - defines interface to code associated with a struct
	* <tt>link</tt> - defines a link to data outside the record		* <tt>link</tt> - defines a link to data outside the record
Line 51:		Line 53:
	* <tt>command</tt> - iocsh command registration		* <tt>command</tt> - iocsh command registration


	~~----~~

	<center>		<center>

AndrewJohnson: /* Overview */

2005-05-13T14:40:12Z

<center>Overview</center>

← Older revision		Revision as of 14:40, 13 May 2005
Line 5:		Line 5:
	= <center>Overview</center> =		= <center>Overview</center> =

	This ~~chapter~~ describes the Database Definition ~~Syntax~~ for V4 databases.		This document describes the Database Definition syntax for EPICS V4 databases.
	~~The Database Definition Syntax is meant to~~ be used ~~both~~ by iocCore and by Database Configuration Tools (especially VDCT).		Files that follow this syntax can be used by the iocCore build system, and by Database Configuration Tools (especially VDCT).

	~~This document describes the V4 Database Definition and C++ class definitions~~
	~~that describe a V4 database.~~
	~~To complete the design an implementation needs to be described. this design~~
	~~will include the automatic generation of support modules for each record type~~.

	== Database Field Types ==		== Database Field Types ==
Line 34:		Line 29:
	* <tt>device</tt> - a link to associated device support		* <tt>device</tt> - a link to associated device support
	* <tt>array</tt> - multidimensional arrays of most types are supported		* <tt>array</tt> - multidimensional arrays of most types are supported
	* <tt>private</tt> - a <tt>C</tt> type ~~whose data~~ is private to the record or iocCore		* <tt>private</tt> - any <tt>C</tt> type; content is private to the record and/or iocCore

	== Database Statements ==		== Database Statements ==
Line 40:		Line 35:
	The following statements are supported and discussed below:		The following statements are supported and discussed below:

	* <tt>include</tt> - include ~~statements from a~~ file		* <tt>include</tt> - include contents of another file
	* <tt>#~~comment~~</tt> - ~~comment statements~~		* <tt>#</tt> - comments
	* <tt>menu</tt> - ~~define~~ a set of choices		* <tt>menu</tt> - defines a fixed set of choices
	* <tt>struct</tt> - like a C structure		* <tt>struct</tt> - like a C structure
	* <tt>record</tt> - defines a record type		* <tt>record</tt> - defines a record type
Line 52:		Line 47:
	The following statements or something like them will be supported, but these are not discussed here (yet):		The following statements or something like them will be supported, but these are not discussed here (yet):

	* <tt>registrar</tt> - ~~same as~~ V3 registrar		* <tt>registrar</tt> - like the V3 registrar() statement
	* <tt>variable</tt> - ~~same as~~ V3 variable		* <tt>variable</tt> - like the V3 variable() statement
	* <tt>command</tt> - iocsh command registration		* <tt>command</tt> - iocsh command registration

AndrewJohnson: /* Database Statements */

2005-05-11T22:35:26Z

Database Statements

← Older revision		Revision as of 22:35, 11 May 2005
Line 38:		Line 38:
	== Database Statements ==		== Database Statements ==

	The following statements are discussed:		The following statements are supported and discussed below:

	; <tt>include</tt> - include statements from a file		* <tt>include</tt> - include statements from a file
	; <tt>#comment</tt> - comment statements		* <tt>#comment</tt> - comment statements
	; <tt>menu</tt> - define a set of choices		* <tt>menu</tt> - define a set of choices
	; <tt>struct</tt> - like a C structure		* <tt>struct</tt> - like a C structure
	; <tt>record</tt> - defines a record type		* <tt>record</tt> - defines a record type
	; <tt>interface</tt> - defines interface to code associated with a struct		* <tt>field</tt> - defines a field in a struct or record type
	; <tt>link</tt> - defines a link to data outside the record		* <tt>interface</tt> - defines interface to code associated with a struct
	; <tt>device</tt> - defines an interface to device/driver support		* <tt>link</tt> - defines a link to data outside the record
	; <tt>registrar</tt> - same as V3 registrar		* <tt>device</tt> - defines an interface to device/driver support
	; <tt>variable</tt> - same as V3 variable
	; <tt>~~record instances~~</tt> - ~~describes a record instance~~		The following statements or something like them will be supported, but these are not discussed here (yet):

			* <tt>registrar</tt> - same as V3 registrar
			* <tt>variable</tt> - same as V3 variable
			* <tt>command</tt> - iocsh command registration


Line 56:		Line 60:

	<center>		<center>

	= Summary of V4 Database Definition Syntax =		= Summary of V4 Database Definition Syntax =
	</center>		</center>

AndrewJohnson: /* #comment */

2005-05-11T22:22:59Z

#comment

← Older revision		Revision as of 22:22, 11 May 2005
Line 220:		Line 220:
	# anything		# anything

	Anything on a line after a <tt>#<tt> character is a comment, and will be ignored. This may appear on a line by itself or at the end of another statement.		Anything on a line after a <tt>#</tt> character is a comment, and will be ignored. This may appear on a line by itself or at the end of another statement.

	<center>		<center>

	= menu definitions =		= menu definitions =
	</center>		</center>

AndrewJohnson: /* Database Field Types */

2005-05-11T22:15:54Z

Database Field Types

← Older revision		Revision as of 22:15, 11 May 2005
Line 15:		Line 15:
	== Database Field Types ==		== Database Field Types ==

	The V4 database field types are:		The database field types supported by EPICS V4 are:

	; <tt>bool</tt>		* <tt>bool</tt> - a value that is (0,1) meaning (false,true)
	~~: A~~ value that is (0,1) meaning (false,true)		* <tt>octet</tt> - an 8 bit byte. Note that char is not a supported type.
	; <tt>octet</tt>		* <tt>int16</tt> - 16 bit signed interger
	~~: A~~ 8 bit byte. Note that char is not a supported type.		* <tt>uint16</tt> - 16 bit unsigned interger
	; <tt>int16</tt>		* <tt>int32</tt> - 32 bit signed interger
	: 16 bit signed interger		* <tt>uint32</tt> - 32 bit unsigned interger
	; <tt>uint16</tt>		* <tt>int64</tt> - 64 bit signed interger
	: 16 bit unsigned interger		* <tt>uint64</tt> - 64 bit unsigned interger
	; <tt>int32</tt>		* <tt>float32</tt> - IEEE float
	: 32 bit signed interger		* <tt>float64</tt> - IEEE double
	; <tt>uint32</tt>		* <tt>string</tt> - arbitrary length string of unicode/UTF-8 characters.
	: 32 bit unsigned interger		* <tt>menu</tt> - 16 bit integer index into a string array of choices
	; <tt>int64</tt>		* <tt>enum</tt> - 16 bit integer index into a string array of choices
	: 64 bit signed interger		* <tt>struct</tt> - an ordered set of other database field types
	; <tt>uint64</tt>		* <tt>link</tt> - a pointer to data outside the record
	: 64 bit unsigned interger		* <tt>device</tt> - a link to associated device support
	; <tt>float32</tt>		* <tt>array</tt> - multidimensional arrays of most types are supported
	: IEEE float		* <tt>private</tt> - a <tt>C</tt> type whose data is private to the record or iocCore
	; <tt>float64</tt>
	: IEEE double
	; <tt>string</tt>
	~~: Arbitrary~~ length ~~character~~ string ~~containing~~ unicode/UTF-8 characters.
	; <tt>menu</tt>
	: 16 bit integer ~~that is~~ index of a string array of choices
	; <tt>enum</tt>
	: 16 bit integer ~~and~~ a string array of choices
	; <tt>struct</tt>
	: an ordered set of other database field types
	; <tt>link</tt>
	: a ~~link~~ to data outside the record
	; <tt>device</tt>
	: a link to associated device support
	; <tt>array</tt>
	~~: Multidimensional~~ arrays are ~~a field type~~
	; <tt>private</tt>
	: a ~~valid~~ <tt>C</tt> type ~~that~~ is private to ~~database access and/~~or ~~record support~~

	== Database Statements ==		== Database Statements ==

AndrewJohnson at 20:32, 11 May 2005

2005-05-11T20:32:17Z

Show changes

AndrewJohnson at 19:46, 11 May 2005

2005-05-11T19:46:00Z

← Older revision		Revision as of 19:46, 11 May 2005
Line 1:		Line 1:
			'''This page is currently undergoing surgery off-line by Andrew Johnson, if you make any changes (such as spelling) they will be lost when I bring in the new version.'''

	= EPICS: IOC Database Definition =		= EPICS: IOC Database Definition =

MartyKraimer: replace all names containing _ ; add fields to struct(varFields)

2005-05-11T14:39:52Z

replace all names containing _ ; add fields to struct(varFields)

Show changes

MartyKraimer: Remove comparison with V3. Extent syntax with introspection in mind

2005-05-11T14:06:28Z

Remove comparison with V3. Extent syntax with introspection in mind

Show changes

AndrewJohnson: Converted from Marty's HTML page

2005-05-02T18:13:58Z

Converted from Marty's HTML page

Show changes