|
|
| (5 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| = EPICS: dbdClasses - IOC record =
| | This page is obsolete. It is replaced by dbdInterfaces. |
| June 10 2005
| |
| | |
| ----
| |
| <center>
| |
| | |
| == Overview ==
| |
| | |
| </center>
| |
| | |
| This document describes the C++ class definitions for code that implements | |
| the semantics for records created from Database Definitions. The definitions
| |
| are intended for code that:
| |
| * includes header files generated from dbd definitions. Header files are generated from the following dbd definitions:
| |
| ** <tt>record</tt> - Should only be included by record support.
| |
| ** <tt>struct</tt> - Included by code that understands the struct.
| |
| ** <tt>menu</tt> - Included by code that understands the menu.
| |
| * does not include the header files.
| |
| | |
| The following headers files are described:
| |
| * <tt>dbfTypes.h</tt> - Type definitions for <tt>field</tt> definitions in <tt>struct</tt> or <tt>record></tt> DBD definitions.
| |
| * <tt>dbdStatements.h</tt> - Type definitions for DBD statements.
| |
| * <tt>dbdInterfaces.h</tt> - Type definitions for interfaces related to DBD definitions.
| |
| | |
| ----
| |
| <center>
| |
| | |
| == dbfTypes ==
| |
| </center>
| |
| File <tt>dbfTypes.h</tt> describes types and classes that are used in header
| |
| files generated from dbd <tt>struct</tt> or <tt>record</tt> field definitions.
| |
| The following naming conventions are used:
| |
| ; C++ <tt>struct</tt> vs <tt>class</tt>
| |
| : A C++ <tt>class</tt> is used for a class that has methods and <tt>struct</tt> is used for a class that has only data.
| |
| ; Dbf
| |
| : any class starting with Dbf describes a field in a generated header file. For example DbfString describes a field generated from <tt>field(name,string)</tt>.
| |
| ; Dbd
| |
| : A class name starting with Dbd describes something related to dbd definitions. For example DbdLinkSupport describes a dbd link definition.
| |
| | |
| === <tt>dbfTypes.h</tt> ===
| |
| Every field in the header files generated from DBD <tt>struct</tt> and
| |
| <tt>record</tt> definitions has one on the following types:
| |
| | |
| | |
| enum dbfType {
| |
| dbfTypeBoolean, // epicsBoolean
| |
| dbfTypeOctet, // epicsOctet
| |
| dbfTypeInt16, // epicsInt16
| |
| dbfTypeInt32, // epicsInt32
| |
| dbfTypeInt64, // epicsInt64
| |
| dbfTypeFloat32, // epicsFloat32
| |
| dbfTypeFloat64, // epicsFloat64
| |
| dbfTypeString, // EpicsString
| |
| dbfTypeArray, // DbfArray
| |
| dbfTypeMDArray // DbfMDArray
| |
| dbfMenuT, // DbfMenu
| |
| dbfEnumT, // DbfEnum
| |
| dbfLinkT, // DbfLink
| |
| dbfDeviceT // DbfDevice
| |
| dbfTypeStruct, // DbfStruct
| |
| };
| |
| | |
| === Discussion of dbfTypes ===
| |
| | |
| DBD type
| |
| * bool,...,string all become an epicsType , i.e. epicsBoolean,...EpicsString
| |
| * array becomes a DbfArray or DbfMDArray.
| |
| * struct becomes a DbfStruct
| |
| * menu becomes DbfMenu
| |
| * enum becomes DbfEnum
| |
| * link becomes DbfLink
| |
| * device becomes DbfDevice
| |
| | |
| | |
| If a record is defined as:
| |
| struct(displayLimits) {
| |
| field(low,double)
| |
| field(high,double)
| |
| }
| |
| record(xxx) extends iocRecord {
| |
| ...
| |
| field(fbool,bool)
| |
| field(foctet,octet)
| |
| field(fint,int16)
| |
| ...
| |
| field(ffloat,float64)
| |
| field(fstring,string)
| |
| field(array,array(double[])
| |
| field(mdarray,array(double[,])
| |
| field(fmenu,menu(name))
| |
| field(fenum,enum)
| |
| field(flink,link(in))
| |
| field(fdevice,link(in,analogIO))
| |
| field(displayLimits,struct(displayLimits))
| |
| }
| |
| | |
| Then the generated header file will be
| |
| class xxxRecord : public iocRecord {
| |
| public:
| |
| epicsBoolean fbool;
| |
| epicsOctet foctet;
| |
| epicsInt16 fint;
| |
| ...
| |
| epicsFloat64 ffloat;
| |
| EpicsString fstring;
| |
| DbfArray array;
| |
| DbfMDArray mdarray;
| |
| DbfMenu fmenu;
| |
| DbfEnum fenum;
| |
| DbfLink flink;
| |
| DbfDevice fdevice;
| |
| DbfStruct displayLimits;
| |
| };
| |
| ----
| |
| <center>
| |
| | |
| == epicsTypes ==
| |
| </center>
| |
| | |
| Fields of type epicsBoolean, epicsOctet, epicsInt16, epicsInt32, epicsInt64,
| |
| epicsFloat32, or epicsFloat64 are all a C++ fundamental type. When a record
| |
| instance is created these are all initialized to 0.
| |
| | |
| A field of type EpicsString is initialized via the default constructor for
| |
| EpicsString, which means that no EpicsBuffer is created. Record support
| |
| must call createBuffer.
| |
| | |
| ----
| |
| <center>
| |
| | |
| == DbfArray ==
| |
| </center>
| |
|
| |
| <tt>DbfArray</tt> is:
| |
| | |
| class DbfArray {
| |
| public:
| |
| DbfArray(dbfType type = dbfTypeOctet);
| |
| DbfArray(const char *bufferType, epicsInt32 capacity,
| |
| dbfType type = 0);
| |
| DbfArray(DbfBufferCreator *creator, epicsInt32 capacity,
| |
| dbfType type = 0);
| |
| ~DbfArray();
| |
| epicsOctet setType(dbfType type);
| |
| dbfType getType() const;
| |
| void useBuffer(const char *bufferType, epicsInt32 capacity = 0);
| |
| void useBuffer(DbfBufferCreator *creator, epicsInt32 capacity = 0);
| |
| void destroy();
| |
| epicsOctet *element(epicsInt32 index);
| |
| const epicsOctet *element(epicsInt32 index) const;
| |
| epicsInt32 get(epicsInt32 offset, epicsInt32 len,
| |
| epicsOctet *pto) const;
| |
| epicsInt32 put(epicsInt32 offset, epicsInt32 len,
| |
| const epicsOctet *pfrom);
| |
| | |
| // These are similar to DbfBuffer, measured in elements not octets
| |
| DbfBufferCreator *creator() const;
| |
| void reserve(epicsInt32 capacity);
| |
| epicsInt32 capacity() const;
| |
| void resize(epicsInt32 newsize);
| |
| epicsInt32 size() const;
| |
| epicsInt32 maxSize() const;
| |
| bool mutable() const;
| |
| void expose(epicsInt32 offset, epicsInt32 &len,
| |
| epicsOctet *&pdata);
| |
| void expose(epicsInt32 offset, epicsInt32 &len,
| |
| const epicsOctet *&pdata) const;
| |
| protected:
| |
| dbfType type;
| |
| EpicsArray *parray;
| |
| private:
| |
| DbfArray(const DbfArray &); // No copy constructor
| |
| DbfArray& operator=(const DbfArray &); // No assignment operator
| |
| };
| |
| | |
| | |
| In addition the following convenience classes are available .
| |
| | |
| class Int16Array {
| |
| public:
| |
| Int16Array(DbfArray *parray);
| |
| Int16Array(DbfArray *parray,
| |
| const char *bufferType, epicsInt32 capacity);
| |
| Int16Array(DbfArray *parray
| |
| EpicsBufferCreator *creator, epicsInt32 capacity);
| |
| ~Int16Array();
| |
| epicsInt16 * element(epicsInt32 index);
| |
| const epicsInt16 * element(epicsInt32 index) const;
| |
| epicsInt32 get(epicsInt32 offset, epicsInt32 len,
| |
| epicsInt16 *pto) const;
| |
| epicsInt32 put(epicsInt32 offset, epicsInt32 len,
| |
| const epicsInt16 *pfrom);
| |
| | |
| // These are similar to Buffer, measured in elements not octets
| |
| void reserve(epicsInt32 capacity);
| |
| epicsInt32 capacity() const;
| |
| void resize(epicsInt32 newsize);
| |
| epicsInt32 size() const;
| |
| epicsInt32 maxSize() const;
| |
| void expose(epicsInt32 offset, epicsInt32 &len,
| |
| epicsInt16 *&pdata);
| |
| void expose(epicsInt32 offset, epicsInt32 &len,
| |
| const epicsInt16 *&pdata) const;
| |
| private:
| |
| DbfArray *parray;
| |
| Int16Array(const EpicsInt16Array &); // No copy constructor
| |
| Int16Array& operator=(const EpicsInt16Array &); // No assignment operator
| |
| };
| |
| | |
| // The following are like Int16Array except for type
| |
| class OctetArray ;
| |
| class Int32Array ;
| |
| class Int64Array ;
| |
| class Float32Array ;
| |
| class Float64Array ;
| |
| class StringArray ;
| |
| class StructArray ;
| |
| | |
| As an example of how the convience classes are used is:
| |
| | |
| Float64Array dbfArray;
| |
| epicsFloat64 *pdata = new epicsFloat64[10];
| |
| ...
| |
| dbfArray.put(0,10,pdata);
| |
|
| |
| ----
| |
| <center>
| |
| | |
| == DbfMDArray ==
| |
| </center>
| |
| | |
| <tt>DbfMDArray</tt> is:
| |
| | |
| Need something like for DbfArray except that convenience classes will be
| |
| | |
| class BasicTypeMDArray;
| |
| class OctetMDArray ;
| |
| class Int32MDArray ;
| |
| class Int64MDArray ;
| |
| class Float32MDArray ;
| |
| class Float64MDArray ;
| |
|
| |
| ----
| |
| <center>
| |
| | |
| == DbfMenu ==
| |
| </center>
| |
| <tt>DbfMenu</tt> is described as:
| |
| struct DbfMenu{
| |
| epicsInt16 index;
| |
| DbdMenu *pmenuDef;
| |
| };
| |
| | |
| <tt>DbfMenu</tt> provides the current menu index and also the menu definition.
| |
| | |
| A field of type DbfMenu is automatically initialized by dbLoadRecords.
| |
| | |
| ----
| |
| <center>
| |
| | |
| == DbfEnum ==
| |
| </center>
| |
| <tt>DbfEnum</tt> is described as:
| |
| struct DbfEnum{
| |
| epicsInt16 index;
| |
| DbfArray *pfield; //EpicsArray of epicsTypeString
| |
| };
| |
| | |
| <tt>pfield</tt> is the address of a field in the same record that is a
| |
| DbfArray of type EpicsString. It contains the choices.
| |
| | |
| A field of type DbfEnum is automatically initialized by dbLoadRecords.
| |
| | |
| ----
| |
| <center>
| |
| | |
| == DbfLink and DbdDevice ==
| |
| </center>
| |
|
| |
|
| |
| <tt>DbfLink</tt> is described as
| |
|
| |
| enum LinkDir {
| |
| LinkDirNone,
| |
| LinkDirForward,
| |
| LinkDirIn,
| |
| LinkDirOut,
| |
| LinkDirInOut
| |
| };
| |
|
| |
| struct DbfLink{
| |
| LinkDir dir;
| |
| DbdLink *plinkDef;
| |
| DbfStruct dataStruct;
| |
| };
| |
|
| |
| struct DbfDevice{
| |
| LinkDir dir;
| |
| DbdDevice *pDbdDevice;
| |
| DbfStruct dataStruct;
| |
| };
| |
| | |
| The fields of <tt>DbfLink</tt> are initialized by dbLoadRecords as follows:
| |
| ; <tt>dir</tt>
| |
| : This is taken from either the <tt>field</tt> definition or from the <tt>DbdLink</tt> definition and is the most restrictive. For example if one says inout and the other says in then <tt>dir</tt> will be in.
| |
| ; <tt>plinkDef</tt>
| |
| : This is the address of the <tt>DbdLink</tt>.
| |
| ; <tt>dataStruct</tt>
| |
| : The describes the data structure specified in the dbd <tt>link</tt> definition. It contains data used by the link support.
| |
| | |
| Link support always implements interface <tt>DbdLinkSupport</tt>
| |
| | |
| A <tt>DbfDevice</tt> is similar to a <tt>DbfLink</tt> except that the interface implemented by the device support is also specified, i.e. instead of implementing interface <tt>DbdLinkSupport</tt>, the device support implements an interface that both record support and device support understand.
| |
| | |
| | |
| ----
| |
| <center>
| |
| | |
| == DbfStruct ==
| |
| </center>
| |
| <tt>DbfStruct</tt> is described as
| |
| | |
| struct DbfStruct {
| |
| DbdStruct *pdescription;
| |
| void *pstorage;
| |
| };
| |
|
| |
| The fields of <tt>DbfStruct</tt> are initialized by dbLoadRecords as follows:
| |
| ; <tt>pdescription</tt>
| |
| : This is initialized via the structure name specified in field definition.
| |
| ; <tt>pstorage
| |
| : This is initialized by calling DbdStructLifetime:allocate
| |
| | |
| ----
| |
| <center>
| |
| | |
| == dbdStatements ==
| |
| | |
| </center>
| |
| The definitions in <tt>dbdStatements.h</tt> allow introspection of ioc records. They describe everything defined in DBD definitions.
| |
| | |
| <b>NODE</b> and <b>LIST</b> specify a doubly linked list.
| |
| An implementation is not specified.
| |
| | |
| === <tt>dbdStatements.h</tt> ===
| |
| | |
| class Interface {}; // Must be an interface, i.e. pure abstract class
| |
| | |
| struct DbdMenu{
| |
| NODE node; // for DbdBase:menuList
| |
| EpicsString name;
| |
| epicsInt16 nchoices;
| |
| EpicsString *pchoice[];
| |
| };
| |
|
| |
| struct DbdLink{ //describes dbd link statement
| |
| NODE node; // For DbdBase:linkList
| |
| LinkDir dir;
| |
| EpicsString choiceName;
| |
| EpicsString dataStructName;
| |
| DbdLinkSupport *pinterface;
| |
| };
| |
|
| |
| struct DbdDevice { //describes dbd device statement
| |
| NODE node; // For DbdBase:deviceList
| |
| LinkDir dir;
| |
| EpicsString choiceName;
| |
| EpicsString dataStructName;
| |
| EpicsString interfaceName;
| |
| Interface *pinterface;
| |
| };
| |
| | |
|
| |
| // Beginning of definitions for DbdStruct
| |
| struct DbdAttribute {
| |
| EpicsString default;
| |
| epicsBoolean readonly;
| |
| epicsBoolean design;
| |
| epicsBoolean special;
| |
| epicsBoolean dynamic;
| |
| epicsInt16 asl;
| |
| };
| |
| | |
| struct DbdStringDefaults { // defaults for string
| |
| const char *bufferType;
| |
| epicsInt32 capacity;
| |
| };
| |
| | |
| struct DbdArrayDefaults { // defaults for array
| |
| dbfType type;
| |
| const char *bufferType;
| |
| epicsInt32 capacity;
| |
| epicsInt32 nelements;
| |
| };
| |
| | |
| struct DbdMDArrayDefaults { // defaults for mdarray
| |
| dbfType type;
| |
| epicsInt16 ndim
| |
| const char *bufferType;
| |
| epicsInt32 capacity;
| |
| };
| |
| | |
| struct DbdStructDefaults { // defaults for struct
| |
| DbdStruct *pdescription;
| |
| };
| |
| | |
| struct DbdField {
| |
| const char *name;
| |
| dbfType type;
| |
| union {
| |
| DbdStringDefaults *pstring;
| |
| DbdArrayDefaults *parray;
| |
| DbdMDArrayDefaults *pmdarray;
| |
| DbdStructDefaults *pstruct;
| |
| } defaults;
| |
| DbdAttribute attribute;
| |
| };
| |
| | |
| struct DbdStruct{ // describes a struct
| |
| NODE node; // for DbdBase:structList
| |
| const char *name;
| |
| epicsInt16 nfields;
| |
| DbdField *pafield;//ptr to array of DbdField
| |
| DbdStructLifetime *plifetime;
| |
| };
| |
| | |
| | |
| struct DbdRecord { // describes a record
| |
| NODE node; // for DbdBase:recordList
| |
| LIST instanceList;
| |
| const char *name;
| |
| epicsInt16 nfields;
| |
| DbdField *pafield;//ptr to array of DbdField
| |
| DbdRecordSupport *psupport;
| |
| DbdRecordLifetime *plifetime;
| |
| };
| |
|
| |
| struct DbdUserField{ // describes a dbd userField statement
| |
| NODE node; // For DbdBase:userFieldList
| |
| EpicsString choiceName;
| |
| epicsType type;
| |
| EpicsString dataStructName;
| |
| DbdUserFieldHandler *pinterface;
| |
| };
| |
|
| |
| // The following describes a record instance
| |
| struct DbdUserFieldInstance {
| |
| NODE node; // for DbdRecordInstance.userField
| |
| EpicsString name; // user field name
| |
| dbfType sourceType;
| |
| void *psource;
| |
| DbdUserField *pDbdUserField;
| |
| void *pstorage; // for DbdUserField.type
| |
| DbfStruct dataStruct;
| |
| };
| |
|
| |
| struct DbdRecordInstance {
| |
| NODE node; // for DbdRecord.instanceList
| |
| DbdRecord *pDbdRecord;
| |
| void *pstorage;
| |
| EpicsString name;
| |
| LIST userField; // of DbdUserFieldInstance
| |
| };
| |
|
| |
| struct DbdBase {
| |
| LIST structList;
| |
| LIST recordList;
| |
| LIST menuList;
| |
| LIST linkList;
| |
| LIST deviceList;
| |
| LIST userFieldList;
| |
| };
| |
| | |
| | |
| === Discussion of dbdStatements ===
| |
| | |
| ==== Menu ====
| |
| | |
| A dbd <tt>menu</tt> is described by <tt>DbdMenu</tt>
| |
| | |
| The fields of DbdMenu are:
| |
| ; <tt>node</tt>
| |
| : node for DbdBase:menuList
| |
| ; <tt>name</tt>
| |
| : The menu name.
| |
| ; <tt>nchoices</tt>
| |
| : The number of menu choices.
| |
| ; <tt>pchoice</tt>
| |
| : The address of an array of pointers to EpicsString. Each EpicsString is a choice.
| |
| | |
| ==== Link ====
| |
| | |
| A dbd <tt>link</tt> definition is described by <tt>DbdLink</tt>
| |
| ; <tt>node</tt>
| |
| : This is a node for <tt>DbdLinkList</tt>
| |
| ; <tt>dir</tt>
| |
| : The link direction
| |
| ; <tt>choiceName</tt>
| |
| : The name that connects a DbdLink to a DbfLink instance.
| |
| ; <tt>dataStructName</tt>
| |
| : The class name of an DbdStruct for the Interface implementation
| |
| ; <tt>pinterface</tt>
| |
| : The address of the DbdLinkSupport Interface implementation.
| |
| | |
| ==== Device ====
| |
| | |
| Each dbd <tt>device</tt> definition is described by <tt>DbdDevice</tt>
| |
| ; <tt>node</tt>
| |
| : This is a node for <tt>DbdDeviceList</tt>
| |
| ; <tt>dir</tt>
| |
| : The link direction
| |
| ; <tt>choiceName</tt>
| |
| : The name that matches a DbdDevice to a DbfDevice instance.
| |
| ; <tt>dataStructName</tt>
| |
| : The class name of an EpicsStruct for the Interface implementation
| |
| ; <tt>interfaceName</tt>
| |
| : The name of the interface type implemented by the device support
| |
| ; <tt>pinterface</tt>
| |
| : The address of the Interface implementation.
| |
| | |
| | |
| ==== struct and record ====
| |
| The following describe the fields in a dbd <tt>struct</tt> or <tt>record</tt> definition: <tt>DbdStruct</tt>, <tt>DbdRecord</tt>, <tt>DbdField</tt>,and <tt>DbdAttribute</tt>
| |
| | |
| The fields of <tt>DbdStruct</tt> are:
| |
| ; <tt>node</tt>
| |
| : node for <tt>DbdBase:structList</tt>
| |
| ; <tt>name</tt>
| |
| : The name of the struct.
| |
| ; <tt>nfields</tt>
| |
| : The number of fields, e.g. fields in the structure.
| |
| ; <tt>pafields</tt>
| |
| : pointer to an array of <tt>DbdField</tt>.
| |
| ; <tt>plifetime</tt>
| |
| : The address of an implementation of interface <tt>DbdStructLifetime</tt>. The implementation is automatically generated from the dbd <tt>struct</tt>. See below for a description of the Lifetime methods.
| |
| | |
| The fields of <tt>DbdRecord</tt> are;
| |
| ; <tt>node</tt>
| |
| : node for <tt>DbdBase:recordList</tt>
| |
| ; <tt>instanceList</tt>
| |
| : list of instances of this record type
| |
| ; <tt>name</tt>
| |
| : The name of the record type.
| |
| ; <tt>nfields</tt>
| |
| : The number of fields, e.g. fields in the record.
| |
| ; <tt>pafields</tt>
| |
| : pointer to an array of <tt>DbdField</tt>.
| |
| ; <tt>psupport</tt>
| |
| : The address of the <tt>DbdRecordSupport</tt> for this record type.
| |
| ; <tt>plifetime</tt>
| |
| : The address of an implementation of interface <tt>DbdRecordLifetime</tt>. The implementation is automatically generated from the dbd <tt>record</tt> statement. See below for a description of the Lifetime methods.
| |
| | |
| | |
| The fields of <tt>DbdField</tt> are:
| |
| ; <tt>name</tt>
| |
| : The name of the field
| |
| ; <tt>type</tt>
| |
| : The dbfType of the field.
| |
| ; <tt>defaults</tt>
| |
| : a union of default values. The default values depend on the record type definitions. Most types do not have associated default values. Note that these are defaults for the description of the field NOT for values to put in the field.
| |
| ; <tt>attribute</tt>
| |
| : DbdAttribute for the field
| |
| | |
| The fields of <tt>DbdAttribute</tt> are:
| |
| ; <tt>default</tt>
| |
| : An EpicsString providing a default value for the field.
| |
| ; <tt>readonly</tt>
| |
| : Is the field readonly?
| |
| ; <tt>design</tt>
| |
| : Is the field a design fields for DCTs?
| |
| ; <tt>special</tt>
| |
| : Should DbdRecordSupport:special be called if the field is modified.
| |
| ; <tt>dynamic</tt>
| |
| : Can the field change because of record processing?
| |
| ; <tt>asl</tt>
| |
| : The access security level.
| |
| ==== User Defined Fields ====
| |
| | |
| Each dbd <tt>userField</tt> definition has an associated class <tt>DbdUserField</tt> with fields:
| |
| ; <tt>node</tt>
| |
| : This is a node for <tt>DbdUserFieldList</tt>
| |
| ; <tt>choiceName</tt>
| |
| : The name that matches a DbdUserField to a DbdUserFieldInstance
| |
| ; <tt>type</tt>
| |
| : The epicsType for the user field
| |
| ; <tt>dataStructName</tt>
| |
| : The class name of an EpicsStruct for the DbdUserFieldHandler
| |
| ; <tt>pinterface</tt>
| |
| : The address of the DbdUserFieldHandler implementation.
| |
| | |
| ==== Record Instance ====
| |
| | |
| A record instance has two associated classes:<tt>DbdUserFieldInstance</tt> and <tt>DbdRecordInstance</tt>.
| |
| | |
| <tt>DbdUserFieldInstance</tt> contains information for a user defined field:
| |
| ; <tt>node</tt>
| |
| : A node for list <tt>DbdRecordInstance.userField</tt>
| |
| ; <tt>name</tt>
| |
| : The name of the user defined field, i.e. the psuedo field name
| |
| ; <tt>sourceType</tt>
| |
| : the type of the field of the record that DbdUserFieldHandler accesses.
| |
| ; <tt>psource</tt>
| |
| : The address of the field that DbdUserFieldHandler accesses.
| |
| ; <tt>pDbdUserField</tt>
| |
| : The DbdUserField that describes the field
| |
| ; <tt>pstorage</tt>
| |
| : Address of storage for the dbfType.
| |
| ; <tt>dataStruct</tt>
| |
| : An DbfStruct that holds the private data for the DbdUserFieldHandler.
| |
| | |
| The fields of <tt>DbdRecordInstance</tt> are:
| |
| | |
| ; <tt>node</tt>
| |
| : A node for list <tt>DbdRecord.instanceList</tt>
| |
| ; <tt>pDbdRecord</tt>
| |
| : address of the DbdRecord describing the record
| |
| ; <tt>pstorage</tt>
| |
| : address of the storage for the record instance
| |
| ; <tt>name</tt>
| |
| : The name of the record instance
| |
| ; <tt>userField</tt>
| |
| : <tt>DbdUserFieldInstance</tt> list for the record instance.
| |
| | |
| ==== DbdBase ====
| |
| | |
| The following provide lists of various things:
| |
| | |
| ; <tt>structList</tt>
| |
| : The list of each struct definition
| |
| ; <tt>recordList</tt>
| |
| : The list of each record type definition
| |
| ; <tt>menuList</tt>
| |
| : The list of each menu definition
| |
| ; <tt>linkList</tt>
| |
| : The list of each link definition
| |
| ; <tt>deviceList</tt>
| |
| : The list of each device definition
| |
| ; <tt>userFieldList</tt>
| |
| : The list of each DbdUserField definition
| |
| | |
| ----
| |
| <center>
| |
| | |
| == dbdInterfaces ==
| |
| | |
| dbdInterfaces describes standard interfaces implemented by code that
| |
| supports runtime database access.
| |
| | |
| </center>
| |
| | |
| === <tt>dbdInterfaces.h</tt> ===
| |
| <tt>dbdInterfaces.h</tt> contains the following:
| |
| | |
| // The following is implemented by database access
| |
| class DbdFieldPutString {
| |
| virtual void primitive(EpicsString *pfrom, dbfType type,
| |
| void *pstorage) = 0;
| |
| virtual void string(EpicsString *pfrom,
| |
| EpicsString *pEpicsString) = 0;
| |
| virtual void array(EpicsString *pfrom,
| |
| DbfArray *parray) = 0;
| |
| virtual void dbfStruct(EpicsString *pfrom,
| |
| DbfStruct *pstruct) = 0;
| |
| virtual void dbfMDArray(EpicsString *pfrom,
| |
| DbfMDArray *parray) = 0;
| |
| }
| |
| | |
| // For struct definitions
| |
| // An DbdStructLifetime interface is automatically generated.
| |
| class DbdStructLifetime {
| |
| public:
| |
| virtual void allocate(DbfStruct &struct) = 0;
| |
| virtual void destroy(DbfStruct &struct) = 0;
| |
| virtual bool initialize(DbfStruct *pDbfStruct) = 0;
| |
| virtual bool finalize(DbfStruct *pDbfStruct) = 0;
| |
| virtual void *exposeField(DbfStruct &struct, epicsInt16 index) = 0;
| |
| };
| |
| | |
| // For record definitions a DbdRecordLifetime is automatically generated.
| |
| class DbdRecordLifetime{
| |
| public:
| |
| virtual void allocate(DbdRecordInstance *pDbdRecordInstance) = 0;
| |
| virtual void destroy(DbdRecordInstance *pDbdRecordInstance) = 0;
| |
| virtual bool initialize(DbdRecordInstance *pDbdRecordInstance) = 0;
| |
| virtual bool finalize(DbdRecordInstance *pDbdRecordInstance) = 0;
| |
| virtual void *exposeField(DbdRecordInstance *pDbdRecordInstance) = 0;
| |
| };
| |
| | |
| // link support modules implement the following interface
| |
| class DbdLinkSupport {
| |
| public:
| |
| virtual void report(iocRecord *precord, DbfLink *pdbfLink) = 0;
| |
| virtual bool initialize(iocRecord *precord, DbfLink *pdbfLink) = 0;
| |
| virtual bool finalize(iocRecord *precord, DbfLink *pdbfLink) = 0;
| |
| virtual bool connect(iocRecord *precord, DbfLink *pdbfLink) = 0;
| |
| virtual bool disconnect(iocRecord *precord, DbffLink *pdbfLink) = 0;
| |
| virtual bool get(iocRecord *precord, DbffLink *pdbfLink,
| |
| epicsType type, void *pfield) = 0;
| |
| virtual bool put(iocRecord *precord, DbfLink *pdbfLink,
| |
| epicsType type, void *pfield) = 0;
| |
| };
| |
| | |
| /* record support implements the following*/
| |
| class DbdRecordSupport {
| |
| public:
| |
| virtual bool initBuffers(DbdRecordInstance *pDbdRecordInstance) = 0;
| |
| virtual bool initConnections(DbdRecordInstance *pDbdRecordInstance) = 0;
| |
| virtual bool breakConnections(DbdRecordInstance *pDbdRecordInstance) = 0;
| |
| virtual bool process(DbdRecordInstance *pDbdRecordInstance) = 0;
| |
| virtual void special(DbdRecordInstance *pDbdRecordInstance,
| |
| bool after,
| |
| epicsInt16 nlevels, // number of elements in fieldIndex
| |
| epicsInt16 fieldIndex[] // array of field indices
| |
| ) = 0;
| |
| };
| |
| | |
| class DbdUserFieldHandler {
| |
| public:
| |
| virtual bool initialize(
| |
| iocRecord *precord,DbdUserFieldInstance *puserField) = 0;
| |
| virtual bool finalize(
| |
| iocRecord *precord,DbdUserFieldInstance *puserField) = 0;
| |
| virtual bool process(
| |
| iocRecord *precord,DbdUserFieldInstance *puserField) = 0;
| |
| };
| |
| | |
| === Discussion of dbdInterfaces ===
| |
| | |
| === <tt>DbdFieldPutString</tt> ===
| |
| | |
| This is an interface, which has an implementation provided by iocCore,
| |
| that convert an <tt>EpicsString</tt> to an dbfType.
| |
| The methods are:
| |
| ; <tt>primitive</tt>
| |
| : This convert a string to one of the types: <tt>epicsBoolean</tt>, ..., <tt>epicsFloat64</tt>
| |
| ; <tt>string</tt>
| |
| : Copies an EpicsString to an EpicsString
| |
| ; <tt>array</tt>
| |
| : Accepts a string that has the DBD array initialization syntax, locates the string value for each element and calls either DbdFieldPutString:primitive or DbdFieldPutString:string to convert the value and put it into the correct element of <tt>DbfArray</tt>
| |
| ; <tt>dbfStruct</tt>
| |
| : Accepts a string that has the DBD struct initialialization syntax, locates the string value associated with each field and calls primitive, string, or array to convert the value and put the result of the correct field of <tt>DbfStruct</tt>
| |
| ; <tt>dbfMDArray</tt>
| |
| : Accepts a string that has the DBD array initialization syntax, locates the string value for each element and calls either DbdFieldPutString:primitive or DbdFieldPutString:string to convert the value and put it into the correct element of <tt>DbfMDArray</tt>
| |
| === <tt>DbdStructLifetime</tt> and <tt>DbdRecordLifetime</tt> ===
| |
| Every dbd <tt>struct</tt> and <tt>record</tt> has an associated Lifetime interface implementation.
| |
| A tool is provided that automatically generates the implementation from the dbd definition.
| |
| | |
| <tt>DbdStructLifetime</tt> and <tt>DbdRecordLifetime</tt> each has the following fields:
| |
| ; <tt>allocate</tt>
| |
| : Creates storage for the struct or record.
| |
| ; <tt>destroy</tt>
| |
| : frees storage
| |
| ; <tt>exposeField</tt>
| |
| : Given an index it returns the address of the storage for the field. Note the the generated header files assign an index to each field.
| |
| ; <tt>initialize</tt>
| |
| : initializes the struct or record
| |
| ; <tt>finalize</tt>
| |
| : cleans up but does not free storage
| |
| | |
| === <tt>DbdLinkSupport</tt> ===
| |
| | |
| This is the interface implemented by the support associated with each DBD link.
| |
| | |
| <tt>DbdLinkSupport</tt> has the following methods:
| |
| ; <tt>report</tt>
| |
| : generate a report about the link instance
| |
| ; <tt>initialize</tt>
| |
| : perform initialization but do not connect
| |
| ; <tt>finalize</tt>
| |
| : undo initialization. It is assumed that disconnect has already been called.
| |
| ; <tt>connect</tt>
| |
| : connect to external source of data
| |
| ; <tt>disconnect</tt>
| |
| : disconnect from external source of data
| |
| ; <tt>get</tt>
| |
| : get a value from the external source. <tt>type</tt> specified the field type and <tt>pfield</tt> is the address of where to store the data.
| |
| ; <tt>put</tt>
| |
| : put a value from the external source. <tt>type</tt> specified the field type and <tt>pfield</tt> is the address of where to obtain the data.
| |
| === <tt>DbdRecordSupport</tt> ===
| |
| | |
| This is the interface implemented by each record support module.
| |
| <tt>DbdRecordSupport</tt> has the following methods:
| |
| | |
| ; <tt>initBuffers</tt>
| |
| : This is called during record initialization. It is responsible for creating the buffers associated with each string and array field. It may call associated support to do the initialization.
| |
| ; <tt>initConnections</tt>
| |
| : This is called to connect to external sources. It may call associated support to make the connections.
| |
| ; <tt>breakConnections</tt>
| |
| : This is called to disconnect to external sources. It may call associated support to break the connections.
| |
| ; <tt>process</tt>
| |
| : Process the record.
| |
| ; <tt>special</tt>
| |
| : This is called whenever an external source modifies a field with attribute special set to true.
| |
| | |
| | |
| === <tt>DbdUserFieldHandler</tt> ===
| |
| This is the interface implemented by code for user extensible fields.
| |
| | |
| <tt>DbdUserFieldHandler</tt> has the following fields:
| |
| ; <tt>initialize</tt>
| |
| : Initialize the user field.
| |
| ; <tt>finalize</tt>
| |
| : undo what was done during initialization
| |
| ; <tt>process</tt>
| |
| : Called near the end of record processing just before monitors are handled.
| |
| | |
| === Device Support Interfaces ===
| |
| | |
| Multiple interface definitions for device support will be defined.
| |
| Record Support and device support must agree on which interface type
| |
| is used for communication.
| |
| ----
| |
