OpenStudioCore:analysis
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | Public Attributes | Related Functions | List of all members
openstudio::analysis::WorkflowStepJob Struct Reference

#include <Problem.hpp>

Public Member Functions

boost::optional
< runmanager::JobErrors > 
errors () const
 Returns errors from job if not job->hasMergedJobs(). More...
 
boost::optional
< runmanager::Files > 
outputFiles () const
 Returns ouptputFiles from job if not job->hasMergedJobs(). More...
 
 WorkflowStepJob (const runmanager::Job &t_job, const WorkflowStep &t_step, boost::optional< unsigned > t_mergedJobIndex=boost::none)
 Constructor for bare runmanager::WorkItem. More...
 
 WorkflowStepJob (const WorkflowStep &t_step)
 Constructor for bare, null runmanager::WorkItem. More...
 
 WorkflowStepJob (const runmanager::Job &t_job, const WorkflowStep &t_step, const Measure &t_measure, boost::optional< unsigned > t_mergedJobIndex=boost::none)
 Constructor for non-null measure. More...
 
 WorkflowStepJob (const WorkflowStep &t_step, const Measure &t_measure)
 Constructor for null measure. More...
 
 WorkflowStepJob (const runmanager::Job &t_job, const WorkflowStep &t_step, const QVariant &t_value, boost::optional< unsigned > t_mergedJobIndex=boost::none)
 Constructor for explicitly set variable. More...
 
 WorkflowStepJob (const WorkflowStep &t_step, const QVariant &t_value)
 Constructor for explicitly set variable in preliminary part of compound measure. More...
 

Public Attributes

boost::optional< runmanager::Job > job
 
boost::optional< Measuremeasure
 
boost::optional< unsigned > mergedJobIndex
 
WorkflowStep step
 
boost::optional< QVariant > value
 

Related Functions

(Note that these are not member functions.)

typedef boost::optional
< WorkflowStepJob
OptionalWorkflowStepJob
 
typedef std::vector
< WorkflowStepJob
WorkflowStepJobVector
 

Detailed Description

WorkflowStepJob is a structure for articulating the detailed runtime results associated with each WorkflowStep as executed for a particular DataPoint.

WorkflowStepJobs are constructed by Problem, through the interpretation of DataPoint::topLevelJob in the context of the Problem::workflow.

Constructor & Destructor Documentation

openstudio::analysis::WorkflowStepJob::WorkflowStepJob ( const runmanager::Job &  t_job,
const WorkflowStep t_step,
boost::optional< unsigned >  t_mergedJobIndex = boost::none 
)

Constructor for bare runmanager::WorkItem.

openstudio::analysis::WorkflowStepJob::WorkflowStepJob ( const WorkflowStep t_step)

Constructor for bare, null runmanager::WorkItem.

openstudio::analysis::WorkflowStepJob::WorkflowStepJob ( const runmanager::Job &  t_job,
const WorkflowStep t_step,
const Measure t_measure,
boost::optional< unsigned >  t_mergedJobIndex = boost::none 
)

Constructor for non-null measure.

openstudio::analysis::WorkflowStepJob::WorkflowStepJob ( const WorkflowStep t_step,
const Measure t_measure 
)

Constructor for null measure.

openstudio::analysis::WorkflowStepJob::WorkflowStepJob ( const runmanager::Job &  t_job,
const WorkflowStep t_step,
const QVariant &  t_value,
boost::optional< unsigned >  t_mergedJobIndex = boost::none 
)

Constructor for explicitly set variable.

openstudio::analysis::WorkflowStepJob::WorkflowStepJob ( const WorkflowStep t_step,
const QVariant &  t_value 
)

Constructor for explicitly set variable in preliminary part of compound measure.

Member Function Documentation

boost::optional<runmanager::JobErrors> openstudio::analysis::WorkflowStepJob::errors ( ) const

Returns errors from job if not job->hasMergedJobs().

Returns errors from MergeJobResults otherwise.

boost::optional<runmanager::Files> openstudio::analysis::WorkflowStepJob::outputFiles ( ) const

Returns ouptputFiles from job if not job->hasMergedJobs().

Returns outputFiles from MergeJobResults otherwise.

Friends And Related Function Documentation

typedef boost::optional<WorkflowStepJob> OptionalWorkflowStepJob
related
typedef std::vector<WorkflowStepJob> WorkflowStepJobVector
related

Member Data Documentation

boost::optional<runmanager::Job> openstudio::analysis::WorkflowStepJob::job
boost::optional<Measure> openstudio::analysis::WorkflowStepJob::measure
boost::optional<unsigned> openstudio::analysis::WorkflowStepJob::mergedJobIndex
WorkflowStep openstudio::analysis::WorkflowStepJob::step
boost::optional<QVariant> openstudio::analysis::WorkflowStepJob::value