Bobox
Public Member Functions | Protected Member Functions | Private Member Functions
bobox::box_model Class Reference

Interface for classes which represents model of boxes. More...

#include <bobox_box_model.hpp>

Inheritance diagram for bobox::box_model:
bobox::basic_box_model bobox::model_box::model bobox::passthrough_box::model bobox::generic_box_model< TBox > bobox::basic_box::generic_model< TBox, bst > bobox::simple_box::generic_model< TBox, bst >

List of all members.

Public Member Functions

boxcreate (box_id_type id, const box_tid_type &tid, box_pid_type pid, const io_multipliers_type &input_multipliers, const io_multipliers_type &output_multipliers, plevel_type plevel, request *req) const
 Creates the new box.
boxcreate (box_id_type id, const box_tid_type &tid, box_pid_type pid, plevel_type plevel, request *req) const
 Creates the new box.
virtual input_index_type get_input_by_name (const std::string &name) const
 Gets the input with the given name.
virtual io_descriptor get_input_descriptor (input_index_type input) const =0
 Gets the input descriptor.
virtual size_t get_inputs_count () const =0
 Gets the number of inputs.
virtual output_index_type get_output_by_name (const std::string &name) const
 Gets the output with the given name.
virtual io_descriptor get_output_descriptor (output_index_type output) const =0
 Gets the output descriptor.
virtual size_t get_outputs_count () const =0
 Gets the number of outputs.
runtimeget_runtime () const
 Gets the request to which the box model belongs.
template<class TRuntime >
TRuntime * get_runtime () const
 Gets the request to which the box model belongs and casts it.
virtual box_stateness_type get_stateness_type () const =0
 Gets the stateness type of the box.

Protected Member Functions

 box_model (runtime *rt)
 Constructor.

Private Member Functions

virtual boxcreate_impl (box_id_type id, const box_tid_type &tid, box_pid_type pid, const io_multipliers_type &input_multipliers, const io_multipliers_type &output_multipliers, plevel_type plevel, request *req) const =0
 This method is intended to be overriden. See bobox::box_model::create.

Detailed Description

Interface for classes which represents model of boxes.


Constructor & Destructor Documentation

bobox::box_model::box_model ( runtime rt) [protected]

Constructor.

Parameters:
rtThe runtime to which the box will belong.

Member Function Documentation

box* bobox::box_model::create ( box_id_type  id,
const box_tid_type tid,
box_pid_type  pid,
const io_multipliers_type &  input_multipliers,
const io_multipliers_type &  output_multipliers,
plevel_type  plevel,
request req 
) const

Creates the new box.

Parameters:
idThe box identifier.
tidThe box tid .
pidThe box pid .
input_multipliersThe input multipliers, i.e. multiplicities of all inputs.
output_multipliersThe output multipliers, i.e. multiplicities of all outputs.
plevelThe plevel of the box.
reqThe request to which the box will belong.
Returns:
The new box.
box* bobox::box_model::create ( box_id_type  id,
const box_tid_type tid,
box_pid_type  pid,
plevel_type  plevel,
request req 
) const

Creates the new box.

Parameters:
idThe box identifier.
tidThe box tid .
pidThe box pid .
plevelThe plevel of the box.
reqThe request to which the box will belong.
Returns:
The new box.

Gets the input descriptor.

Parameters:
inputThe input index.

Gets the output descriptor.

Parameters:
outputThe output index.

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