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
ValidatedFile.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title ValidatedFile.hpp
3 // \author bocchino
4 // \brief An fprime validated file
5 //
6 // \copyright
7 // Copyright (C) 2017 California Institute of Technology.
8 // ALL RIGHTS RESERVED. United States Government Sponsorship
9 // acknowledged.
10 //
11 // ======================================================================
12 
13 #ifndef OS_ValidatedFile_HPP
14 #define OS_ValidatedFile_HPP
15 
17 #include "Fw/Types/BasicTypes.hpp"
18 #include "Os/ValidateFile.hpp"
19 
20 namespace Os {
21 
23  class ValidatedFile {
24 
25  public:
26 
29  const char* const fileName
30  );
31 
32  public:
33 
37 
41 
42  public:
43 
46  const Fw::EightyCharString& getFileName(void) const;
47 
50  const Fw::EightyCharString& getHashFileName(void) const;
51 
54  const Utils::HashBuffer& getHashBuffer(void) const;
55 
57 
59  Fw::EightyCharString fileName;
60 
63 
66  };
67 
68 };
69 
70 #endif
Os
Definition: File.cpp:7
Os::ValidatedFile::validate
Os::ValidateFile::Status validate(void)
Definition: ValidatedFile.cpp:28
PRIVATE
#define PRIVATE
overridable private for unit testing
Definition: BasicTypes.hpp:118
Os::ValidatedFile::getHashFileName
const Fw::EightyCharString & getHashFileName(void) const
Definition: ValidatedFile.cpp:58
Os::ValidatedFile::createHashFile
Os::ValidateFile::Status createHashFile(void)
Definition: ValidatedFile.cpp:40
Os::ValidateFile::Status
Status
Definition: ValidateFile.hpp:27
Fw::EightyCharString
Definition: EightyCharString.hpp:10
Os::ValidatedFile::hashFileName
Fw::EightyCharString hashFileName
The hash file name.
Definition: ValidatedFile.hpp:62
ValidateFile.hpp
Defines a file class to validate files or generate a file validator file.
Utils::HashBuffer
An container class for holding a hash buffer.
Definition: HashBuffer.hpp:26
EightyCharString.hpp
Os::ValidatedFile::getFileName
const Fw::EightyCharString & getFileName(void) const
Definition: ValidatedFile.cpp:52
Os::ValidatedFile::hashBuffer
Utils::HashBuffer hashBuffer
The hash value after creating or loading a validation file.
Definition: ValidatedFile.hpp:65
Os::ValidatedFile
A validated file.
Definition: ValidatedFile.hpp:23
Os::ValidatedFile::ValidatedFile
ValidatedFile(const char *const fileName)
Construct a validated file.
Definition: ValidatedFile.cpp:19
BasicTypes.hpp
Declares ISF basic types.
Os::ValidatedFile::getHashBuffer
const Utils::HashBuffer & getHashBuffer(void) const
Definition: ValidatedFile.cpp:64