BmnRoot
Loading...
Searching...
No Matches
fles::ArchiveDescriptor Class Reference

The ArchiveDescriptor class contains metadata on an archive. More...

#include <ArchiveDescriptor.h>

Public Member Functions

 ArchiveDescriptor (ArchiveType archive_type)
 Public constructor.
 
ArchiveType archive_type () const
 Retrieve the type of archive.
 
std::time_t time_created () const
 Retrieve the time of creation of the archive.
 
std::string hostname () const
 Retrieve the hostname of the machine creating the archive.
 
std::string username () const
 Retrieve the hostname of the machine creating the archive.
 
 ArchiveDescriptor (ArchiveType archive_type)
 Public constructor.
 
ArchiveType archive_type () const
 Retrieve the type of archive.
 
std::time_t time_created () const
 Retrieve the time of creation of the archive.
 
std::string hostname () const
 Retrieve the hostname of the machine creating the archive.
 
std::string username () const
 Retrieve the hostname of the machine creating the archive.
 

Friends

class boost::serialization::access
 
template<class Base , class Derived , ArchiveType archive_type>
class InputArchive
 Provide boost serialization access.
 
template<class Base , class Derived , ArchiveType archive_type>
class InputArchiveLoop
 
template<class Base , class Derived , ArchiveType archive_type>
class InputArchive
 Provide boost serialization access.
 
template<class Base , class Derived , ArchiveType archive_type>
class InputArchiveLoop
 

Detailed Description

The ArchiveDescriptor class contains metadata on an archive.

This class class precedes a stream of serialized StorableTimeslice or StorableMicroslice objects.

Definition at line 32 of file ArchiveDescriptor.h.

Constructor & Destructor Documentation

◆ ArchiveDescriptor() [1/2]

fles::ArchiveDescriptor::ArchiveDescriptor ( ArchiveType  archive_type)
inlineexplicit

Public constructor.

Parameters
archive_typeThe type of archive (e.g., timeslice, microslice).

Definition at line 40 of file ArchiveDescriptor.h.

References fles::system::current_hostname(), and fles::system::current_username().

◆ ArchiveDescriptor() [2/2]

fles::ArchiveDescriptor::ArchiveDescriptor ( ArchiveType  archive_type)
inlineexplicit

Public constructor.

Parameters
archive_typeThe type of archive (e.g., timeslice, microslice).

Definition at line 40 of file ArchiveDescriptor.h.

References fles::system::current_hostname(), and fles::system::current_username().

Member Function Documentation

◆ archive_type() [1/2]

ArchiveType fles::ArchiveDescriptor::archive_type ( ) const
inline

Retrieve the type of archive.

Definition at line 49 of file ArchiveDescriptor.h.

◆ archive_type() [2/2]

ArchiveType fles::ArchiveDescriptor::archive_type ( ) const
inline

Retrieve the type of archive.

Definition at line 49 of file ArchiveDescriptor.h.

◆ hostname() [1/2]

std::string fles::ArchiveDescriptor::hostname ( ) const
inline

Retrieve the hostname of the machine creating the archive.

Definition at line 55 of file ArchiveDescriptor.h.

◆ hostname() [2/2]

std::string fles::ArchiveDescriptor::hostname ( ) const
inline

Retrieve the hostname of the machine creating the archive.

Definition at line 55 of file ArchiveDescriptor.h.

◆ time_created() [1/2]

std::time_t fles::ArchiveDescriptor::time_created ( ) const
inline

Retrieve the time of creation of the archive.

Definition at line 52 of file ArchiveDescriptor.h.

◆ time_created() [2/2]

std::time_t fles::ArchiveDescriptor::time_created ( ) const
inline

Retrieve the time of creation of the archive.

Definition at line 52 of file ArchiveDescriptor.h.

◆ username() [1/2]

std::string fles::ArchiveDescriptor::username ( ) const
inline

Retrieve the hostname of the machine creating the archive.

Definition at line 58 of file ArchiveDescriptor.h.

◆ username() [2/2]

std::string fles::ArchiveDescriptor::username ( ) const
inline

Retrieve the hostname of the machine creating the archive.

Definition at line 58 of file ArchiveDescriptor.h.

Friends And Related Symbol Documentation

◆ boost::serialization::access

boost::serialization::access
friend

Definition at line 61 of file ArchiveDescriptor.h.

◆ InputArchive [1/2]

template<class Base , class Derived , ArchiveType archive_type>
friend class InputArchive
friend

Provide boost serialization access.

Definition at line 64 of file ArchiveDescriptor.h.

◆ InputArchive [2/2]

template<class Base , class Derived , ArchiveType archive_type>
class InputArchive
friend

Provide boost serialization access.

Definition at line 64 of file ArchiveDescriptor.h.

◆ InputArchiveLoop [1/2]

template<class Base , class Derived , ArchiveType archive_type>
friend class InputArchiveLoop
friend

Definition at line 66 of file ArchiveDescriptor.h.

◆ InputArchiveLoop [2/2]

template<class Base , class Derived , ArchiveType archive_type>
class InputArchiveLoop
friend

Definition at line 66 of file ArchiveDescriptor.h.


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