WRENCH  1.11
Cyberinfrastructure Simulation Workbench
Overview Installation Getting Started WRENCH 101 WRENCH 102
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
wrench::SimulationTimestampFileCopy Class Reference

A base class for simulation timestamps regarding file copies. More...

#include <SimulationTimestampTypes.h>

Inheritance diagram for wrench::SimulationTimestampFileCopy:
wrench::SimulationTimestampPair wrench::SimulationTimestampType wrench::SimulationTimestampFileCopyCompletion wrench::SimulationTimestampFileCopyFailure wrench::SimulationTimestampFileCopyStart

Public Member Functions

std::shared_ptr< FileLocationgetDestination ()
 retrieves the location where the DataFile will be copied More...
 
SimulationTimestampFileCopygetEndpoint () override
 Retrieve the matching endpoint, if any. More...
 
std::shared_ptr< DataFilegetFile ()
 retrieves the DataFile being copied More...
 
std::shared_ptr< FileLocationgetSource ()
 retrieves the location from which the DataFile is being copied More...
 
- Public Member Functions inherited from wrench::SimulationTimestampType
 SimulationTimestampType ()
 
More...
 
double getDate ()
 Retrieve the date recorded for this timestamp. More...
 

Protected Member Functions

 SimulationTimestampFileCopy (double date, std::shared_ptr< DataFile > file, std::shared_ptr< FileLocation > src, std::shared_ptr< FileLocation > dst)
 Constructor. More...
 
void setEndpoints ()
 Sets the endpoint of the calling object (SimulationTimestampFileCopyFailure, SimulationTimestampFileCopyCompletion, SimulationTimestampFileCopyStart) with a SimulationTimestampFileCopyStart object.
 

Protected Attributes

std::shared_ptr< FileLocationdestination
 The location where the DataFile was being copied to.
 
std::shared_ptr< DataFilefile
 The DataFile that was being copied.
 
std::shared_ptr< FileLocationsource
 The location where the DataFile was being copied from.
 
- Protected Attributes inherited from wrench::SimulationTimestampPair
SimulationTimestampPairendpoint = nullptr
 An optional associated "endpoint" simulation timestamp.
 
- Protected Attributes inherited from wrench::SimulationTimestampType
double date = -0.1
 Date.
 

Static Protected Attributes

static std::unordered_multimap< FileCopy, SimulationTimestampFileCopy * > pending_file_copies
 the data structure that holds the ongoing file writes. More...
 

Detailed Description

A base class for simulation timestamps regarding file copies.

Constructor & Destructor Documentation

◆ SimulationTimestampFileCopy()

wrench::SimulationTimestampFileCopy::SimulationTimestampFileCopy ( double  date,
std::shared_ptr< DataFile file,
std::shared_ptr< FileLocation src_location,
std::shared_ptr< FileLocation dst_location 
)
protected

Constructor.

Parameters
datethe date
filethe DataFile associated with this file copy
src_locationthe source location
dst_locationthe destination location

Member Function Documentation

◆ getDestination()

std::shared_ptr< FileLocation > wrench::SimulationTimestampFileCopy::getDestination ( )

retrieves the location where the DataFile will be copied

Returns
the copy's destination location

◆ getEndpoint()

SimulationTimestampFileCopy * wrench::SimulationTimestampFileCopy::getEndpoint ( )
overridevirtual

Retrieve the matching endpoint, if any.

retrieves the corresponding SimulationTimestampFileCopy object

Returns
a pointer to the start or end SimulationTimestampFileCopy object

Reimplemented from wrench::SimulationTimestampPair.

◆ getFile()

std::shared_ptr< DataFile > wrench::SimulationTimestampFileCopy::getFile ( )

retrieves the DataFile being copied

Returns
a pointer to the DataFile associated with this copy

◆ getSource()

std::shared_ptr< FileLocation > wrench::SimulationTimestampFileCopy::getSource ( )

retrieves the location from which the DataFile is being copied

Returns
the copy's source location

Member Data Documentation

◆ pending_file_copies

std::unordered_multimap< FileCopy, SimulationTimestampFileCopy * > wrench::SimulationTimestampFileCopy::pending_file_copies
staticprotected

the data structure that holds the ongoing file writes.

A static unordered multimap of SimulationTimestampFileCopyStart objects that have yet to be matched with Failure, Terminated or Completion timestamps.


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