BusBoy  2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
BUSBOY::AlgorithmData Class Reference

Root object for access to all data used by an executing algorithm. More...

#include <AlgorithmData.h>

Public Member Functions

 AlgorithmData ()
 
void setKeyspace (const Keyspace &keyspace)
 
const KeyspacegetKeyspace () const
 Returns the keyspace containing all the elements found in the input datasets. More...
 
void generateKeyspaceFromInputDatasets ()
 This will overwrite the keyspace this object was created with. More...
 
void setConfig (const AlgorithmConfig &config)
 
const AlgorithmConfiggetConfig () const
 Returns per-run configuration parameters. More...
 
void addInputDataset (const std::string &name, Dataset *dataset)
 
void addOutputDataset (const std::string &name, Dataset *dataset)
 
DatasetgetInputDataset (const std::string &name) const
 
bool hasInputDataset (const std::string &name) const
 
DatasetgetOutputDataset (const std::string &name) const
 
bool hasOutputDataset (const std::string &name) const
 
std::set< std::string > getInputDatasetNames () const
 
std::set< std::string > getOutputDatasetNames () const
 
bool operator== (const AlgorithmData &algoData) const
 
bool operator!= (const AlgorithmData &algoData) const
 
 ~AlgorithmData ()
 

Detailed Description

Root object for access to all data used by an executing algorithm.

NOTE: the methods to add datasets are for use by the framework only

Constructor & Destructor Documentation

BUSBOY::AlgorithmData::AlgorithmData ( )
BUSBOY::AlgorithmData::~AlgorithmData ( )

Member Function Documentation

void BUSBOY::AlgorithmData::addInputDataset ( const std::string &  name,
Dataset dataset 
)
void BUSBOY::AlgorithmData::addOutputDataset ( const std::string &  name,
Dataset dataset 
)
void BUSBOY::AlgorithmData::generateKeyspaceFromInputDatasets ( )

This will overwrite the keyspace this object was created with.

const AlgorithmConfig & BUSBOY::AlgorithmData::getConfig ( ) const

Returns per-run configuration parameters.

Return value is a reference valid for the lifetime of this object.

Dataset * BUSBOY::AlgorithmData::getInputDataset ( const std::string &  name) const
std::set< std::string > BUSBOY::AlgorithmData::getInputDatasetNames ( ) const
const Keyspace & BUSBOY::AlgorithmData::getKeyspace ( ) const

Returns the keyspace containing all the elements found in the input datasets.

Return value is a reference valid for the lifetime of this object.

Dataset * BUSBOY::AlgorithmData::getOutputDataset ( const std::string &  name) const
std::set< std::string > BUSBOY::AlgorithmData::getOutputDatasetNames ( ) const
bool BUSBOY::AlgorithmData::hasInputDataset ( const std::string &  name) const
bool BUSBOY::AlgorithmData::hasOutputDataset ( const std::string &  name) const
bool BUSBOY::AlgorithmData::operator!= ( const AlgorithmData algoData) const
bool BUSBOY::AlgorithmData::operator== ( const AlgorithmData algoData) const
void BUSBOY::AlgorithmData::setConfig ( const AlgorithmConfig config)
void BUSBOY::AlgorithmData::setKeyspace ( const Keyspace keyspace)

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

Copyright 2014 Google Inc. All rights reserved.