NeoFOAM::finiteVolume::cellCentred::OldTimeCollection Class Reference

#include <oldTimeCollection.hpp>

Inheritance diagram for NeoFOAM::finiteVolume::cellCentred::OldTimeCollection:

Public Member Functions
	OldTimeCollection (Database &db, std::string name, std::string fieldCollectionName)
bool	contains (const std::string &id) const
bool	insert (const OldTimeDocument &cc)
std::string	findNextTime (std::string id) const
std::string	findPreviousTime (std::string id) const
OldTimeDocument &	oldTimeDoc (const std::string &id)
const OldTimeDocument &	oldTimeDoc (const std::string &id) const
template<typename FieldType >
FieldType &	getOrInsert (std::string idOfNextField)
template<typename FieldType >
const FieldType &	get (std::string idOfNextField) const
Public Member Functions inherited from NeoFOAM::CollectionMixin< OldTimeDocument >
	CollectionMixin (NeoFOAM::Database &db, std::string name)
	Constructs a CollectionMixin with the given database and collection name.
	CollectionMixin (const CollectionMixin &)=delete
	CollectionMixin (CollectionMixin &&)=default
CollectionMixin &	operator= (const CollectionMixin &)=delete
CollectionMixin &	operator= (CollectionMixin &&)=delete
Document &	doc (const std::string &id)
	Retrieves a document by its ID.
const Document &	doc (const std::string &id) const
	Retrieves a document by its ID (const version).
std::vector< std::string >	find (const std::function< bool(const Document &)> &predicate) const
	Finds documents that match a given predicate.
std::size_t	size () const
	Gets the number of documents in the collection.
const NeoFOAM::Database &	db () const
	Gets a const reference to the database.
NeoFOAM::Database &	db ()
	Gets a reference to the database.
const std::string &	name () const
	Gets the name of the collection.
std::string	type () const
	Gets the type name of the documents in the collection.
std::vector< std::string >	sortedKeys () const
	Gets the sorted keys of the documents in the collection.

Static Public Member Functions
static OldTimeCollection &	instance (Database &db, std::string name, std::string fieldCollectionName)
static const OldTimeCollection &	instance (const Database &db, std::string name)
static OldTimeCollection &	instance (FieldCollection &fieldCollection)
static const OldTimeCollection &	instance (const FieldCollection &fieldCollection)

Additional Inherited Members
Protected Attributes inherited from NeoFOAM::CollectionMixin< OldTimeDocument >
std::unordered_map< std::string, OldTimeDocument >	docs_
	The map of document IDs to documents.
NeoFOAM::Database &	db_
	The reference to the database.
std::string	name_
	The name of the collection.

Detailed Description

Definition at line 56 of file oldTimeCollection.hpp.

Constructor & Destructor Documentation

OldTimeCollection()

NeoFOAM::finiteVolume::cellCentred::OldTimeCollection::OldTimeCollection	(	Database &	db,
		std::string	name,
		std::string	fieldCollectionName
	)

Member Function Documentation

contains()

bool NeoFOAM::finiteVolume::cellCentred::OldTimeCollection::contains

(

const std::string &

id

)

const

findNextTime()

std::string NeoFOAM::finiteVolume::cellCentred::OldTimeCollection::findNextTime

(

std::string

id

)

const

findPreviousTime()

std::string NeoFOAM::finiteVolume::cellCentred::OldTimeCollection::findPreviousTime

(

std::string

id

)

const

get()

template<typename FieldType >

const FieldType & NeoFOAM::finiteVolume::cellCentred::OldTimeCollection::get ( std::string  idOfNextField ) const

inline

Definition at line 103 of file oldTimeCollection.hpp.

getOrInsert()

template<typename FieldType >

FieldType & NeoFOAM::finiteVolume::cellCentred::OldTimeCollection::getOrInsert ( std::string  idOfNextField )

inline

Definition at line 75 of file oldTimeCollection.hpp.

insert()

bool NeoFOAM::finiteVolume::cellCentred::OldTimeCollection::insert

(

const OldTimeDocument &

cc

)

instance() [1/4]

static const OldTimeCollection & NeoFOAM::finiteVolume::cellCentred::OldTimeCollection::instance ( const Database &  db, std::string  name  )

static

instance() [2/4]

static const OldTimeCollection & NeoFOAM::finiteVolume::cellCentred::OldTimeCollection::instance ( const FieldCollection &  fieldCollection )

static

instance() [3/4]

static OldTimeCollection & NeoFOAM::finiteVolume::cellCentred::OldTimeCollection::instance ( Database &  db, std::string  name, std::string  fieldCollectionName  )

static

instance() [4/4]

static OldTimeCollection & NeoFOAM::finiteVolume::cellCentred::OldTimeCollection::instance ( FieldCollection &  fieldCollection )

static

oldTimeDoc() [1/2]

OldTimeDocument & NeoFOAM::finiteVolume::cellCentred::OldTimeCollection::oldTimeDoc

(

const std::string &

id

)

oldTimeDoc() [2/2]

const OldTimeDocument & NeoFOAM::finiteVolume::cellCentred::OldTimeCollection::oldTimeDoc

(

const std::string &

id

)

const

---

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

• /home/runner/work/NeoFOAM/NeoFOAM/include/NeoFOAM/core/database/oldTimeCollection.hpp