# PhasicFlow: repository Class Reference

repository Class Reference
Inheritance diagram for repository:
[legend]
Collaboration diagram for repository:
[legend]

## Public Member Functions

| TypeInfo ("repository")
| repository (const word &name, const fileSystem &localPath, repository *owner=nullptr)
| repository (const repository &)=delete
repository & | operator= (const repository &)=delete
virtual | ~repository ()
word | name () const
virtual fileSystem | localPath () const
virtual fileSystem | path () const
const repository * | owner () const
repository * | owner ()
const repository & | thisRepository () const
repository & | thisRepository ()
bool | addToRepository (repository *rep)
bool | removeRepository (repository *rep)
template<typename T , typename... Args>
T & | emplaceObject (const objectFile &objf, Args &&... args)
template<typename T , typename... Args>
T & | emplaceObjectOrGet (const objectFile &objf, Args &&... args)
template<typename T , typename... Args>
T & | emplaceReplaceObject (const objectFile &objf, Args &&... args)
template<typename T >
T & | insertReplaceObject (uniquePtr< IOobject > &&ptr)
template<typename T >
T & | insertReplaceObject (const objectFile &objf, uniquePtr< IOobject > &&ptr)
bool | eraseObject (const word &name)
bool | lookupObjectName (const word &nm) const
word | lookupObjectTypeName (const word &nm) const
bool | globalLookupObjectName (const word &nm, bool downward=false) const
bool | lookupRepositoryName (const word &nm) const
bool | lookupName (const word nm) const
size_t | numObjects () const
size_t | numRepositories () const
virtual size_t | outFilePrecision () const
template<typename T >
T & | lookupObject (const word &name)
repository & | lookupRepository (const word &name)
wordList | objectNames () const
wordList | repositoryNames () const
virtual bool | write (bool verbose=false) const
template<typename Type1 >
pFlow::word | reportTypeError (IOobject &object)

## Protected Member Functions

template<typename Type1 >
word | reportTypeError (IOobject &object)
template<typename Type >
bool | checkForObjectType (IOobject &object)

## Protected Attributes

word | name_
fileSystem | localPath_
repository * | owner_
wordMap< IOobject > | objects_
wordMap< repository * > | repositories_

## Detailed Description

Definition at line 34 of file repository.hpp.

## Constructor & Destructor Documentation

## repository() [1/2]

repository | ( | const word & | name,
|  | const fileSystem & | localPath,
|  | repository * | owner = `nullptr`
| ) |  |

Definition at line 26 of file repository.cpp.

References repository::addToRepository().

Here is the call graph for this function:

## repository() [2/2]

repository | ( | const repository & |  | ) |

delete

## ~repository()

~repository | ( |  | ) |

virtual

Definition at line 43 of file repository.cpp.

References repository::owner_, and repository::removeRepository().

Here is the call graph for this function:

## Member Function Documentation

## reportTypeError() [1/2]

word reportTypeError | ( | IOobject & | object | ) |

protected

## checkForObjectType()

bool checkForObjectType | ( | IOobject & | object | ) |

protected

Definition at line 32 of file repositoryTemplates.cpp.

## TypeInfo()

TypeInfo | ( | "repository" |  | ) |

## operator=()

repository& operator= | ( | const repository & |  | ) |

delete

## name()

pFlow::word name | ( |  | ) | const

Definition at line 51 of file repository.cpp.

Referenced by repository::addToRepository(), readFromTimeFolder::createUniformPointField_H(), repository::eraseObject(), readFromTimeFolder::readPointField_D(), readFromTimeFolder::readPointField_H(), repository::removeRepository(), repository::reportTypeError(), setFieldEntry::setPointFieldDefaultValueNew(), setFieldEntry::setPointFieldDefaultValueStdNew(), setFieldEntry::setPointFieldSelected(), and setFieldEntry::setPointFieldSelectedStd().

Here is the caller graph for this function:

## localPath()

pFlow::fileSystem localPath | ( |  | ) | const

virtual

Reimplemented in Time.

Definition at line 56 of file repository.cpp.

## path()

pFlow::fileSystem path | ( |  | ) | const

virtual

Definition at line 61 of file repository.cpp.

References fileSystem::path().

Referenced by interaction::create(), geometry::create(), readFromTimeFolder::path(), and geometry::path().

Here is the call graph for this function:
Here is the caller graph for this function:

## owner() [1/2]

pFlow::repository * owner | ( |  | ) | const

Definition at line 73 of file repository.cpp.

Referenced by repository::globalLookupObjectName().

Here is the caller graph for this function:

## owner() [2/2]

repository* owner | ( |  | ) |

## thisRepository() [1/2]

pFlow::repository & thisRepository | ( |  | ) | const

Definition at line 83 of file repository.cpp.

## thisRepository() [2/2]

repository& thisRepository | ( |  | ) |

## addToRepository()

bool addToRepository | ( | repository * | rep | ) |

Definition at line 93 of file repository.cpp.

References repository::name(), and warningInFunction.

Referenced by repository::repository().

Here is the call graph for this function:
Here is the caller graph for this function:

## removeRepository()

bool removeRepository | ( | repository * | rep | ) |

Definition at line 109 of file repository.cpp.

References repository::name().

Referenced by repository::~repository().

Here is the call graph for this function:
Here is the caller graph for this function:

## emplaceObject()

T & emplaceObject | ( | const objectFile & | objf,
|  | Args &&... | args
| ) |  |

Definition at line 38 of file repositoryTemplates.cpp.

References pFlow::endl(), fatalErrorInFunction, fatalExit, and objectFile::name().

Referenced by setFieldEntry::setPointFieldDefaultValueNew(), and setFieldEntry::setPointFieldDefaultValueStdNew().

Here is the call graph for this function:
Here is the caller graph for this function:

## emplaceObjectOrGet()

T & emplaceObjectOrGet | ( | const objectFile & | objf,
|  | Args &&... | args
| ) |  |

Definition at line 62 of file repositoryTemplates.cpp.

References fatalErrorInFunction, fatalExit, and objectFile::name().

Referenced by readFromTimeFolder::readPointField_D(), and readFromTimeFolder::readPointField_H().

Here is the call graph for this function:
Here is the caller graph for this function:

## emplaceReplaceObject()

T & emplaceReplaceObject | ( | const objectFile & | objf,
|  | Args &&... | args
| ) |  |

Definition at line 89 of file repositoryTemplates.cpp.

References objectFile::name().

Referenced by readFromTimeFolder::createUniformPointField_H().

Here is the call graph for this function:
Here is the caller graph for this function:

## insertReplaceObject() [1/2]

T & insertReplaceObject | ( | uniquePtr< IOobject > && | ptr | ) |

Definition at line 104 of file repositoryTemplates.cpp.

## insertReplaceObject() [2/2]

T & insertReplaceObject | ( | const objectFile & | objf,
|  | uniquePtr< IOobject > && | ptr
| ) |  |

Definition at line 125 of file repositoryTemplates.cpp.

References objectFile::name().

Here is the call graph for this function:

## eraseObject()

bool eraseObject | ( | const word & | name | ) |

inline

Definition at line 152 of file repository.hpp.

References repository::name(), and repository::objects_.

Here is the call graph for this function:

## lookupObjectName()

bool lookupObjectName | ( | const word & | nm | ) | const

Definition at line 117 of file repository.cpp.

Referenced by readFromTimeFolder::checkForPointStructure(), setFieldEntry::setPointFieldSelected(), and setFieldEntry::setPointFieldSelectedStd().

Here is the caller graph for this function:

## lookupObjectTypeName()

pFlow::word lookupObjectTypeName | ( | const word & | nm | ) | const

Definition at line 122 of file repository.cpp.

References pFlow::endl(), fatalErrorInFunction, and fatalExit.

Referenced by setFieldEntry::setPointFieldSelected(), and setFieldEntry::setPointFieldSelectedStd().

Here is the call graph for this function:
Here is the caller graph for this function:

## globalLookupObjectName()

bool globalLookupObjectName | ( | const word & | nm,
|  | bool | downward = `false`
| ) |  | const

Definition at line 140 of file repository.cpp.

References repository::globalLookupObjectName(), and repository::owner().

Referenced by repository::globalLookupObjectName().

Here is the call graph for this function:
Here is the caller graph for this function:

## lookupRepositoryName()

bool lookupRepositoryName | ( | const word & | nm | ) | const

Definition at line 178 of file repository.cpp.

## lookupName()

bool lookupName | ( | const word | nm | ) | const

Definition at line 183 of file repository.cpp.

## numObjects()

size_t numObjects | ( |  | ) | const

Definition at line 190 of file repository.cpp.

## numRepositories()

size_t numRepositories | ( |  | ) | const

Definition at line 195 of file repository.cpp.

## outFilePrecision()

virtual size_t outFilePrecision | ( |  | ) | const

inlinevirtual

Reimplemented in systemControl.

Definition at line 183 of file repository.hpp.

References repository::outFilePrecision(), and repository::owner_.

Referenced by repository::outFilePrecision().

Here is the call graph for this function:
Here is the caller graph for this function:

## lookupObject()

T & lookupObject | ( | const word & | name | ) |

Definition at line 146 of file repositoryTemplates.cpp.

References pFlow::endl(), fatalErrorInFunction, and fatalExit.

Referenced by readFromTimeFolder::createUniformPointField_H(), readFromTimeFolder::readPointField_D(), readFromTimeFolder::readPointField_H(), setFieldEntry::setPointFieldSelected(), and setFieldEntry::setPointFieldSelectedStd().

Here is the call graph for this function:
Here is the caller graph for this function:

## lookupRepository()

pFlow::repository & lookupRepository | ( | const word & | name | ) |

Definition at line 200 of file repository.cpp.

References pFlow::endl(), fatalErrorInFunction, and fatalExit.

Here is the call graph for this function:

## objectNames()

pFlow::wordList objectNames | ( |  | ) | const

Definition at line 217 of file repository.cpp.

## repositoryNames()

pFlow::wordList repositoryNames | ( |  | ) | const

Definition at line 227 of file repository.cpp.

## write()

bool write | ( | bool | verbose = `false` | ) | const

virtual

Reimplemented in Time.

Definition at line 239 of file repository.cpp.

References pFlow::endl(), endREPORT, fatalErrorInFunction, and REPORT.

Referenced by Time::write(), and geometry::write().

Here is the call graph for this function:
Here is the caller graph for this function:

## reportTypeError() [2/2]

pFlow::word reportTypeError | ( | IOobject & | object | ) |

Definition at line 22 of file repositoryTemplates.cpp.

References repository::name().

Here is the call graph for this function:

## Member Data Documentation

## name_

word name_

protected

Definition at line 39 of file repository.hpp.

## localPath_

fileSystem localPath_

protected

Definition at line 42 of file repository.hpp.

## owner_

repository* owner_

protected

Definition at line 45 of file repository.hpp.

Referenced by repository::outFilePrecision(), and repository::~repository().

## objects_

wordMap<IOobject> objects_

protected

Definition at line 48 of file repository.hpp.

Referenced by repository::eraseObject().

## repositories_

wordMap<repository*> repositories_

protected

Definition at line 52 of file repository.hpp.

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

- src/phasicFlow/repository/repository/repository.hpp
- src/phasicFlow/repository/repository/repository.cpp
- src/phasicFlow/repository/repository/repositoryTemplates.cpp