ldas-tools-framecpp 3.0.4
 
Loading...
Searching...
No Matches
FrameCPP::Version_8::FrEndOfFileImpl::Data Class Reference

#include <FrEndOfFileData.hh>

Inheritance diagram for FrameCPP::Version_8::FrEndOfFileImpl::Data:

Public Types

typedef FR_END_OF_FILE_N_FRAMES_TYPE nFrames_type
 
typedef FR_END_OF_FILE_N_BYTES_TYPE nBytes_type
 
typedef FR_END_OF_FILE_SEEK_TOC_TYPE seekTOC_type
 
typedef FR_END_OF_FILE_CHK_SUM_FR_HEADER_TYPE chkSumFrHeader_type
 
typedef FR_END_OF_FILE_CHK_SUM_TYPE chkSum_type
 
typedef FR_END_OF_FILE_CHK_SUM_FILE_TYPE chkSumFile_type
 
typedef FR_END_OF_FILE_N_FRAMES_TYPE nFrames_type
 
typedef FR_END_OF_FILE_N_BYTES_TYPE nBytes_type
 
typedef FR_END_OF_FILE_SEEK_TOC_TYPE seekTOC_type
 
typedef FR_END_OF_FILE_CHK_SUM_FR_HEADER_TYPE chkSumFrHeader_type
 
typedef FR_END_OF_FILE_CHK_SUM_TYPE chkSum_type
 
typedef FR_END_OF_FILE_CHK_SUM_FILE_TYPE chkSumFile_type
 

Public Member Functions

 Data ()
 Default constructor.
 
chkSum_type GetChkSum () const
 Retrieve the checksum.
 
chkSumFile_type GetChkSumFile () const
 Retrieve the file checksum.
 
chkSumFrHeader_type GetChkSumFrHeader () const
 Retrieve the FrHeader checksum.
 
nBytes_type GetNBytes () const
 Retrieve the total number of bytes in this file.
 
nFrames_type GetNFrames () const
 Retrieve the number of frames in this file.
 
seekTOC_type GetSeekTOC () const
 Retrieve the location of the table of contents.
 
 Data ()
 Default constructor.
 
chkSum_type GetChkSum () const
 Retrieve the checksum.
 
chkSumFile_type GetChkSumFile () const
 Retrieve the file checksum.
 
chkSumFrHeader_type GetChkSumFrHeader () const
 Retrieve the FrHeader checksum.
 
nBytes_type GetNBytes () const
 Retrieve the total number of bytes in this file.
 
nFrames_type GetNFrames () const
 Retrieve the number of frames in this file.
 
seekTOC_type GetSeekTOC () const
 Retrieve the location of the table of contents.
 

Protected Attributes

nFrames_type nFrames
 Number of frames in this file.
 
nBytes_type nBytes
 Total number of bytes in the file; zero if not computed.
 
seekTOC_type seekTOC
 
chkSumFrHeader_type chkSumFrHeader
 FrHeader checksum.
 
chkSum_type chkSum
 
chkSumFile_type chkSumFile
 File checksum.
 

Member Typedef Documentation

◆ chkSum_type [1/2]

◆ chkSum_type [2/2]

◆ chkSumFile_type [1/2]

◆ chkSumFile_type [2/2]

◆ chkSumFrHeader_type [1/2]

◆ chkSumFrHeader_type [2/2]

◆ nBytes_type [1/2]

◆ nBytes_type [2/2]

◆ nFrames_type [1/2]

◆ nFrames_type [2/2]

◆ seekTOC_type [1/2]

◆ seekTOC_type [2/2]

Constructor & Destructor Documentation

◆ Data() [1/2]

FrameCPP::Version_8::FrEndOfFileImpl::Data::Data ( )
inline

Default constructor.

◆ Data() [2/2]

FrameCPP::Version_8::FrEndOfFileImpl::Data::Data ( )
inline

Default constructor.

Member Function Documentation

◆ GetChkSum() [1/2]

chkSum_type FrameCPP::Version_8::FrEndOfFileImpl::Data::GetChkSum ( ) const
inline

Retrieve the checksum.

Returns
The checksum.

◆ GetChkSum() [2/2]

chkSum_type FrameCPP::Version_8::FrEndOfFileImpl::Data::GetChkSum ( ) const
inline

Retrieve the checksum.

Returns
The checksum.

◆ GetChkSumFile() [1/2]

chkSumFile_type FrameCPP::Version_8::FrEndOfFileImpl::Data::GetChkSumFile ( ) const
inline

Retrieve the file checksum.

Returns
The file checksum.

◆ GetChkSumFile() [2/2]

chkSumFile_type FrameCPP::Version_8::FrEndOfFileImpl::Data::GetChkSumFile ( ) const
inline

Retrieve the file checksum.

Returns
The file checksum.

◆ GetChkSumFrHeader() [1/2]

chkSumFrHeader_type FrameCPP::Version_8::FrEndOfFileImpl::Data::GetChkSumFrHeader ( ) const
inline

Retrieve the FrHeader checksum.

Returns
The FrHEader checksum.

◆ GetChkSumFrHeader() [2/2]

chkSumFrHeader_type FrameCPP::Version_8::FrEndOfFileImpl::Data::GetChkSumFrHeader ( ) const
inline

Retrieve the FrHeader checksum.

Returns
The FrHEader checksum.

◆ GetNBytes() [1/2]

nBytes_type FrameCPP::Version_8::FrEndOfFileImpl::Data::GetNBytes ( ) const
inline

Retrieve the total number of bytes in this file.

Returns
The total number of bytes in this file.

◆ GetNBytes() [2/2]

nBytes_type FrameCPP::Version_8::FrEndOfFileImpl::Data::GetNBytes ( ) const
inline

Retrieve the total number of bytes in this file.

Returns
The total number of bytes in this file.

◆ GetNFrames() [1/2]

nFrames_type FrameCPP::Version_8::FrEndOfFileImpl::Data::GetNFrames ( ) const
inline

Retrieve the number of frames in this file.

Returns
The number of frames in this file.

◆ GetNFrames() [2/2]

nFrames_type FrameCPP::Version_8::FrEndOfFileImpl::Data::GetNFrames ( ) const
inline

Retrieve the number of frames in this file.

Returns
The number of frames in this file.

◆ GetSeekTOC() [1/2]

seekTOC_type FrameCPP::Version_8::FrEndOfFileImpl::Data::GetSeekTOC ( ) const
inline

Retrieve the location of the table of contents.

Returns
The location of the table of contents.

◆ GetSeekTOC() [2/2]

seekTOC_type FrameCPP::Version_8::FrEndOfFileImpl::Data::GetSeekTOC ( ) const
inline

Retrieve the location of the table of contents.

Returns
The location of the table of contents.

Member Data Documentation

◆ chkSum

chkSum_type FrameCPP::Version_8::FrEndOfFileImpl::Data::chkSum
protected

Structure checksum.

Note
The chkSum AND chkSumFile ariables are not included in the computation of checkSum, but chkSumFrHeader is includeed

◆ chkSumFile

chkSumFile_type FrameCPP::Version_8::FrEndOfFileImpl::Data::chkSumFile
protected

File checksum.

◆ chkSumFrHeader

chkSumFrHeader_type FrameCPP::Version_8::FrEndOfFileImpl::Data::chkSumFrHeader
protected

FrHeader checksum.

◆ nBytes

nBytes_type FrameCPP::Version_8::FrEndOfFileImpl::Data::nBytes
protected

Total number of bytes in the file; zero if not computed.

◆ nFrames

nFrames_type FrameCPP::Version_8::FrEndOfFileImpl::Data::nFrames
protected

Number of frames in this file.

◆ seekTOC

seekTOC_type FrameCPP::Version_8::FrEndOfFileImpl::Data::seekTOC
protected

Bytes to back up to the Beginning of the table of contents structure. If seekTOC is zero, then there is no table of contents for this file.


The documentation for this class was generated from the following files: