DelftIO Par./Loc./Time (PLT),   VB / Java / .NET Interface

Functions

The following functions are available:

Define Dataset on a file  
constructor DioPlt Define a Par./Loc./Time dataset (name, parameters and locations).
The function returns a handle to the PLT dataset.
constructor DioPlt Define a Par./Loc./Time dataset (name, parameters, locations and Julian start time)
The function returns a handle to the PLT dataset.
constructor DioPlt Define a Par./Loc./Time dataset for 'Delwaq Map' file (name, parameters and numberOfLocations).
The function returns a handle to the PLT dataset.
constructor DioPlt The function returns a handle to the PLT dataset. Define a Par./Loc./Time dataset (name, parameters, numberOfLocations and Julian start time)
Write values  
PutFloats Put floats (=reals) for a certain Julian time stamp.
PutNextFloats Put floats (=reals) for next time step. Used for on line communication.
Get Dataset from a file  
constructor DioPlt Get a Par./Loc./Time dataset
The function returns a handle to the PLT dataset
GetNPars Get number of parameters in the PLT dataset
GetNLocs Get number of locations in the PLT dataset
GetNTimes Get number of time steps in the PLT dataset
GetPars Get the parameter names in the PLT dataset
GetLocs Get the location names in the PLT dataset
GetTimes Get the time steps in the PLT dataset (Julian time stamps)
Read values  
GetFloats Get floats (=reals) for a certain Julian time stamp.
GetNextFloats Get floats (=reals) for next time step. Used for on line communication.
Cleanup  
Close Close and destroy the PLT dataset

Put a dataset on a stream

step 1: define the dataset

constructor Define_1(name, varType, nPar, pars, nLoc, locs)

arguments      
character*(*) name I datasetname
integer varType I type of variable to be stored in dataset
integer nPar I number of parameters
character*(Len=DioMaxParLen)
dimension pars(nPar)		 pars I array with names of the parameter in the dataset
integer nLoc I number of locations
character*(Len=DioMaxLocLen)
dimension locs(nLoc)		 locs I array with names of the locations in the dataset

constructor Define_2(name, varType, nPar, pars, nLoc, locs, julianStartTime)

arguments      
character*(*) name I datasetname
integer varType I type of variable to be stored in dataset
integer nPar I number of parameters
character*(Len=DioMaxParLen)
dimension pars(nPar)		 pars I array with names of the parameter in the dataset
integer nLoc I number of locations
character*(Len=DioMaxLocLen)
dimension locs(nLoc)		 locs I array with names of the locations in the dataset
double precision julianStartTime I startTime as Julian

constructor Define_3(name, varType, nPar, pars, nLoc)

arguments      
character*(*) name I datasetname
integer varType I type of variable to be stored in dataset
integer nPar I number of parameters
character*(Len=DioMaxParLen)
dimension pars(nPar)		 pars I array with names of the parameter in the dataset
integer nLoc I number of locations
character*(Len=DioMaxLocLen)
dimension locs(nLoc)		 locs I array with names of the locations in the dataset

constructor Define_4(name, varType, nPar, pars, nLoc, julianStartTime)

arguments      
character*(*) name I datasetname
integer varType I type of variable to be stored in dataset
integer nPar I number of parameters
character*(Len=DioMaxParLen)
dimension pars(nPar)		 pars I array with names of the parameter in the dataset
integer nLoc I number of locations
double precision julianStartTime I startTime as Julian

step 2: write the data

PutFloats(timestamp, nPar, nLoc, values)

arguments   I/O  
double precision timestamp I time stamp as Julian
integer nPar I number of parameters
integer nLoc I number of locations
real
dimension values(nPar,nLoc)		 values I 2D-array with real values to be put.

PutNextFloats(nPar, nLoc, values)

arguments   I/O  
integer nPar I number of parameters
integer nLoc I number of locations
real
dimension values(nPar,nLoc)		 values I 2D-array with real values to be put.

Get a dataset from a stream

step 1: get the dataset information

constructor GetDataset(name)

return value   I/O  
integer   (O) Handle to Parameter/Location/Time dataset.
0: Error occured
>0: Valid handle
arguments      
character*(*) name I datasetname

integer GetNPars()

return value   I/O  
integer   (O) Number of parameters in PLT dataset
>0: OK.
0: Call GetLastError to Check if indeed there are 0 parameters, or if an error has occured

integer GetNLocs()

d
return value   I/O  
integer   (O) number of locations in PLT dataset
>0: OK.
0: Call GetLastError to Check if indeed there are 0 locations, or if an error has occured

integer GetNTimes()

return value   I/O  
integer   (O) number of timesteps in PLT dataset
>0: OK.
0: Call GetLastError to Check if indeed there are 0 time steps, or if an error has occured

boolean GetPars(nPar, pars)

return value   I/O  
logical   (O) True: OK
False: error
arguments      
integer nPar I number of parameters
character*(Len=DioMaxParLen),
dimension pars(nPar)		 pars O array with names of the parameters in the dataset

boolean GetLocs(nLoc, locs)

return value   I/O  
integer   (O) True: OK
False: error
arguments      
integer nLoc I number of locations
character*(Len=DioMaxLocLen),
dimension locs(nLoc)		 locs O array with names of the locations in the dataset

boolean GetTimes(nTime, times)

return value   I/O  
integer   (O) True: OK
False: error
arguments      
integer nTime I number of time stamps
double precision times O array with julian time stamps

step 2: read the data

boolean GetNextFloats(nPar, nLoc, timestamp, values)

return value   I/O  
boolean   (O) True: OK
False: error
arguments   I/O  
integer nPar I number of parameters
integer nLoc I number of locations
double precision timestamp O Juliantime stamp of retrieved next values as
real,
dimension values(nPar,nLoc)		 values O 2D-array with retrieved real values

Cleanup

Close()

arguments   I/O  
-   -