TSP: The Transport Sample Protocol



Sample Symbol Information Library Handling
[TSP Common Library]

Collaboration diagram for Sample Symbol Information Library Handling:The Sample Symbol Information Handling part of the TSP Common Library regroup a set of functions which should be used to manipulate the Sample Symbol Information object and list of them. More...

Functions

_EXPORT_TSP_COMMON int32_t TSP_SSI_copy (TSP_sample_symbol_info_t *dst_ssi, const TSP_sample_symbol_info_t src_ssi)
 Copy a Sample Symbol Information Structure.
_EXPORT_TSP_COMMON int32_t TSP_SSI_delete (TSP_sample_symbol_info_t **ssi)
 delete the data.
_EXPORT_TSP_COMMON int32_t TSP_SSI_finalize (TSP_sample_symbol_info_t *ssi)
 delete the data and his contain.
_EXPORT_TSP_COMMON int32_t TSP_SSI_initialize (TSP_sample_symbol_info_t *ssi, const char *name, int32_t pgi, int32_t pgridx, int32_t pgrank, int32_t type, int32_t dimension, int32_t offset, int32_t nelem, int32_t period, int32_t phase)
 initialize a sample symbol info.
_EXPORT_TSP_COMMON int32_t TSP_SSI_initialize_default (TSP_sample_symbol_info_t *ssi)
 Initialize (default value) a Sample Symbol Information Structure.
_EXPORT_TSP_COMMON int32_t TSP_SSI_initialize_request_full (TSP_sample_symbol_info_t *ssi, const char *name, int32_t type, int32_t dimension, int32_t offset, int32_t nelem, int32_t period, int32_t phase)
 initialize the request for a sample symbol info.
_EXPORT_TSP_COMMON int32_t TSP_SSI_initialize_request_minimal (TSP_sample_symbol_info_t *ssi, const char *name, int32_t period)
 initialize the minimal request for a sample symbol info.
BEGIN_C_DECLS _EXPORT_TSP_COMMON
TSP_sample_symbol_info_t
TSP_SSI_new (const char *name, int32_t pgi, int32_t pgridx, int32_t pgrank, int32_t type, int32_t dimension, int32_t offset, int32_t nelem, int32_t period, int32_t phase)
 create a sample symbol info.
_EXPORT_TSP_COMMON int32_t TSP_SSIList_copy (TSP_sample_symbol_info_list_t *dst_ssil, const TSP_sample_symbol_info_list_t src_ssil)
 Copy a list of symbols from src_symbols to dst_ssil.
_EXPORT_TSP_COMMON int32_t TSP_SSIList_delete (TSP_sample_symbol_info_list_t **ssi)
 delete the data.
_EXPORT_TSP_COMMON int32_t TSP_SSIList_finalize (TSP_sample_symbol_info_list_t *ssil)
 Delete the contain of the data.
_EXPORT_TSP_COMMON int32_t TSP_SSIList_initialize (TSP_sample_symbol_info_list_t *ssil, int32_t nbSSI)
 Initialize a preallocated list of sample symbol information.
_EXPORT_TSP_COMMON TSP_sample_symbol_info_list_tTSP_SSIList_new (int32_t nbSSI)
 Allocate a list of sample symbol information and initialize it.


Detailed Description

The Sample Symbol Information Handling part of the TSP Common Library regroup a set of functions which should be used to manipulate the Sample Symbol Information object and list of them.


Function Documentation

_EXPORT_TSP_COMMON int32_t TSP_SSI_copy ( TSP_sample_symbol_info_t dst_ssi,
const TSP_sample_symbol_info_t  src_ssi 
)

Copy a Sample Symbol Information Structure.

Parameters:
[in,out] dst_ssi the (preallocated) sample symbol information structure. The structure should be allocated but not the member of the structure. On entry should be a non NULL pointer to TSP_sample_symbol_info_t. On return contains the .
[in] src_ssi return TSP_STATUS_OK if ok

_EXPORT_TSP_COMMON int32_t TSP_SSI_delete ( TSP_sample_symbol_info_t **  ssi  ) 

delete the data.

Parameters:
[in] ssi the symbols list to destruct return TSP_STATUS_OK if ok

_EXPORT_TSP_COMMON int32_t TSP_SSI_finalize ( TSP_sample_symbol_info_t ssi  ) 

delete the data and his contain.

Parameters:
[in] ssi the symbols list to destruct return TSP_STATUS_OK if ok

_EXPORT_TSP_COMMON int32_t TSP_SSI_initialize ( TSP_sample_symbol_info_t ssi,
const char *  name,
int32_t  pgi,
int32_t  pgridx,
int32_t  pgrank,
int32_t  type,
int32_t  dimension,
int32_t  offset,
int32_t  nelem,
int32_t  period,
int32_t  phase 
)

initialize a sample symbol info.

Parameters:
[in,out] ssi the symbol to initialize
[in] name the symbol name
[in] pgi the symbol pgi
[in] pgridx the symbol groupe index
[in] pgrank the symbol rank
[in] type the symbol type
[in] dimension the symbol dimension
[in] offset the symbol indice of first element
[in] nelem the number of symbol to obtain
[in] period the symbol perid
[in] phase the symbol phase return TSP_STATUS_OK if ok

_EXPORT_TSP_COMMON int32_t TSP_SSI_initialize_default ( TSP_sample_symbol_info_t ssi  ) 

Initialize (default value) a Sample Symbol Information Structure.

This does provide "reasonable" default values to all field. BEWARE that the name field is nullified too.

Parameters:
[in,out] ssi the (preallocated) sample symbol information structure. The structure should be allocated but not the member of the structure. On entry should be a non NULL pointer to TSP_sample_symbol_info_t. On return the initialized structure.
Returns:
TSP_STATUS_OK on success

_EXPORT_TSP_COMMON int32_t TSP_SSI_initialize_request_full ( TSP_sample_symbol_info_t ssi,
const char *  name,
int32_t  type,
int32_t  dimension,
int32_t  offset,
int32_t  nelem,
int32_t  period,
int32_t  phase 
)

initialize the request for a sample symbol info.

Parameters:
[in,out] ssi the symbol to request
[in] name the symbol name
[in] type the symbol type
[in] dimension the symbol dimension
[in] offset the symbol indice of first element
[in] nelem the number of symbol to obtain
[in] period the symbol perid
[in] phase the symbol phase return TSP_STATUS_OK if ok

_EXPORT_TSP_COMMON int32_t TSP_SSI_initialize_request_minimal ( TSP_sample_symbol_info_t ssi,
const char *  name,
int32_t  period 
)

initialize the minimal request for a sample symbol info.

Parameters:
[in,out] ssi the symbol to request
[in] name the symbol name
[in] period the symbol period return TSP_STATUS_OK if ok

BEGIN_C_DECLS _EXPORT_TSP_COMMON TSP_sample_symbol_info_t* TSP_SSI_new ( const char *  name,
int32_t  pgi,
int32_t  pgridx,
int32_t  pgrank,
int32_t  type,
int32_t  dimension,
int32_t  offset,
int32_t  nelem,
int32_t  period,
int32_t  phase 
)

create a sample symbol info.

Parameters:
[in] name the symbol name
[in] pgi the symbol pgi
[in] pgridx the symbol group index
[in] pgrank the symbol rank
[in] type the symbol type
[in] dimension the symbol dimension
[in] offset the symbol indice of first element
[in] nelem the number of symbol to obtain
[in] period the symbol perid
[in] phase the symbol phase return the new tsp_sample_symbol_info_t

_EXPORT_TSP_COMMON int32_t TSP_SSIList_copy ( TSP_sample_symbol_info_list_t dst_ssil,
const TSP_sample_symbol_info_list_t  src_ssil 
)

Copy a list of symbols from src_symbols to dst_ssil.

Parameters:
[out] dst_ssil the symbols list copy destination
[in] src_ssil the symbols list copy source return TSP_STATUS_OK if ok

_EXPORT_TSP_COMMON int32_t TSP_SSIList_delete ( TSP_sample_symbol_info_list_t **  ssi  ) 

delete the data.

Parameters:
[in] ssi the symbols list to destruct return TSP_STATUS_OK if ok

_EXPORT_TSP_COMMON int32_t TSP_SSIList_finalize ( TSP_sample_symbol_info_list_t ssil  ) 

Delete the contain of the data.

Parameters:
[in] ssil the symbols list to destruct return TSP_STATUS_OK if ok

_EXPORT_TSP_COMMON int32_t TSP_SSIList_initialize ( TSP_sample_symbol_info_list_t ssil,
int32_t  nbSSI 
)

Initialize a preallocated list of sample symbol information.

return TSP_STATUS_OK if ok

Precondition:
ssil must not be NULL.
Parameters:
[in,out] ssil the list to be initialized.
[in] nbSSI the number of Sample Symbol Information to be contained in the SSIList
Postcondition:
ssil contains the description of a SSIList with nbSSI symbols. Each item of the list has been default initialized.

_EXPORT_TSP_COMMON TSP_sample_symbol_info_list_t* TSP_SSIList_new ( int32_t  nbSSI  ) 

Allocate a list of sample symbol information and initialize it.

Parameters:
[in] nbSSI the number of SSI in the to be created in the list.
Returns:
the allocated list on success NULL on failure.

Framework Home Page.


Beware !! TSP wave is coming...