TSP: The Transport Sample Protocol



Generic Reader Library
[Generic File ReaderTSP Libraries]

Collaboration diagram for Generic Reader Library:The TSP generic reader provider library API. More...


Modules

 Macsim Format Library
 The library is used to read a Macsim File by the Generic Reader.

Functions

GenericReader_T * genreader_create (FmtHandler_T *fmtHandler)
 create the generic reader
FmtHandler_T * genreader_createFmHandler (char *format_file, char *file_name)
 create the handler for a format file
int32_t genreader_finalize ()
 destroy the fmtHandler and generic reader
int32_t genreader_open (GenericReader_T *genreader)
 open the file to treat
int32_t genreader_read_header (GenericReader_T *genreader)
 create the symbol info and extended info list
int32_t genreader_read_header_create_symbole (GenericReader_T *genreader)
 add symbol info and extended info to the symbol and extended list


Detailed Description

The TSP generic reader provider library API.


Function Documentation

GenericReader_T* genreader_create ( FmtHandler_T *  fmtHandler  ) 

create the generic reader

Parameters:
[in] fmtHandler the file handler
Returns:
the generic reader

FmtHandler_T* genreader_createFmHandler ( char *  format_file,
char *  file_name 
)

create the handler for a format file

Parameters:
[in] format_file the file format to treat
[in] file_name the file name
Returns:
the fmtHandler

int32_t genreader_finalize (  ) 

destroy the fmtHandler and generic reader

Returns:
TSP_STATUS_OK if OK

int32_t genreader_open ( GenericReader_T *  genreader  ) 

open the file to treat

Parameters:
[in] genreader the generic reader who contain the information about the file
Returns:
TSP_STATUS_OK if OK

int32_t genreader_read_header ( GenericReader_T *  genreader  ) 

create the symbol info and extended info list

Parameters:
[in] genreader the generic reader who contain the information about the file
Returns:
TSP_STATUS_OK if OK

int32_t genreader_read_header_create_symbole ( GenericReader_T *  genreader  ) 

add symbol info and extended info to the symbol and extended list

Parameters:
[in] genreader the generic reader who contain the information about the file
Returns:
TSP_STATUS_OK if OK

Framework Home Page.


Beware !! TSP wave is coming...