V4 Design: dbdInterfaces - Revision history

MartyKraimer at 15:25, 4 November 2005

2005-11-04T15:25:13Z

← Older revision		Revision as of 15:25, 4 November 2005
Line 1:		Line 1:
	EPICS: dbdInterfaces - IOC Database Description November 03 2005		EPICS: dbdInterfaces - IOC Database Description November 04 2005

	----		----
Line 12:		Line 12:
	a running IOC database.		a running IOC database.

	The definitions can be used by code ~~that use code automatically~~		The definitions can be used by support code, e.g. record support,
	~~generated from DBD files~~ or by code that uses only introspection.		or by code that uses only introspection.

	Code is automatically generated from the following definitions:		Code is automatically generated from the following definitions:
Line 318:		Line 318:
	String string = record.fstring.get();		String string = record.fstring.get();
	printf("%s\n",string);		printf("%s\n",string);
			or more concisely
			printf("%s\n",record.fstring.get());

	Code that does not include the header file can use the introspection methods		Code that does not include the header file can use the introspection methods
Line 438:		Line 440:
	...		...
	DbfConvertPrimitive.put(precord.array,new double[] {1.0,2.0,3.0});		DbfConvertPrimitive.put(precord.array,new double[] {1.0,2.0,3.0});
			For the primitive data types both get and put return an int32,
			which is the number of array elements transfered.
			The caller <b>must</b> be prepared to make multiple calls
			in order to get or put an entire array.

			For example
			DbfDoubleArray dbfarray;
			...
			double[] data = double [dbfArray.getNelements];
			int offset=0;
			int len = data.length;
			int n;
			while(offset < len) {
			n = dbfarray.get(offset,len);
			if(n==len) break;
			len -= n;
			offset += n;
			}


Line 480:		Line 500:
	interface DbfLink extends Dbf {		interface DbfLink extends Dbf {
	DbdLink getDbdLink();		DbdLink getDbdLink();
			DbfStruct getSupportStruct();
	}		}
			Where
			* <tt>getDbdLink</tt> gets the link definition for the field
			* <tt>getSupportStruct</tt> get a struct instance for the support structure. Thius is NOT a field in the record but appears like it is.

	== DbfTimeStamp ==		== DbfTimeStamp ==
Line 569:		Line 593:
	}		}

	~~; <tt>getNameLength</tt>~~
	~~: get length of record name~~
	; <tt>getName</tt>		; <tt>getName</tt>
	: get the record name		: get the record name
	; <tt>getDescription</tt>		; <tt>getDescription</tt>
	: get the description of the record specific portion of the record		: get the description of the record specific portion of the record
	~~; <tt>getRecordCommonDescription</tt>~~
	~~: get the description of RecordCommon~~
	; <tt>getInstance</tt>		; <tt>getInstance</tt>
	: get instance for the record specific portion of the record		: get instance for the record specific portion of the record
	~~; <tt>getRecordCommonInstance</tt>~~
	~~: get instance for for RecordCommon portion of the record~~
	; <tt>getField</tt>		; <tt>getField</tt>
	: get field instance.		: get field instance.

MartyKraimer at 19:49, 3 November 2005

2005-11-03T19:49:27Z

Show changes

MartyKraimer at 20:33, 2 November 2005

2005-11-02T20:33:54Z

Show changes

MartyKraimer at 15:02, 4 October 2005

2005-10-04T15:02:43Z

← Older revision		Revision as of 15:02, 4 October 2005
Line 1:		Line 1:
	EPICS: dbdInterfaces - IOC Database Description ~~September 27~~ 2005		EPICS: dbdInterfaces - IOC Database Description October 04 2005

	----		----
Line 291:		Line 291:
	boolean isBasic();		boolean isBasic();
	BasicType getBasicType();		BasicType getBasicType();
	~~DbInstance~~ getRecord();		RecordInstance getRecord();
	int16 getIndex();		int16 getIndex();
	}		}
Line 352:		Line 352:
	For example code that expects a float64 field can access it via		For example code that expects a float64 field can access it via

	Dbf dbf = ~~DbInstanceLocate~~.getField("recordname.value");		Dbf dbf = RecordInstanceLocate.getField("recordname.value");
	if(dbf==null		if(dbf==null
	\|\| !dbf.isPrimitive()		\|\| !dbf.isPrimitive()
Line 360:		Line 360:

	or more concisely (but exception may be thrown)		or more concisely (but exception may be thrown)
	DbfConvertPrimitive(~~DbInstanceLocate~~.getField("recordname.value"),10.0);		DbfConvertPrimitive(RecordInstanceLocate.getField("recordname.value"),10.0);

	== String fields ==		== String fields ==
Line 639:		Line 639:
	== Record Instance ==		== Record Instance ==

	interface ~~DbInstance~~ {		interface RecordInstance {
	int32 getNameLength();		int32 getNameLength();
	void getName(String name);		void getName(String name);
Line 689:		Line 689:
	}		}

	public class ~~DbInstanceLocate~~ {		public class RecordInstanceLocate {
	public ~~DbInstance~~ getRecord(String name);		public RecordInstance getRecord(String name);
	public Dbf getField(String name);		public Dbf getField(String name);
	public Dbf getField(String recordName, String fieldName);		public Dbf getField(String recordName, String fieldName);
	public LinkedList<~~DbInstance~~> instanceList;		public LinkedList<RecordInstance> instanceList;
	public LinkedList<~~DbInstance~~> instanceList(String recordTypeName);		public LinkedList<RecordInstance> instanceList(String recordTypeName);
	}		}

Line 700:		Line 700:
	public class FindLocator {		public class FindLocator {
	public static DbdLocate findDbdLocate();		public static DbdLocate findDbdLocate();
	public static ~~DbInstance findDbInstance~~();		public static RecordInstance findRecordInstance();
	}		}

Line 711:		Line 711:
	The following locates a field of a record instance.		The following locates a field of a record instance.

	Dbf field = ~~DbInstanceLocate~~.getField("example.value");		Dbf field = RecordInstanceLocate.getField("example.value");
	if(addr!=null) printf("found %s\n","example.value");		if(addr!=null) printf("found %s\n","example.value");

	----		----

MartyKraimer at 20:09, 27 September 2005

2005-09-27T20:09:03Z

Show changes

MartyKraimer at 15:16, 16 September 2005

2005-09-16T15:16:32Z

Show changes

MartyKraimer at 15:48, 15 September 2005

2005-09-15T15:48:42Z

Show changes

MartyKraimer at 14:28, 14 September 2005

2005-09-14T14:28:58Z

Show changes

MartyKraimer at 13:09, 14 September 2005

2005-09-14T13:09:05Z

Show changes

MartyKraimer at 14:16, 9 September 2005

2005-09-09T14:16:43Z

← Older revision		Revision as of 14:16, 9 September 2005
Line 1:		Line 1:
	= EPICS: dbdInterfaces - IOC Database Description =		= EPICS: dbdInterfaces - IOC Database Description =
	September 1 2005		September 9 2005

	----		----
Line 47:		Line 47:
	* boolean => bool		* boolean => bool
	* octet => char BUT no arithmetic is implied		* octet => char BUT no arithmetic is implied
	* int16 => ~~short~~		* int16 => int16_t
	* int32 => ~~int~~		* int32 => int32_t
	* int64 => ~~long long~~		* int64 => int64_t
	* float32 => float		* float32 => float
	* float64 => double		* float64 => double

	~~NOTES~~:		NOTE:
	* C++ ~~may require something else to handle the~~ integer types		* The C++ integer types require C99 stdint.h
	* ~~Exceptions must~~ be defined~~. TBD~~		* Should exceptions be defined?

	=== enum, struct, interface, class, string, array ===		=== enum, struct, interface, class, string, array ===
Line 228:		Line 228:
	This only supports primitive types, i.e. DbfBoolean,...,DbfFloat64.		This only supports primitive types, i.e. DbfBoolean,...,DbfFloat64.

	=== Arithmetic Type Conversions ===		----
			<center>

			== Arithmetic Type Conversions ==
			</center>


	class DbfConvertScalar {		class DbfConvertScalar {
Line 324:		Line 329:
	# A class named <tt>nameSupport</tt>		# A class named <tt>nameSupport</tt>

	The class ~~named~~ <tt>name</tt> extends:		The class <tt>name</tt> extends:
	interface Struct {		interface Struct {
	Dbf getField(int16 index);		Dbf getField(int16 index);
Line 385:		Line 390:
	}		}

	<b>~~Question~~</b> ~~Who calls~~ DisplayLimitSupportRegister.createAndRegister~~()?~~		<b>NOTE</b> The V4 replacement for registerRecordDeviceDriver must
			call DisplayLimitSupportRegister.createAndRegister.

	Similar files are generated for C++.		Similar files are generated for C++.
Line 452:		Line 458:
	}		}

	<b>~~Question~~</b> ~~Who calls~~ ExampleRecordFactoryRegister.createAndRegister?		<b>NOTE</b> The V4 replacement for registerRecordDeviceDriver must
			call ExampleRecordFactoryRegister.createAndRegister


Line 497:		Line 504:

	An additional pointer field will be needed for things like monitors.		An additional pointer field will be needed for things like monitors.
	This field can start out null and only ~~have~~ additional storage as needed.		This field can start out null and only allocate additional storage as needed.


Line 675:		Line 682:
	DbfFloat64Array array = precord->array;		DbfFloat64Array array = precord->array;
	...		...
	~~arrayputput~~(0,nelements,data);		array.put(0,nelements,data);


Line 1,073:		Line 1,080:
	class DbAccess {		class DbAccess {
	void process(RecordInstance instance);		void process(RecordInstance instance);
			void registerDbdSource(Dbf field, Dbf source);
	}		}

			NOTES:
			* This is just the beginning of defining the methods in DbAccess
			* registerDbdSource is called by code that manages the strogae for a field.
			** The compress record would do this so that it can implement circular buffers.
			** Device support for arrays stored in hardware can do this so that data can be extracted in chunks.

	----		----