ldas-tools-frameAPI  2.5.1
Public Types | Public Member Functions | List of all members
FrameAPI::RDS::Options Class Reference

#include <rdsframe.hh>

Inheritance diagram for FrameAPI::RDS::Options:
FrameAPI::RDS::FileOptions

Public Types

typedef INT_4U seconds_per_frame_type
 
typedef INT_4U start_type
 
typedef INT_4U end_type
 
typedef INT_2U compression_level_type
 
typedef INT_4U frames_per_file_type
 
typedef INT_4U rds_level_type
 
typedef INT_4U padding_type
 
typedef FrameCPP::FrVect::compression_scheme_type compression_method_type
 

Public Member Functions

 Options ()
 
 Options (const start_type start, const end_type stop, const char *type, const char *compression_method, const compression_level_type level, const bool VerifyChecksum, const bool VerifyFrameChecksum, const bool VerifyTimeRange, const bool VerifyDataValid, const frames_per_file_type FramesPerFile, const seconds_per_frame_type SecondsPerFrame, const bool AllowShortFrames, const bool GenerateFrameChecksum, const bool FillMissingDataValidArray, const bool VerifyFilenameMetadata)
 
 Options (const Options &Source)
 
bool AllowShortFrames () const
 
void AllowShortFrames (bool Value)
 
compression_level_type CompressionLevel () const
 
void CompressionLevel (compression_level_type Value)
 
compression_method_type CompressionMethod () const
 
void CompressionMethod (const std::string &Value)
 
bool CreateChecksumPerFrame () const
 
void CreateChecksumPerFrame (bool Value)
 
bool FillMissingDataValidArray () const
 
void FillMissingDataValidArray (bool Value)
 
frames_per_file_type FramesPerFile () const
 
void FramesPerFile (frames_per_file_type FPF)
 
bool GenerateFrameChecksum () const
 
void GenerateFrameChecksum (bool Value)
 
bool HistoryRecord () const
 
void HistoryRecord (bool Value)
 
end_type OutputTimeEnd () const
 
void OutputTimeEnd (end_type Value)
 
start_type OutputTimeStart () const
 
void OutputTimeStart (start_type Value)
 
const std::string & OutputType () const
 
void OutputType (const std::string &Value)
 
padding_type Padding () const
 
void Padding (padding_type Value)
 
rds_level_type RDSLevel () const
 
void RDSLevel (rds_level_type Level)
 
seconds_per_frame_type SecondsPerFrame () const
 
void SecondsPerFrame (seconds_per_frame_type SPF)
 
bool VerifyChecksum () const
 
bool VerifyChecksumOfFrame () const
 
bool VerifyChecksumPerFrame () const
 
void VerifyChecksumPerFrame (bool Value)
 
bool VerifyChecksumOfStream () const
 
void VerifyChecksumOfStream (bool Value)
 
bool VerifyDataValid () const
 
void VerifyDataValid (bool Value)
 
bool VerifyFilenameMetadata () const
 
void VerifyFilenameMetadata (bool Value)
 
bool VerifyTimeRange () const
 
void VerifyTimeRange (bool Value)
 

Member Typedef Documentation

◆ compression_level_type

◆ compression_method_type

typedef FrameCPP::FrVect::compression_scheme_type FrameAPI::RDS::Options::compression_method_type

◆ end_type

◆ frames_per_file_type

◆ padding_type

◆ rds_level_type

◆ seconds_per_frame_type

◆ start_type

Constructor & Destructor Documentation

◆ Options() [1/3]

FrameAPI::RDS::Options::Options ( )

◆ Options() [2/3]

FrameAPI::RDS::Options::Options ( const start_type  start,
const end_type  stop,
const char *  type,
const char *  compression_method,
const compression_level_type  level,
const bool  VerifyChecksum,
const bool  VerifyFrameChecksum,
const bool  VerifyTimeRange,
const bool  VerifyDataValid,
const frames_per_file_type  FramesPerFile,
const seconds_per_frame_type  SecondsPerFrame,
const bool  AllowShortFrames,
const bool  GenerateFrameChecksum,
const bool  FillMissingDataValidArray,
const bool  VerifyFilenameMetadata 
)

◆ Options() [3/3]

FrameAPI::RDS::Options::Options ( const Options Source)

Member Function Documentation

◆ AllowShortFrames() [1/2]

bool FrameAPI::RDS::Options::AllowShortFrames ( ) const
inline

◆ AllowShortFrames() [2/2]

void FrameAPI::RDS::Options::AllowShortFrames ( bool  Value)
inline

◆ CompressionLevel() [1/2]

Options::compression_level_type FrameAPI::RDS::Options::CompressionLevel ( ) const
inline

◆ CompressionLevel() [2/2]

void FrameAPI::RDS::Options::CompressionLevel ( compression_level_type  Value)
inline

◆ CompressionMethod() [1/2]

Options::compression_method_type FrameAPI::RDS::Options::CompressionMethod ( ) const
inline

◆ CompressionMethod() [2/2]

void FrameAPI::RDS::Options::CompressionMethod ( const std::string &  Value)

◆ CreateChecksumPerFrame() [1/2]

bool FrameAPI::RDS::Options::CreateChecksumPerFrame ( ) const
inline

◆ CreateChecksumPerFrame() [2/2]

void FrameAPI::RDS::Options::CreateChecksumPerFrame ( bool  Value)
inline

◆ FillMissingDataValidArray() [1/2]

bool FrameAPI::RDS::Options::FillMissingDataValidArray ( ) const
inline

◆ FillMissingDataValidArray() [2/2]

void FrameAPI::RDS::Options::FillMissingDataValidArray ( bool  Value)
inline

◆ FramesPerFile() [1/2]

Options::frames_per_file_type FrameAPI::RDS::Options::FramesPerFile ( ) const
inline

◆ FramesPerFile() [2/2]

void FrameAPI::RDS::Options::FramesPerFile ( frames_per_file_type  FPF)
inline

◆ GenerateFrameChecksum() [1/2]

bool FrameAPI::RDS::Options::GenerateFrameChecksum ( ) const
inline

◆ GenerateFrameChecksum() [2/2]

void FrameAPI::RDS::Options::GenerateFrameChecksum ( bool  Value)
inline

◆ HistoryRecord() [1/2]

bool FrameAPI::RDS::Options::HistoryRecord ( ) const
inline

◆ HistoryRecord() [2/2]

void FrameAPI::RDS::Options::HistoryRecord ( bool  Value)
inline

◆ OutputTimeEnd() [1/2]

Options::end_type FrameAPI::RDS::Options::OutputTimeEnd ( ) const
inline

◆ OutputTimeEnd() [2/2]

void FrameAPI::RDS::Options::OutputTimeEnd ( end_type  Value)
inline

◆ OutputTimeStart() [1/2]

Options::start_type FrameAPI::RDS::Options::OutputTimeStart ( ) const
inline

◆ OutputTimeStart() [2/2]

void FrameAPI::RDS::Options::OutputTimeStart ( start_type  Value)
inline

◆ OutputType() [1/2]

const std::string & FrameAPI::RDS::Options::OutputType ( ) const
inline

◆ OutputType() [2/2]

void FrameAPI::RDS::Options::OutputType ( const std::string &  Value)
inline

◆ Padding() [1/2]

Options::padding_type FrameAPI::RDS::Options::Padding ( ) const
inline

◆ Padding() [2/2]

void FrameAPI::RDS::Options::Padding ( padding_type  Value)
inline

◆ RDSLevel() [1/2]

Options::rds_level_type FrameAPI::RDS::Options::RDSLevel ( ) const
inline

◆ RDSLevel() [2/2]

void FrameAPI::RDS::Options::RDSLevel ( rds_level_type  Level)
inline

◆ SecondsPerFrame() [1/2]

Options::seconds_per_frame_type FrameAPI::RDS::Options::SecondsPerFrame ( ) const
inline

◆ SecondsPerFrame() [2/2]

void FrameAPI::RDS::Options::SecondsPerFrame ( seconds_per_frame_type  SPF)
inline

◆ VerifyChecksum()

bool FrameAPI::RDS::Options::VerifyChecksum ( ) const
inline

◆ VerifyChecksumOfFrame()

bool FrameAPI::RDS::Options::VerifyChecksumOfFrame ( ) const
inline

◆ VerifyChecksumOfStream() [1/2]

bool FrameAPI::RDS::Options::VerifyChecksumOfStream ( ) const
inline

◆ VerifyChecksumOfStream() [2/2]

void FrameAPI::RDS::Options::VerifyChecksumOfStream ( bool  Value)
inline

◆ VerifyChecksumPerFrame() [1/2]

bool FrameAPI::RDS::Options::VerifyChecksumPerFrame ( ) const
inline

◆ VerifyChecksumPerFrame() [2/2]

void FrameAPI::RDS::Options::VerifyChecksumPerFrame ( bool  Value)
inline

◆ VerifyDataValid() [1/2]

bool FrameAPI::RDS::Options::VerifyDataValid ( ) const
inline

◆ VerifyDataValid() [2/2]

void FrameAPI::RDS::Options::VerifyDataValid ( bool  Value)
inline

◆ VerifyFilenameMetadata() [1/2]

bool FrameAPI::RDS::Options::VerifyFilenameMetadata ( ) const
inline

◆ VerifyFilenameMetadata() [2/2]

void FrameAPI::RDS::Options::VerifyFilenameMetadata ( bool  Value)
inline

◆ VerifyTimeRange() [1/2]

bool FrameAPI::RDS::Options::VerifyTimeRange ( ) const
inline

◆ VerifyTimeRange() [2/2]

void FrameAPI::RDS::Options::VerifyTimeRange ( bool  Value)
inline

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