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

A class that implements a file read action. More...

#include <FileReadAction.h>

Inheritance diagram for wrench::FileReadAction:
wrench::Action

Public Member Functions

std::shared_ptr< DataFilegetFile () const
 Returns the action's file. More...
 
std::vector< std::shared_ptr< FileLocation > > getFileLocations () const
 Returns the action's file locations. More...
 
std::shared_ptr< FileLocation > getUsedFileLocation () const
 Return the file location used by the action (or nullptr if action has not started, failed, etc.) More...
 
bool usesScratch () const override
 Determine whether the action uses scratch. More...
 
- Public Member Functions inherited from wrench::Action
std::set< std::shared_ptr< Action > > getChildren ()
 Get the action's children. More...
 
double getEndDate () const
 Returns this action's end date (-1.0 if not ended) More...
 
std::stack< Action::ActionExecution > & getExecutionHistory ()
 Retrieve the execution history. More...
 
std::shared_ptr< FailureCause > getFailureCause () const
 Returns the action's failure cause. More...
 
std::shared_ptr< CompoundJob > getJob () const
 Returns the job this action belongs to. More...
 
virtual unsigned long getMaxNumCores () const
 Get the maximum number of cores that can be used to execute the action. More...
 
virtual unsigned long getMinNumCores () const
 Get the minimum number of cores required to execute the action. More...
 
virtual double getMinRAMFootprint () const
 Get the minimum required amount of RAM to execute the action. More...
 
const std::string & getName () const
 Returns the action's name. More...
 
std::set< std::shared_ptr< Action > > getParents ()
 Get the action's parents. More...
 
double getPriority () const
 Get the action's priority. More...
 
std::shared_ptr< ActiongetSharedPtr ()
 Get the shared pointer for this object. More...
 
double getStartDate () const
 Returns ths action's started date (-1.0 if not started) More...
 
Action::State getState () const
 Returns the action's state. More...
 
std::string getStateAsString () const
 Returns the action's state as a human-readable string. More...
 
void setPriority (double priority)
 Set the action's priority. More...
 
void setSimulateComputationAsSleep (bool simulate_computation_as_sleep)
 Set whether simulation should be simulated as sleep (default = false) More...
 
void setThreadCreationOverhead (double overhead_in_seconds)
 Set the thread creation overhead (default = zero) More...
 

Protected Member Functions

 FileReadAction (const std::string &name, std::shared_ptr< CompoundJob > job, std::shared_ptr< DataFile >file, std::vector< std::shared_ptr< FileLocation >> file_locations)
 Constructor. More...
 
void execute (std::shared_ptr< ActionExecutor > action_executor) override
 Method to execute the action. More...
 
void terminate (std::shared_ptr< ActionExecutor > action_executor) override
 Method called when the action terminates. More...
 
- Protected Member Functions inherited from wrench::Action
 Action (const std::string &name, const std::string &prefix, std::shared_ptr< CompoundJob > job)
 Constructor. More...
 
void newExecution (Action::State state)
 Create a new execution data structure (e.g., after a restart) More...
 
void setEndDate (double date)
 Sets the action's end date. More...
 
void setExecutionHost (std::string host)
 Sets the action's execution hosts (and the action's physical execution host) More...
 
void setFailureCause (std::shared_ptr< FailureCause > failure_cause)
 Sets the action's failure cause. More...
 
void setNumCoresAllocated (unsigned long num_cores)
 Sets the action's allocated number of cores. More...
 
void setRAMAllocated (double ram)
 Sets the action's allocated RAM. More...
 
void setStartDate (double date)
 Sets the action's start date. More...
 
void setState (Action::State new_state)
 Sets the action's state to a new value. More...
 
void updateState ()
 Update the action's state.
 

Additional Inherited Members

- Public Types inherited from wrench::Action
enum  State {
  NOT_READY, READY, STARTED, COMPLETED,
  KILLED, FAILED
}
 Action states. More...
 
- Static Public Member Functions inherited from wrench::Action
static std::string getActionTypeAsString (const std::shared_ptr< Action > &action)
 Returns an action's type as a human-readable string. More...
 
static std::string stateToString (Action::State state)
 Convert an action state to a human-readable string. More...
 
- Protected Attributes inherited from wrench::Action
bool simulate_computation_as_sleep
 Whether to simulate the computation as sleep.
 
double thread_creation_overhead
 The thread creation overhead in seconds.
 

Detailed Description

A class that implements a file read action.

Constructor & Destructor Documentation

◆ FileReadAction()

wrench::FileReadAction::FileReadAction ( const std::string &  name,
std::shared_ptr< CompoundJob >  job,
std::shared_ptr< DataFile file,
std::vector< std::shared_ptr< FileLocation >>  file_locations 
)
protected

Constructor.

Parameters
namethe action's name (if empty, a unique name will be picked for you)
jobthe job this action belongs to
filethe file
file_locationsthe locations to read the file from (will be tried in order until one succeeds)

Member Function Documentation

◆ execute()

void wrench::FileReadAction::execute ( std::shared_ptr< ActionExecutor >  action_executor)
overrideprotectedvirtual

Method to execute the action.

Parameters
action_executorthe executor that executes this action

Implements wrench::Action.

◆ getFile()

std::shared_ptr< DataFile > wrench::FileReadAction::getFile ( ) const

Returns the action's file.

Returns
the file

◆ getFileLocations()

std::vector< std::shared_ptr< FileLocation > > wrench::FileReadAction::getFileLocations ( ) const

Returns the action's file locations.

Returns
A vector of file locations

◆ getUsedFileLocation()

std::shared_ptr< FileLocation > wrench::FileReadAction::getUsedFileLocation ( ) const

Return the file location used by the action (or nullptr if action has not started, failed, etc.)

Returns
A storage service

◆ terminate()

void wrench::FileReadAction::terminate ( std::shared_ptr< ActionExecutor >  action_executor)
overrideprotectedvirtual

Method called when the action terminates.

Parameters
action_executorthe executor that executes this action

Implements wrench::Action.

◆ usesScratch()

bool wrench::FileReadAction::usesScratch ( ) const
overridevirtual

Determine whether the action uses scratch.

Returns
true if the action uses scratch, false otherwise

Reimplemented from wrench::Action.


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