Class ostk::physics::Manager

class Manager

OSTk manager base class (thread-safe)

The base manager defines methods for tracking and checking the manifest file.

Subclassed by ostk::physics::coordinate::frame::provider::iers::Manager, ostk::physics::data::Manager, ostk::physics::environment::atmospheric::earth::Manager, ostk::physics::environment::ephemeris::spice::Manager, ostk::physics::environment::gravitational::earth::Manager, ostk::physics::environment::magnetic::earth::Manager

Public Types

enum class Mode

Values:

enumerator Manual

Manually load and unload bulletins.

enumerator Automatic

Automatically fetch, load and unload bulletins (from remote repositories)

Public Functions

Manager(const Manager &aManager) = delete

Copy constructor (deleted)

Manager &operator=(const Manager &aManager) = delete

Copy assignment operator (deleted)

Manager(Manager&&) = delete

move constructor (deleted)

Manager &operator=(Manager&&) = delete

move assignment operator (deleted)

virtual ~Manager() = default

Destructor.

Manager::Mode getMode() const

Get manager mode.

Manager::Mode mode = manager.getMode();

Returns:

Manager mode

Directory getLocalRepository() const

Get local repository.

Directory localRepository = manager.getLocalRepository();

Returns:

Local repository

Duration getLocalRepositoryLockTimeout() const

Get local repository timeout, the maximum time to lock the local repository.

Duration timeout = manager.getLocalRepositoryLockTimeout();

Returns:

Local repository timeout

void setMode(const Manager::Mode &aMode)

Set manager mode.

manager.setMode(Manager::Mode::Automatic);

Parameters:

aMode -- [in] A manager mode

void setLocalRepository(const Directory &aDirectory)

Set local repository.

manager.setLocalRepository(Directory::Path(Path::Parse("/path/to/repo")));

Parameters:

aDirectory -- [in] A repository directory

virtual void reset()

Reset the manager to it's default state.

manager.reset();

void clearLocalRepository()

Clear local repository, removing all files.

manager.clearLocalRepository();