| Class | Description |
|---|---|
| DatabaseService | Class to open a project |
| Db | This class provides information on the opened DB Additional information on the DB (e.g foreign, size, extractParent etc) can be obtain from the %DB DbElement object Some of the information avialable on the %DB object is also repeated here for conveniance, e.g. DBnumber, type. If the MDB is closed, the Db and DbSession objects will no longer be valid. Methods relating to savework, claims, extract operations are available via the MDB class |
| DbAttribute | The class has two purposes: i) Instances of the class are used to identify and pass around attributes ii) The class can be used to get meta data about an attribute. e.g. type, size, Name, pseudo or not, etc The class is valid for system attributes and UDAS. Object instances are created for all system atttributes. These instances are in DbAttributeInstance class All methods that pass in an attribute should pass a DbAttribute object rather than a string that represents the attribute |
| DbAttributeComparer | Class to define comparers for ordering lists of attributes. These allow lists of attributes to be sorted on the value of any field. At present, only an alphabetic sort on field values expressed as strings is implemented, although it would be possible to extend this to sort on numerical values. However, as most integers actually represent hash values or enumerations, this may be less useful than it at first sounds! |
| DbAttributeFormat | Class to define an object for formatting an attribute definition for output ie what fields are to displayed, what intervening text etc Generally, a DbAttributeFormat will be used by a DbAttributeListFormat, which defines how a whole list of attributes is formatted |
| DbAttributeInstance | List of definitions for predefined Attributes |
| DbAttributeList | Class to define a list of attributes; usually for documentation purposes |
| DbAttributeListEnum | Enumerator for the DbAttributeList class |
| DbAttributeListFormat | Class to define an object to format a list of attributes. Each individual attribute is formatted by the DbAttributeFormat specified, and other aspects of the overall presentation (line breaks etc) are controlled by other properties of the DbAttributeListFormat |
| DbChangesEventArgs | Deprecated - do not use |
| DbClaimEventArgs | Deprecated - do not use |
| DbElement | Methods to read and write to the database. These cover element creation, deletion and copy; getting and querying attributes and rules; scanning the DB; evaluating database expressions. Instances of DbElement should be used to identify an element. i.e. methods that take an element should always pass a DbElement rather than a 2 long reference number or the name of the element. Some methods return a 'null' DbElement to denote failure. A 'null' DbElement can only be tested using the 'IsNull' method. |
| DbElementType | The class has two purposes: i) Instances of the class are used to identify and pass around Element types ii) The class can be used to get meta data about an attribute. e.g. type, size, Name, pseudo or not, etc Return meta data about an element type, e,g. allowed members, name, Primary or not, etc. The class is valid for system types and UDETS. Object instances are created for all system element types. These instances are in DbElementTypeInstance class All methods that pass an Element Type should pass a DbElemenType object rather than a string that represents the attribute |
| DbElementTypeComparer | Class to define comparers for ordering lists of ElementTypes. These allow lists of element types to be sorted on the value of any field. At present, only an alphabetic sort on field values expressed as strings is implemented, although it would be possible to extend this to sort on numerical values. However, as most integers actually represent hash values or enumerations, this may be less useful than it at first sounds! |
| DbElementTypeFormat | Class to define an object for formatting a DbElementType definition for output ie what fields are to displayed, what intervening text etc Generally, a DbElementTypeFormat will be used by a DbElementTypeListFormat, which defines how a whole list of DbElementTypes is formatted |
| DbElementTypeInstance | List of definitions for predefined Element Types |
| DbElementTypeList | Class to define a list of DbElementTypes; usually for documentation purposes |
| DbElementTypeListEnum | Enumerator for the DbElementTypeList class |
| DbElementTypeListFormat | Class to define an object to format a list of DbElementTypes. Each individual DbElementType is formatted by the DbElementTypeFormat specified, and other aspects of the overall presentation (line breaks etc) are controlled by other properties of the DbElementTypeListFormat |
| DbEvents | This class contains the mechanisms for subscribing to database events: It covers project open, mdb open, mdb close, savework, getwork, undo, redo, flush, refresh, drop plus capturing general database changes. It does not cover legality checkers for operations on elements. The delegates are organised by type of operation rather than specific ones for each operation e.g. there is a single callback to cover all opeartions(undo, redo, getwork, quit) that changes the user's current viewed data |
| DbExpression | Representation of an Database (PML1) Expression. Methods to evaluate an expression are on DbElement |
| DbFieldFormat | Class to define objects to control the representation of field values |
| DbGetWorkChangesEventArgs | Deprecated - do not use |
| DbLegalityChecks | Class to registry legality checkers- For AVEVA use only |
| DbNameSequence | Representation of a NameSequence |
| DbPostElementChange | Class to add delegates to do follow up data integrity actions. FOR USE BY AVEVA ONLY This class should only be used to ensure the data integrity of the database. To capture general database changes it is much more efficent to use the classes in DbEvents |
| DbPseudoAttribute | Class allows pseudo attribute code to be plugged in. This includes pseudo code for UDAs. There are different methods to plug in the pseudo attribute code depending on the attribute type. User's may only plug code for UADs. The plugging of pseudo attribute code for system attributes is FOR AVEVA USE ONLY |
| DbQualifier | Summary description for DbQualifier. |
| DbRawChanges | Representation of Raw Dabacon Changes. An instance of this class is passed back for certain events such as savework. In general it is better to handle changes in the 'post action', other than deletions which are best handled in the 'pre action' |
| DbRule | Representation of a Rule. |
| DbSession | Class to return details about a particular Dabacon session. |
| DbUndoChangesEventArgs | Deprecated - do not use |
| DbUserChanges | Representation of User Changes list Instances will be passed |
| IntTable | Class for scanning an integer table for a particular DB. The actual scanning of the name table is performed by getting a IntTableEnumerator and iterating on that |
| IntTableEnumerator | Int Table Enumerator. N.B. Enumerator MUST be explicitly disposed to clean up resources |
| InvalidSession | |
| MDB | Representation of an MDB The MDB is accessed via the currentMDB N.B. most methods do not return anything useful until the MDB is opened. (class needs to be remnmed Mdb rather than MDB, similarly MDBSetup should be MdbSetup ) |
| MdbIntTable | Class for scanning an integer table representing all dbs of given type within the current MDB. The actual scanning of the name table is performed by getting a MdbIntTableEnumerator and iterating on that |
| MdbIntTableEnumerator | MDB Int Table Enumerator. N.B. Enumerator MUST be explicitly disposed to clean up resources |
| MdbNameTable | Class for scanning a name table representing all dbs of given type within the current MDB. Names are ordered alphabetically. The actual scanning of the name table is performed by getting a MdbNameTableEnumerator and iterating on that. |
| MdbNameTableEnumerator | MDB name Table Enumerator. N.B. Enumerator MUST be explicitly disposed to clean up resources |
| MDBSetup | Class to store options when opening an MDB. |
| NameTable | Class for scanning a name table for a particular DB. Names are ordered alphabetically. The actual scanning of the name table is performed by getting a NameTableEnumerator and iterating on that. |
| NameTableEnumerator | Name Table Enumerator. N.B. Enumerator MUST be explicitly disposed to clean up resources |
| ParameterList | Representation of Parameter List. to be used for PARA and DESP attributes NOT YET IMPLEMENTED. |
| Project | Representation of a Project. |
| ProjectError | |
| RefTable | Class for scanning of a ref table for a particular DB. The actual scanning of the ref table is performed by getting a RefTableEnumerator and iterating on that |
| RefTableEnumerator | Ref Table Enumerator. N.B. Enumerator MUST be explicitly disposed to clean up resources |
| Spatial | Class to do volumetic queries. For exact opertaions on catalogue items, all primities with TUFL set are tested. |
| Structure | Description |
|---|---|
| DbCopyOption | Container for copy options. |
| Delegate | Description |
|---|---|
| DbChangesEventHandler | Deprecated- do not use |
| DbClaimEventHandler | Deprecated- do not use |
| DbEventHandler | Deprecated- do not use |
| DbEvents.BoolChangeEventHandler | Delegate taking a DbRawChanges object, operation type and returning true if allowed |
| DbEvents.ChangeEventHandler | Delegate taking a DbRawChanges object plus operation type |
| DbEvents.ClaimEventHandler | Delegate taking a list of elements |
| DbEvents.CommitEventHandler | Delegate taking operation only |
| DbEvents.FailureEventHandler | Delegate taking a DbRawChanges object, a list of errors plus operation attempted |
| DbEvents.SimpleEventHandler | Delegate with no arguments |
| DbEvents.UserChangesEventHandler | Delegate taking a DbUserChanges object |
| DbGetWorkEventHandler | Deprecated- do not use |
| DbLegalityChecks.BoolAttributeDelegate | Delegate to test if bool attribute may be set- For AVEVA use only |
| DbLegalityChecks.CopyDelegate | Delegate to test if creation of element may be copied- For AVEVA use only |
| DbLegalityChecks.CreateDelegate | Delegate to test if creation of element is allowed- For AVEVA use only |
| DbLegalityChecks.DeleteDelegate | Delegate to test if deletion of element is allowed- For AVEVA use only |
| DbLegalityChecks.DoubleArrayAttributeDelegate | Delegate to test if real array attribute may be set- For AVEVA use only |
| DbLegalityChecks.DoubleAttributeDelegate | Delegate to test if real attribute may be set- For AVEVA use only |
| DbLegalityChecks.IntArrayAttributeDelegate | Delegate to test if int array attribute may be set- For AVEVA use only |
| DbLegalityChecks.IntAttributeDelegate | Delegate to test if int attribute may be set- For AVEVA use only |
| DbLegalityChecks.MoveDelegate | Delegate to test if element may be moved is allowed- For AVEVA use only |
| DbLegalityChecks.RefArrayAttributeDelegate | Delegate to test if ref array attribute may be set- For AVEVA use only |
| DbLegalityChecks.RefAttributeDelegate | Delegate to test if ref attribute may be set- For AVEVA use only |
| DbLegalityChecks.StringAttributeDelegate | Delegate to test if string attribute may be set- For AVEVA use only |
| DbPostElementChange.PostAttributeChangeDelegate | Delegate to do follow up action on setting attribute - For AVEVA use only |
| DbPostElementChange.PostCopyDelegate | Delegate to do follow up action on element copy - For AVEVA use only |
| DbPostElementChange.PostCreateDelegate | Delegate to do follow up action on element creation - For AVEVA use only |
| DbPostElementChange.PostMoveDelegate | Delegate to do follow up action on element move (i.e. INCLUDE opeartion) - For AVEVA use only |
| DbPostElementChange.PostRefAttributeChangeDelegate | Delegate to do follow up action on setting ref attribute - For AVEVA use only |
| DbPostElementChange.PostRefListAttributeChangeDelegate | Delegate to do follow up action on setting ref array attribute - For AVEVA use only |
| DbPostElementChange.PreDeleteDelegate | Delegate to do pre action on element deletion - For AVEVA use only |
| DbPseudoAttribute.GetBoolDelegate | Delegate to use for writing boolean pseudo attribute 'get' method. THE QUALIFIER ARGUMENT WILL CHANGE |
| DbPseudoAttribute.GetDoubleArrayDelegate | Delegate to use for writing real array pseudo attribute 'get' method. THE QUALIFIER ARGUMENT WILL CHANGE |
| DbPseudoAttribute.GetDoubleDelegate | Delegate to use for writing real pseudo attribute 'get' method. THE QUALIFIER ARGUMENT WILL CHANGE |
| DbPseudoAttribute.GetIntArrayDelegate | Delegate to use for writing integer array pseudo attribute 'get' method. THE QUALIFIER ARGUMENT WILL CHANGE |
| DbPseudoAttribute.GetIntDelegate | Delegate to use for writing integer pseudo attribute 'get' method. THE QUALIFIER ARGUMENT WILL CHANGE |
| DbPseudoAttribute.GetRefArrayDelegate | Delegate to use for writing ref array pseudo attribute 'get' method. THE QUALIFIER ARGUMENT WILL CHANGE |
| DbPseudoAttribute.GetRefDelegate | Delegate to use for writing ref pseudo attribute 'get' method. THE QUALIFIER ARGUMENT WILL CHANGE |
| DbPseudoAttribute.GetStringDelegate | Delegate to use for writing string pseudo attribute 'get' method. THE QUALIFIER ARGUMENT WILL CHANGE |
| DbPseudoAttribute.SetBoolDelegate | Delegate to use for writing boolean pseudo attribute 'set' method. |
| DbPseudoAttribute.SetDoubleArrayDelegate | Delegate to use for writing real array pseudo attribute 'set' method. |
| DbPseudoAttribute.SetDoubleDelegate | Delegate to use for writing real pseudo attribute 'set' method. |
| DbPseudoAttribute.SetIntArrayDelegate | Delegate to use for writing integer array pseudo attribute 'set' method. |
| DbPseudoAttribute.SetIntDelegate | Delegate to use for writing integer pseudo attribute 'set' method. |
| DbPseudoAttribute.SetRefArrayDelegate | Delegate to use for writing ref array pseudo attribute 'set' method. |
| DbPseudoAttribute.SetRefDelegate | Delegate to use for writing ref pseudo attribute 'set' method. |
| DbPseudoAttribute.SetStringDelegate | Delegate to use for writing string pseudo attribute 'set' method. |
| DbUndoEventHandler | Deprecated- do not use |
| Enumeration | Description |
|---|---|
| DbAttributeChangeCode | List of Design change codes * Mirrors the Fortran constants K:CHANGE.x * Enumarates possible values of the DCHC field of attributes |
| DbAttributeCopyCode | List of copy codes * Mirrors the Fortran constants K:ATTR.COPY.x * Enumerates possible values of the COPY field of attributes |
| DbAttributeDefinition | Attribute definitions, DDL or Pseudo * Mirrors the Fortran constants K:ATTR.DEF.x * Enumerates possible values of the DEFI and WDEFI fields for attributes |
| DbAttributeField | List of Attribute component field identifiers. |
| DbAttributeIntrepidQueryType | List of Intrepid Query Types * Enumerates possible values of the ITYP field of attributes |
| DbAttributeIntTableType | Integer Table Types * Enumerates possible values of the TBLTYP field of attributes |
| DbAttributePrecisionCode | List of default precision codes * Enumerates possible values of the DFDP field of attributes |
| DbAttributePseudoCodeLocation | Code locations * Mirrors the Fortran constants K:ATTR.PSEUDO.x * Enumerates possible values of the PSCODE field of attributes |
| DbAttributeQualifier | List of qualifiers * Mirrors the Fortran constants K:ATTR.QUAL.x * Enumerates possible values of the QUAL field of attributes |
| DbAttributeSpecialField | Other attribute information which may be included in tabular output. The values of special fields may be derived from fields or other information on the output. Special fields must be supported by the GetAsString method, and can thus be used in Attribute Formatters. However, they cannot be used in most other pleaces where a field may be. |
| DbAttributeType | List of Attribute Type identifiers. |
| DbAttributeUnit | List of Unit identifiers available for Attribute values. |
| DbEvents.operation | List of potential database operations. |
| DbExpressionType | List of Expression Type identifiers. |
| DbFieldFormatDefaultAction | Actions a field formatter may take when no specific substitute string has been defined for the value found |
| DbFieldType | List of attribute and noun field types |
| DbNounClaimSignificance | Claim Significance * Mirrors the Fortran constants K:CLAIM.x * Enumerates possible values of the CSIG field for nouns |
| DbNounComponentFlag | Component flag * Mirrors the Fortran constants K:NOUN.COMP.x * Enumerates possible values of component integer fields for nouns: HULC, PIPC, HOLC, CATC, DTXC, COMC, EQUC, FRMC, PFRC, FITC, GMTC, GMSC, DTSC, NGMC, HNGC, JOIC, PLNC, PRFC, PTSC, PSKC, BUIC |
| DbNounDefinition | Noun definitions, DDL or Pseudo * Mirrors the Fortran constants K:NOUN.DEF.x * Enumerates possible values of the DEFI field for nouns |
| DbNounDraftGraphicalCode | PSFrst * Mirrors the Fortran constants K:GCODE.x * Enumerates possible values of GCODE field for nouns: |
| DbNounField | List of Element component field identifiers. |
| DbNounGraphics | Noun graphics * Mirrors the Fortran constants K:GRAPHICS.x * Enumerates possible values of the GRAPH field for nouns |
| DbNounManual | Noun Manual Categories NB: This must mirror the K:NOUN.MANUAL constants in noun_type.mcr Underscores in names will be replaced by space before presentation in the manual |
| DbNounMap | Significance with respect to spatial map * Mirrors the Fortran constants K:MAP.x * Enumerates possible values of the IMAP field for nouns |
| DbNounPsFrst | PSFrst * Mirrors the Fortran constants K:PSFRST.x * Enumerates possible values of PSFRST field for nouns: |
| DbNounPsNext | PSNext * Mirrors the Fortran constants K:PSNEXT.x * Enumerates possible values of PSNEXT field for nouns: |
| DbNounPsOwnr | PSOwnr * Mirrors the Fortran constants K:PSOWNR.x * Enumerates possible values of PSOWNR field for nouns: |
| DbNounSecondaryHier | Noun secondary hierarchy * Enumerates possible values of the SECOND field for nouns |
| DbNounSpecialField | Other DbElementType information which may be included in tabular output. The values of special fields may be derived from fields or other information on the output. Special fields must be supported by the GetAsString method, and can thus be used in DbElementTypeFormats. However, they cannot be used in most other pleaces where a field may be. |
| DbNounValidC | Validity of querying connections * Enumerates possible values of the VALIDC field for nouns |
| DbParameterType | List of Parameter Type identifiers. |
| DbProjectType | List of Project Type identifiers. |
| DbRuleStatus | List of Rule Status identifiers. |
| DbType | List of Database Type identifiers. |
| DbUnits | List of dimension Unit identifiers. |
| DbWriteMode | List of Database write-mode identifiers. |