F´ Flight Software - C/C++ Documentation  NASA-v1.5.0
A framework for building embedded system applications to NASA flight quality standards.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Os::ValidatedFile Class Reference

A validated file. More...

#include <Os/ValidatedFile.hpp>

Public Member Functions

 ValidatedFile (const char *const fileName)
 Construct a validated file. More...
 
Os::ValidateFile::Status validate (void)
 
Os::ValidateFile::Status createHashFile (void)
 
const Fw::EightyCharStringgetFileName (void) const
 
const Fw::EightyCharStringgetHashFileName (void) const
 
const Utils::HashBuffergetHashBuffer (void) const
 

Public Attributes

PRIVATE __pad0__: Fw::EightyCharString fileName
 
Fw::EightyCharString hashFileName
 The hash file name. More...
 
Utils::HashBuffer hashBuffer
 The hash value after creating or loading a validation file. More...
 

Detailed Description

A validated file.

Definition at line 23 of file ValidatedFile.hpp.

Constructor & Destructor Documentation

◆ ValidatedFile()

Os::ValidatedFile::ValidatedFile ( const char *const  fileName)

Construct a validated file.

Parameters
fileNameThe file name

Definition at line 18 of file ValidatedFile.cpp.

Member Function Documentation

◆ createHashFile()

Os::ValidateFile::Status Os::ValidatedFile::createHashFile ( void  )

Create the hash file

Returns
Status

Definition at line 39 of file ValidatedFile.cpp.

◆ getFileName()

const Fw::EightyCharString & Os::ValidatedFile::getFileName ( void  ) const

Get the file name

Returns
The file name

Definition at line 51 of file ValidatedFile.cpp.

◆ getHashBuffer()

const Utils::HashBuffer & Os::ValidatedFile::getHashBuffer ( void  ) const

Get the hash file buffer

Returns
The hash file buffer

Definition at line 63 of file ValidatedFile.cpp.

◆ getHashFileName()

const Fw::EightyCharString & Os::ValidatedFile::getHashFileName ( void  ) const

Get the hash file name

Returns
The hash file name

Definition at line 57 of file ValidatedFile.cpp.

◆ validate()

Os::ValidateFile::Status Os::ValidatedFile::validate ( void  )

Validate the file

Returns
Status

Definition at line 27 of file ValidatedFile.cpp.

Member Data Documentation

◆ __pad0__

PRIVATE Os::ValidatedFile::__pad0__

Definition at line 56 of file ValidatedFile.hpp.

◆ hashBuffer

Utils::HashBuffer Os::ValidatedFile::hashBuffer

The hash value after creating or loading a validation file.

Definition at line 65 of file ValidatedFile.hpp.

◆ hashFileName

Fw::EightyCharString Os::ValidatedFile::hashFileName

The hash file name.

Definition at line 62 of file ValidatedFile.hpp.


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