Miscellaneous Routines

• ADF_Flush_to_Disk - Flush the data to a disk
• ADF_Database_Garbage_Collection - Garbage collection
• ADF_Error_Message - Return an error message
• ADF_Set_Error_State - Set the error state
• ADF_Get_Error_State - Get the error state
• ADF_Database_Version - Get the ADF file version ID
• ADF_Library_Version - Get the ADF library version ID

Flush the Data to the Disk

This routine, ADF_Flush_to_Disk, flushes data to disk; it is used to force any modified information to be flushed to the physical disk. This ensures that data will not be lost if a program aborts. The control of when to flush all data to disk is provided to the user rather than flushing the data every time it is modified, which would result in reduced performance.

Redistribute the Data Within a File

This routine, ADF_Database_Garbage_Collection, redistributes the data within a file to use free space within the file. This free space is not located at the end of the file, and it may have been created during node deletions or other file operations. Neighboring free spaces will be merged.

Note: For better file compaction, a utility could be written to copy an ADF file into a newly created ADF file without wasted space.

Note: This routine is currently not implemented.

Get a Description of the Error

This routine, ADF_Error_Message, returns a textual error message when given the error return code from any ADF routine.

Example

See the example for ADF_Set_Error_State.

Set the Error State Flag

This routine, ADF_Set_Error_State, sets the error state flag. This flag controls the error handling convention for all ADF routines: either return the error codes or print an error message and abort the program on error. The flag covers all open ADF files associated with the current program, and it is not done on a file-by-file basis. The default state for the ADF interface is to return error codes and not abort.

Example

   PROGRAM TEST
   C
         PARAMETER (MAXCHR=32)
   C
         CHARACTER*(MAXCHR) NODNAM
         CHARACTER*(80) MESS
   C
   C *** NODE IDS
   C
         REAL*8 RID,CID1,CID2
   C
   C *** OPEN DATABASE
   C
         CALL ADFDOPN('db.adf','NEW',' ',RID,IERR)
   C
   C *** CREATE 2 NODES
   C
         CALL ADFCRE(RID,'NODE 1',CID1,IERR)
         CALL ADFCRE(RID,'NODE 2',CID2,IERR)
   C
         CALL ADFGES(IDEFS,IERR)
         PRINT *,' DEFAULT ERROR STATE = ',IDEFS
   C
   C *** REQUEST NODE NAME FOR A NODE THAT DOES NOT EXIST
   C
         PRINT *,' *** ON ERROR CONTINUE'
         CALL ADFGNAM(CID3,NODNAM,IERR)
         CALL ADFERR(IERR,MESS)
         PRINT *,'     ADF ERROR OCURRED, MESSAGE: ',MESS
         PRINT *,' '
   C
   C *** SET ABORT ON ERROR FLAG
   C
         INEWS = 1
         CALL ADFSES(INEWS,IERR)
         PRINT *,' *** ABORT ON ERROR SET'
   C
   C *** REQUEST NODE NAME FOR A NODE THAT DOES NOT EXIST
   C
         CALL ADFGNAM(CID3,NODNAM,IERR)
         PRINT *,' HELLO WORLD'
   C
         STOP
         END

The resulting output is:

   DEFAULT ERROR STATE =            0
     *** ON ERROR CONTINUE
         ADF ERROR OCURRED, MESSAGE:
   ADF 10: ADF file index out of legal range.

     *** ABORT ON ERROR SET
   ADF 10: ADF file index out of legal range.
   ADF Aborted: Exiting

Get the Error State

This routine, ADF_Get_Error_State, returns the currently set error state.

Example

   PROGRAM TEST
   C
   C *** NODE IDS
   C
         REAL*8 RID
   C
   C *** OPEN DATABASE
   C
         CALL ADFDOPN('db.adf','NEW',' ',RID,IERR)
   C
   C *** CHECK THE DEFAULT ERROR STATE
   C
         CALL ADFGES(IDEFS,IERR)
   C
   C *** SET THE ERROR STATE TO ABORT ON ERROR
   C
         CALL ADFSES(1,IERR)
   C
   C *** MAKE SURE STATE WAS SET AS DESIRED
   C
         CALL ADFGES(NDEFS,IERR)
   C
   C *** PRINT OUT RESULTS
   C
         PRINT *,' DEFAULT ERROR STATE = ',IDEFS
         PRINT *,' RESET ERROR STATE   = ',NDEFS
   C
         STOP
         END

The resulting output is:

   DEFAULT ERROR STATE =            0
   RESET ERROR STATE   =            1

Get the Version Number of the ADF Library That Created the ADF Database

This routine, ADF_Database_Version, returns the version number of the ADF library that created an ADF database, the file creation date and time, and the last modification date and time. A modified ADF database will take on the version ID of the current ADF library version if it is higher than the version indicated in the file. On return, "version" contains a six-character string. The meaning of the characters are described in detail in the section "ADF File Version Control Numbering".

Example

   PROGRAM TEST
   C
         PARAMETER (MAXCHR=32)
   C
         CHARACTER*(MAXCHR) NODNAM
         CHARACTER*(MAXCHR) CVER,LVER,CDATE,MDATE
         CHARACTER*(80) MESS
   C
   C *** NODE IDS
   C
         REAL*8 RID,CID1,CID2
   C
   C *** OPEN DATABASE
   C
         CALL ADFDOPN('db.adf','NEW',' ',RID,IERR)
   C
   C *** CREATE 2 NODES
   C
         CALL ADFCRE(RID,'NODE 1',CID1,IERR)
         CALL ADFCRE(RID,'NODE 2',CID2,IERR)
   C
         CALL ADFDVER(RID,CVER,CDATE,MDATE,IERR)
         CALL ADFLVER(LVER,IERR)
         PRINT *,' VERSION INFORMATION:'
         PRINT *,'    ADF LIBRARY USED FOR CREATION: ',CVER
         PRINT *,'    CREATION DATE                : ',CDATE
         PRINT *,'    MODIFICATION DATE            : ',MDATE
         PRINT *,'    ADF LIBRARY BEING USED       : ',LVER
   C
         STOP
         END

The resulting output is:

   VERSION INFORMATION:
      ADF LIBRARY USED FOR CREATION: ADF Database Version A01007
      CREATION DATE                : Thu Apr 24 15:41:55 1997
      MODIFICATION DATE            : Thu Apr 24 15:41:55 1997
      ADF LIBRARY BEING USED       : ADF Library  Version C01

Get the Version Number of the ADF Library That the Application Program is Currently Using

This routine, ADF_Library_Version, gets the ADF library version number. This is the version number of the ADF library that the application program is currently using. For this routine, the format of the version ID is "ADF Library Version AXXXxxx".

Example

See the example for ADF_Database_Version.