JANA2
JArrow Class Referenceabstract
Inheritance diagram for JArrow:
Collaboration diagram for JArrow:

Public Types

enum  NodeType {
  Source,
  Sink,
  Stage,
  Group
}
 
enum  BackoffStrategy {
  Constant,
  Linear,
  Exponential
}
 
using duration_t = std::chrono::steady_clock::duration
 
- Public Types inherited from JActivable
enum  Status {
  Unopened,
  Inactive,
  Running,
  Draining,
  Drained,
  Finished,
  Closed
}
 

Public Member Functions

bool is_parallel ()
 
std::string get_name ()
 
bool is_upstream_finished ()
 
void set_chunksize (size_t chunksize)
 
size_t get_chunksize () const
 
void set_backoff_tries (unsigned backoff_tries)
 
unsigned get_backoff_tries () const
 
BackoffStrategy get_backoff_strategy () const
 
void set_backoff_strategy (BackoffStrategy backoff_strategy)
 
duration_t get_initial_backoff_time () const
 
void set_initial_backoff_time (const duration_t &initial_backoff_time)
 
const duration_t & get_checkin_time () const
 
void set_checkin_time (const duration_t &checkin_time)
 
void update_thread_count (int thread_count_delta)
 
size_t get_thread_count ()
 
JArrowMetricsget_metrics ()
 
Status get_status ()
 
NodeType get_type ()
 
 JArrow (std::string name, bool is_parallel, NodeType arrow_type, size_t chunksize=16)
 
virtual void initialize ()
 
virtual void execute (JArrowMetrics &result, size_t location_id)=0
 
virtual void finalize ()
 
virtual size_t get_pending ()
 
virtual size_t get_threshold ()
 
virtual void set_threshold (size_t threshold)
 
void set_active (bool is_active) override
 
- Public Member Functions inherited from JActivable
virtual bool is_active ()
 
void update_activeness (bool is_active)
 
void notify_downstream (bool is_active)
 
void attach_upstream (JActivable *activable)
 
void attach_downstream (JActivable *activable)
 

Protected Member Functions

void set_upstream_finished (bool upstream_finished)
 
void set_status (Status status)
 

Additional Inherited Members

- Protected Attributes inherited from JActivable
std::atomic< Status > _status {Status::Unopened}
 

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