vg
tools for working with variation graphs
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
vg::IndexFile Class Reference

#include <index_registry.hpp>

Public Member Functions

 IndexFile (const IndexName &identifier, const string &suffix)
 Create a new IndexFile with a unique identifier.
 
const IndexNameget_identifier () const
 Get the globally unique identifier for this index.
 
const string & get_suffix () const
 Returns the suffix to be used for this index.
 
const vector< string > & get_filenames () const
 Get the filename(s) that contain this index.
 
void provide (const vector< string > &filenames)
 Identify a serialized file that already contains this index.
 
void assign_constructed (const vector< string > &filenames)
 Assign constructed filenames to this index.
 
bool is_finished () const
 Returns true if the index has already been built or provided.
 
bool was_provided_directly () const
 Returns true if the index was provided through provide method.
 
void reset ()
 Discard any constructed or provided indexes.
 

Private Attributes

IndexName identifier
 
const string suffix
 
vector< string > filenames
 
bool provided_directly = false
 

Detailed Description

An object that generically represents a serializable index or input file

Constructor & Destructor Documentation

◆ IndexFile()

vg::IndexFile::IndexFile ( const IndexName identifier,
const string &  suffix 
)

Create a new IndexFile with a unique identifier.

Member Function Documentation

◆ assign_constructed()

void vg::IndexFile::assign_constructed ( const vector< string > &  filenames)

Assign constructed filenames to this index.

◆ get_filenames()

const vector< string > & vg::IndexFile::get_filenames ( ) const

Get the filename(s) that contain this index.

◆ get_identifier()

const IndexName & vg::IndexFile::get_identifier ( ) const

Get the globally unique identifier for this index.

◆ get_suffix()

const string & vg::IndexFile::get_suffix ( ) const

Returns the suffix to be used for this index.

◆ is_finished()

bool vg::IndexFile::is_finished ( ) const

Returns true if the index has already been built or provided.

◆ provide()

void vg::IndexFile::provide ( const vector< string > &  filenames)

Identify a serialized file that already contains this index.

◆ reset()

void vg::IndexFile::reset ( )

Discard any constructed or provided indexes.

◆ was_provided_directly()

bool vg::IndexFile::was_provided_directly ( ) const

Returns true if the index was provided through provide method.

Member Data Documentation

◆ filenames

vector<string> vg::IndexFile::filenames
private

◆ identifier

IndexName vg::IndexFile::identifier
private

◆ provided_directly

bool vg::IndexFile::provided_directly = false
private

◆ suffix

const string vg::IndexFile::suffix
private

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