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

Classes

struct  FileLocation
 A file location struct that contains the storage service and partition where a file is located. More...
 

Public Member Functions

 SimulationTimestampFileCopy (WorkflowFile *file, StorageService *src, std::string src_partition, StorageService *dst, std::string dst_partition, SimulationTimestampFileCopyStart *start_timestamp=nullptr)
 Constructor. More...
 
FileLocation getDestination ()
 retrieves the location where the WorkflowFile will be copied More...
 
SimulationTimestampFileCopygetEndpoint () override
 retrieves the corresponding SimulationTimestampFileCopy object More...
 
WorkflowFilegetFile ()
 retrieves the WorkflowFile being copied More...
 
FileLocation getSource ()
 retrieves the location from which the WorkflowFile is being copied More...
 
- Public Member Functions inherited from wrench::SimulationTimestampPair
 SimulationTimestampPair ()
 Constructor.
 
 SimulationTimestampPair (SimulationTimestampPair *endpoint)
 Constructor. More...
 
- Public Member Functions inherited from wrench::SimulationTimestampType
double getDate ()
 Retrieve the date recorded for this timestamp. More...
 

Protected Attributes

FileLocation destination
 The intended location where the WorkflowFile was being copied to.
 
WorkflowFilefile
 
FileLocation source
 The location where the WorkflowFile was being copied from.
 
- Protected Attributes inherited from wrench::SimulationTimestampPair
SimulationTimestampPairendpoint = nullptr
 

Detailed Description

A base class for simulation timestamps regarding file copies.

Constructor & Destructor Documentation

◆ SimulationTimestampFileCopy()

wrench::SimulationTimestampFileCopy::SimulationTimestampFileCopy ( WorkflowFile file,
StorageService src,
std::string  src_partition,
StorageService dst,
std::string  dst_partition,
SimulationTimestampFileCopyStart start_timestamp = nullptr 
)

Constructor.

Parameters
filethe WorkflowFile associated with this file copy
srcthe source StorageService from which this file is being copied
src_partitionthe partition in the source StorageService from which this file is being copied
dstthe destination StorageService where this file will be copied
dst_partitionthe partition in the destination StorageService where this file will be copied

Member Function Documentation

◆ getDestination()

SimulationTimestampFileCopy::FileLocation wrench::SimulationTimestampFileCopy::getDestination ( )

retrieves the location where the WorkflowFile will be copied

Returns
a FileLocation object containing the destination StorageService and destination partition into which the file is being copied

◆ getEndpoint()

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

retrieves the corresponding SimulationTimestampFileCopy object

Returns
a pointer to the start or end SimulationTimestampFileCopy object

Reimplemented from wrench::SimulationTimestampPair.

◆ getFile()

WorkflowFile * wrench::SimulationTimestampFileCopy::getFile ( )

retrieves the WorkflowFile being copied

Returns
a pointer to the WorkflowFile associated with this copy

◆ getSource()

SimulationTimestampFileCopy::FileLocation wrench::SimulationTimestampFileCopy::getSource ( )

retrieves the location from which the WorkflowFile is being copied

Returns
a FileLocation object containing the source StorageService and source partition from which the file is being copied

The documentation for this class was generated from the following files:
  • /Users/rafsilva/Documents/isi/workspace/wrench/wrench/include/wrench/simulation/SimulationTimestampTypes.h
  • /Users/rafsilva/Documents/isi/workspace/wrench/wrench/src/wrench/simulation/SimulationTimestampTypes.cpp