Detailed Description

Definition at line 27 of file action_node.hpp.

Inheritance diagram for ActionNode:

Collaboration diagram for ActionNode:

#include <action_node.hpp>

Public Member Functions
	ActionNode (Context &ctx, const char *label, const std::initializer_list< size_t > &parent_ids, const std::initializer_list< DIABasePtr > &parents)

std::vector< DIABase * >	children () const final
	ActionNodes do not have children. More...

void	DecConsumeCounter (size_t) final

void	IncConsumeCounter (size_t) final

void	PushData (bool) final
	ActionNodes do not push data, they only Execute. More...

void	RemoveAllChildren () final
	ActionNodes do not have children. More...

void	RemoveChild (DIABase *) final
	ActionNodes do not have children. More...

void	RunPushData () final
	ActionNodes do not push data, they only Execute. More...

void	SetConsumeCounter (size_t) final

Public Member Functions inherited from DIABase
	DIABase (Context &ctx, const char *label, const std::initializer_list< size_t > &parent_ids, const std::initializer_list< DIABasePtr > &parents)
	The constructor for a DIABase. More...

	DIABase (Context &ctx, const char *label, std::vector< size_t > &&parent_ids, std::vector< DIABasePtr > &&parents)
	The constructor for a DIABase. More...

	DIABase (const DIABase &)=delete
	non-copyable: delete copy-constructor More...

	DIABase (DIABase &&)=default
	move-constructor: default More...

virtual	~DIABase ()
	Virtual destructor for a DIABase. More...

virtual size_t	consume_counter () const
	Returns consume_counter_. More...

Context &	context ()
	Returns the api::Context of this DIABase. More...

const size_t &	dia_id () const
	return unique id of DIANode subclass as stored by StatsNode More...

virtual bool	ForwardDataOnly () const

const char *	label () const
	return label() of DIANode subclass as stored by StatsNode More...

mem::Manager &	mem_manager ()
	Return the Context's memory manager. More...

DIABase &	operator= (const DIABase &)=delete
	non-copyable: delete assignment operator More...

DIABase &	operator= (DIABase &&)=default
	move-assignment operator: default More...

std::vector< size_t >	parent_ids () const
	Returns the parents of this DIABase. More...

const std::vector< DIABasePtr > &	parents () const
	Returns the parents of this DIABase. More...

void	RemoveParent (DIABase *p)
	Remove a parent. More...

virtual bool	RequireParentPushData (size_t) const

void	RunScope ()

void	set_mem_limit (const DIAMemUse &mem_limit)

void	set_state (const DIAState &state)

DIAState	state () const

virtual DIAMemUse	PreOpMemUse ()
	Amount of RAM used by PreOp after StartPreOp() More...

virtual void	StartPreOp (size_t)
	Virtual method for preparing start of PushData. More...

virtual bool	OnPreOpFile (const data::File &, size_t)

virtual void	StopPreOp (size_t)
	Virtual method for preparing end of PushData. More...

virtual DIAMemUse	ExecuteMemUse ()
	Amount of RAM used by Execute() More...

virtual void	Execute ()=0
	Virtual execution method. Triggers actual computation in sub-classes. More...

virtual DIAMemUse	PushDataMemUse ()
	Amount of RAM used by PushData() More...

virtual void	Dispose ()
	Virtual clear method. Triggers actual disposing in sub-classes. More...

Public Member Functions inherited from ReferenceCounter
	ReferenceCounter () noexcept
	new objects have zero reference count More...

	ReferenceCounter (const ReferenceCounter &) noexcept
	coping still creates a new object with zero reference count More...

	~ReferenceCounter ()

bool	dec_reference () const noexcept
	Call whenever resetting (i.e. More...

void	inc_reference () const noexcept
	Call whenever setting a pointer to the object. More...

ReferenceCounter &	operator= (const ReferenceCounter &) noexcept
	assignment operator, leaves pointers unchanged More...

size_t	reference_count () const noexcept
	Return the number of references to this object (for debugging) More...

bool	unique () const noexcept
	Test if the ReferenceCounter is referenced by only one CountingPtr. More...

Additional Inherited Members
Public Types inherited from DIABase
using	DIABasePtr = tlx::CountingPtr< DIABase >

Public Attributes inherited from DIABase
common::JsonLogger	logger_

Static Public Attributes inherited from DIABase
static constexpr size_t	kNeverConsume = static_cast<size_t>(-1)
	Never full consume. More...

Protected Attributes inherited from DIABase
Context &	context_
	associated Context More...

const size_t	dia_id_
	DIA serial id. More...

const char *const	label_
	DOp node static label. More...

DIAState	state_ = DIAState::NEW
	State of the DIANode. State is NEW on creation. More...

std::vector< DIABasePtr >	parents_
	Parents of this DIABase. More...

DIAMemUse	mem_limit_ = 0

size_t	consume_counter_ = 1

Constructor & Destructor Documentation

◆ ActionNode()

ActionNode	(	Context &	ctx,
		const char *	label,
		const std::initializer_list< size_t > &	parent_ids,
		const std::initializer_list< DIABasePtr > &	parents
	)

inline

Definition at line 30 of file action_node.hpp.

Member Function Documentation

◆ children()

std::vector<DIABase*> children ( ) const

inlinefinalvirtual

ActionNodes do not have children.

Implements DIABase.

Definition at line 42 of file action_node.hpp.

◆ DecConsumeCounter()

void DecConsumeCounter ( size_t counter )

inlinefinalvirtual

Virtual SetConsume flag which is called by the user via .Keep() or .Consume() to set consumption.

Reimplemented from DIABase.

Definition at line 55 of file action_node.hpp.

References die.

◆ IncConsumeCounter()

void IncConsumeCounter ( size_t counter )

inlinefinalvirtual

Virtual SetConsume flag which is called by the user via .Keep() or .Consume() to set consumption.

Reimplemented from DIABase.

Definition at line 51 of file action_node.hpp.

References die.

◆ PushData()

void PushData ( bool )

inlinefinalvirtual

ActionNodes do not push data, they only Execute.

Implements DIABase.

Definition at line 46 of file action_node.hpp.

◆ RemoveAllChildren()

void RemoveAllChildren ( )

inlinefinalvirtual

ActionNodes do not have children.

Implements DIABase.

Definition at line 39 of file action_node.hpp.

◆ RemoveChild()

void RemoveChild ( DIABase * )

inlinefinalvirtual

ActionNodes do not have children.

Implements DIABase.

Definition at line 36 of file action_node.hpp.

◆ RunPushData()

void RunPushData ( )

inlinefinalvirtual

ActionNodes do not push data, they only Execute.

Implements DIABase.

Definition at line 49 of file action_node.hpp.

◆ SetConsumeCounter()

void SetConsumeCounter ( size_t counter )

inlinefinalvirtual

Virtual SetConsume flag which is called by the user via .Keep() or .Consume() to set consumption.

Reimplemented from DIABase.

Definition at line 59 of file action_node.hpp.

References die.

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

thrill/api/action_node.hpp

Detailed Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ ActionNode()

Member Function Documentation

◆ children()

◆ DecConsumeCounter()

◆ IncConsumeCounter()

◆ PushData()

◆ RemoveAllChildren()

◆ RemoveChild()

◆ RunPushData()

◆ SetConsumeCounter()