ldas-tools-framecpp
2.6.2
|
#include <framecpp_config.h>
#include <fstream>
#include <memory>
#include "framecpp/Common/FrameSpec.hh"
#include "framecpp/Common/IOStream.hh"
#include "framecpp/Common/Verify.hh"
#include "framecppc/Stream.h"
#include "FrameCInternal.hh"
#include "StreamInternal.hh"
Namespaces | |
FrameC | |
Routines related to implementing the C interface. | |
Typedefs | |
typedef FrameCPP::Common::FrameBuffer< filebuf > | FrameBuffer |
Functions | |
template<> | |
pointer_type | FrameC::PointerType (fr_file_t *Value) |
fr_file_t * | FrameCFileOpen (FrameCError **Error, const char *Filename, const fr_file_mode_t Mode) |
Open a stream. More... | |
int | FrameCFileClose (FrameCError **Error, fr_file_t *Stream) |
Close an open stream. More... | |
int | FrameCFileFree (FrameCError **Error, fr_file_t *Stream) |
Recycle the file structure. More... | |
int | FrameCFrameLibrary (FrameCError **Error, fr_file_t *Stream) |
Obtains the name of the frame library id of the stream. More... | |
int | FrameCFrameLibraryName (FrameCError **Error, fr_file_t *Stream, char *Buffer, size_t BufferSize) |
Obtains the name of the frame library of the stream. More... | |
int | FrameCFrameLibraryVersion (FrameCError **Error, fr_file_t *Stream) |
Obtain the major version of the frame specification. More... | |
int | FrameCFrameLibraryVersionMinor (FrameCError **Error, fr_file_t *Stream) |
Obtain the library version. More... | |
int | FrameCFileCksumValid (FrameCError **Error, fr_file_t *Stream) |
Verify the frame file checksum. More... | |
typedef FrameCPP::Common::FrameBuffer< filebuf > FrameBuffer |
int FrameCFileCksumValid | ( | FrameCError ** | Error, |
fr_file_t * | Stream | ||
) |
Verify the frame file checksum.
Validate the file checksum of the stream. This is a lenghty process and should be avoided. Beginning with version 8 of the frame specification, Individual channels are validated using the per structure checksums.
int FrameCFileClose | ( | FrameCError ** | Error, |
fr_file_t * | Stream | ||
) |
Close an open stream.
[out] | Error | If an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError. |
[in] | Stream | The stream to close. |
int FrameCFileFree | ( | FrameCError ** | Error, |
fr_file_t * | Stream | ||
) |
Recycle the file structure.
[out] | Error | If an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError. |
[in] | Stream | The stream whos resources will be released. |
fr_file_t* FrameCFileOpen | ( | FrameCError ** | Error, |
const char * | Filename, | ||
const fr_file_mode_t | Mode | ||
) |
Open a stream.
[out] | Error | If an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError. |
[in] | Filename | Name of the stream to open. |
[in] | Mode | Specifies if the file should be open for input or output. |
int FrameCFrameLibrary | ( | FrameCError ** | Error, |
fr_file_t * | Stream | ||
) |
Obtains the name of the frame library id of the stream.
[out] | Error | If an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError. |
[in] | Stream | The stream from which to read the table of contents. |
int FrameCFrameLibraryName | ( | FrameCError ** | Error, |
fr_file_t * | Stream, | ||
char * | Buffer, | ||
size_t | BufferSize | ||
) |
Obtains the name of the frame library of the stream.
[out] | Error | If an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError. |
[in] | Stream | The stream from which to read the table of contents. |
[out] | Buffer | Allocated buffer to receive the frame library name. |
[in] | BufferSize | Maximum size of Buffer |
int FrameCFrameLibraryVersion | ( | FrameCError ** | Error, |
fr_file_t * | Stream | ||
) |
Obtain the major version of the frame specification.
[out] | Error | If an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError. |
[in] | Stream | The stream for which to obtain the frame specification. |
int FrameCFrameLibraryVersionMinor | ( | FrameCError ** | Error, |
fr_file_t * | Stream | ||
) |
Obtain the library version.
[out] | Error | If an error occurs, this will contain the details of the error. For full details on error processing, please refer to FrameCError. |
[in] | Stream | The stream for which to obtain the library version. |