BmnRoot 26.10.0-18-g4e3414f9
Software framework of the BM@N experiment
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.

Private Member Functions

 ArchiveDescriptor ()
template<class Archive>
void serialize (Archive &ar, const unsigned int version)
 ArchiveDescriptor ()
template<class Archive>
void serialize (Archive &ar, const unsigned int version)

Private Attributes

ArchiveType archive_type_
std::time_t time_created_ = std::time_t()
std::string hostname_
std::string username_

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

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

Definition at line 33 of file ArchiveDescriptor.h.

Constructor & Destructor Documentation

◆ ArchiveDescriptor() [1/4]

fles::ArchiveDescriptor::ArchiveDescriptor ( ArchiveType archive_type)
inlineexplicit
Parameters
archive_typeThe type of archive (e.g., timeslice, microslice).

Definition at line 41 of file ArchiveDescriptor.h.

References archive_type(), archive_type_, fles::system::current_hostname(), fles::system::current_username(), hostname_, time_created_, and username_.

Here is the call graph for this function:

◆ ArchiveDescriptor() [2/4]

fles::ArchiveDescriptor::ArchiveDescriptor ( )
inlineprivate

Definition at line 69 of file ArchiveDescriptor.h.

◆ ArchiveDescriptor() [3/4]

fles::ArchiveDescriptor::ArchiveDescriptor ( ArchiveType archive_type)
inlineexplicit
Parameters
archive_typeThe type of archive (e.g., timeslice, microslice).

Definition at line 41 of file ArchiveDescriptor.h.

References archive_type(), archive_type_, fles::system::current_hostname(), fles::system::current_username(), hostname_, time_created_, and username_.

Here is the call graph for this function:

◆ ArchiveDescriptor() [4/4]

fles::ArchiveDescriptor::ArchiveDescriptor ( )
inlineprivate

Definition at line 69 of file ArchiveDescriptor.h.

Member Function Documentation

◆ archive_type() [1/2]

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

Definition at line 50 of file ArchiveDescriptor.h.

References archive_type_.

Referenced by ArchiveDescriptor().

Here is the caller graph for this function:

◆ archive_type() [2/2]

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

Definition at line 50 of file ArchiveDescriptor.h.

References archive_type_.

◆ hostname() [1/2]

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

Definition at line 56 of file ArchiveDescriptor.h.

References hostname_.

◆ hostname() [2/2]

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

Definition at line 56 of file ArchiveDescriptor.h.

References hostname_.

◆ serialize() [1/2]

template<class Archive>
void fles::ArchiveDescriptor::serialize ( Archive & ar,
const unsigned int version )
inlineprivate

◆ serialize() [2/2]

template<class Archive>
void fles::ArchiveDescriptor::serialize ( Archive & ar,
const unsigned int version )
inlineprivate

◆ time_created() [1/2]

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

Definition at line 53 of file ArchiveDescriptor.h.

References time_created_.

◆ time_created() [2/2]

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

Definition at line 53 of file ArchiveDescriptor.h.

References time_created_.

◆ username() [1/2]

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

Definition at line 59 of file ArchiveDescriptor.h.

References username_.

◆ username() [2/2]

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

Definition at line 59 of file ArchiveDescriptor.h.

References username_.

◆ boost::serialization::access

boost::serialization::access
friend

Definition at line 62 of file ArchiveDescriptor.h.

References boost::serialization::access.

Referenced by boost::serialization::access.

◆ InputArchive [1/2]

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

Definition at line 65 of file ArchiveDescriptor.h.

References InputArchive.

Referenced by InputArchive.

◆ InputArchive [2/2]

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

Definition at line 65 of file ArchiveDescriptor.h.

References InputArchive.

◆ InputArchiveLoop [1/2]

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

Definition at line 67 of file ArchiveDescriptor.h.

References InputArchiveLoop.

Referenced by InputArchiveLoop.

◆ InputArchiveLoop [2/2]

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

Definition at line 67 of file ArchiveDescriptor.h.

References InputArchiveLoop.

Member Data Documentation

◆ archive_type_

ArchiveType fles::ArchiveDescriptor::archive_type_
private

Definition at line 84 of file ArchiveDescriptor.h.

Referenced by ArchiveDescriptor(), archive_type(), and serialize().

◆ hostname_

std::string fles::ArchiveDescriptor::hostname_
private

Definition at line 86 of file ArchiveDescriptor.h.

Referenced by ArchiveDescriptor(), hostname(), and serialize().

◆ time_created_

std::time_t fles::ArchiveDescriptor::time_created_ = std::time_t()
private

Definition at line 85 of file ArchiveDescriptor.h.

Referenced by ArchiveDescriptor(), serialize(), and time_created().

◆ username_

std::string fles::ArchiveDescriptor::username_
private

Definition at line 87 of file ArchiveDescriptor.h.

Referenced by ArchiveDescriptor(), serialize(), and username().


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