SyDEVS  v0.7
Simulation-based analysis of complex systems involving people, devices, physical elements, and dynamic environments.
sydevs::systems::node_interface Class Reference

#include <node_interface.h>

Public Member Functions

 node_interface (const std::string &node_name, system_node *node_ptr, const node_context &external_context)
 
 node_interface (const node_interface &)=delete
 No copy constructor. More...
 
node_interfaceoperator= (const node_interface &)=delete
 No copy assignment. More...
 
 node_interface (node_interface &&)=delete
 No move constructor. More...
 
node_interfaceoperator= (node_interface &&)=delete
 No move assignment. More...
 
virtual ~node_interface ()=default
 Destructor. More...
 
const std::string & node_name ()
 
const std::string & full_name ()
 
int64 node_index ()
 
node_contextexternal_context ()
 
int64 add_flow_input_port (const std::string &port_name)
 
int64 flow_input_port_count ()
 
const std::string & flow_input_port_name (int64 port_index)
 
const pointerflow_input_port_value (int64 port_index)
 
void clear_flow_inputs ()
 
void assign_flow_input (int64 port_index, const pointer &val)
 
tostring_function flow_input_tostring_func (int64 port_index)
 
void set_flow_input_printable (int64 port_index, tostring_function tostring_func)
 
int64 add_message_input_port (const std::string &port_name)
 
int64 message_input_port_count ()
 
const std::string & message_input_port_name (int64 port_index)
 
const pointermessage_input_port_value (int64 port_index)
 
int64 message_input_port_index ()
 
void clear_message_input ()
 
void set_message_input (int64 port_index, const pointer &val)
 
tostring_function message_input_tostring_func (int64 port_index)
 
void set_message_input_printable (int64 port_index, tostring_function tostring_func)
 
int64 add_message_output_port (const std::string &port_name)
 
int64 message_output_port_count ()
 
const std::string & message_output_port_name (int64 port_index)
 
int64 message_output_list_size ()
 
int64 message_output_index (int64 list_index)
 
const pointermessage_output_value (int64 list_index)
 
void clear_message_outputs ()
 
void append_message_output (int64 port_index, const pointer &val)
 
tostring_function message_output_tostring_func (int64 port_index)
 
void set_message_output_printable (int64 port_index, tostring_function tostring_func)
 
int64 add_flow_output_port (const std::string &port_name)
 
int64 flow_output_port_count ()
 
const std::string & flow_output_port_name (int64 port_index)
 
const pointerflow_output_port_value (int64 port_index)
 
void clear_flow_outputs ()
 
void assign_flow_output (int64 port_index, const pointer &val)
 
tostring_function flow_output_tostring_func (int64 port_index)
 
void set_flow_output_printable (int64 port_index, tostring_function tostring_func)
 
void activate (data_mode dmode, data_goal dgoal)
 
void deactivate ()
 
bool active () const
 
data_mode dmode () const
 
data_goal dgoal () const
 
int64 missing_flow_input ()
 
int64 missing_flow_output ()
 
void print_port_value (const std::string &port_name, const std::string &val_string)
 
void print_flow_input (int64 port_index)
 
void print_message_input (int64 port_index)
 
void print_message_output (int64 list_index, int64 port_index)
 
void print_flow_output (int64 port_index)
 
void print_command_text (const std::string &command, const std::string &text)
 
bool print_on_event_flag ()
 
void print_on_event (bool flag=true)
 
void print_event (const std::string &text)
 
bool print_on_elapsed_duration_flag ()
 
void print_on_elapsed_duration (bool flag)
 
void print_elapsed_duration (duration elapsed_dt)
 
bool print_on_planned_duration_flag ()
 
void print_on_planned_duration (bool flag)
 
void print_planned_duration (duration planned_dt)
 

Constructor & Destructor Documentation

◆ node_interface() [1/3]

sydevs::systems::node_interface::node_interface ( const std::string &  node_name,
system_node node_ptr,
const node_context external_context 
)

◆ node_interface() [2/3]

sydevs::systems::node_interface::node_interface ( const node_interface )
delete

No copy constructor.

◆ node_interface() [3/3]

sydevs::systems::node_interface::node_interface ( node_interface &&  )
delete

No move constructor.

◆ ~node_interface()

virtual sydevs::systems::node_interface::~node_interface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ activate()

void sydevs::systems::node_interface::activate ( data_mode  dmode,
data_goal  dgoal 
)
inline

◆ active()

bool sydevs::systems::node_interface::active ( ) const
inline

◆ add_flow_input_port()

int64 sydevs::systems::node_interface::add_flow_input_port ( const std::string &  port_name)

◆ add_flow_output_port()

int64 sydevs::systems::node_interface::add_flow_output_port ( const std::string &  port_name)

◆ add_message_input_port()

int64 sydevs::systems::node_interface::add_message_input_port ( const std::string &  port_name)

◆ add_message_output_port()

int64 sydevs::systems::node_interface::add_message_output_port ( const std::string &  port_name)

◆ append_message_output()

void sydevs::systems::node_interface::append_message_output ( int64  port_index,
const pointer val 
)

◆ assign_flow_input()

void sydevs::systems::node_interface::assign_flow_input ( int64  port_index,
const pointer val 
)

◆ assign_flow_output()

void sydevs::systems::node_interface::assign_flow_output ( int64  port_index,
const pointer val 
)

◆ clear_flow_inputs()

void sydevs::systems::node_interface::clear_flow_inputs ( )

◆ clear_flow_outputs()

void sydevs::systems::node_interface::clear_flow_outputs ( )

◆ clear_message_input()

void sydevs::systems::node_interface::clear_message_input ( )

◆ clear_message_outputs()

void sydevs::systems::node_interface::clear_message_outputs ( )

◆ deactivate()

void sydevs::systems::node_interface::deactivate ( )
inline

◆ dgoal()

data_goal sydevs::systems::node_interface::dgoal ( ) const
inline

◆ dmode()

data_mode sydevs::systems::node_interface::dmode ( ) const
inline

◆ external_context()

node_context & sydevs::systems::node_interface::external_context ( )
inline

◆ flow_input_port_count()

int64 sydevs::systems::node_interface::flow_input_port_count ( )

◆ flow_input_port_name()

const std::string & sydevs::systems::node_interface::flow_input_port_name ( int64  port_index)

◆ flow_input_port_value()

const pointer & sydevs::systems::node_interface::flow_input_port_value ( int64  port_index)

◆ flow_input_tostring_func()

tostring_function sydevs::systems::node_interface::flow_input_tostring_func ( int64  port_index)

◆ flow_output_port_count()

int64 sydevs::systems::node_interface::flow_output_port_count ( )

◆ flow_output_port_name()

const std::string & sydevs::systems::node_interface::flow_output_port_name ( int64  port_index)

◆ flow_output_port_value()

const pointer & sydevs::systems::node_interface::flow_output_port_value ( int64  port_index)

◆ flow_output_tostring_func()

tostring_function sydevs::systems::node_interface::flow_output_tostring_func ( int64  port_index)

◆ full_name()

const std::string & sydevs::systems::node_interface::full_name ( )
inline

◆ message_input_port_count()

int64 sydevs::systems::node_interface::message_input_port_count ( )

◆ message_input_port_index()

int64 sydevs::systems::node_interface::message_input_port_index ( )

◆ message_input_port_name()

const std::string & sydevs::systems::node_interface::message_input_port_name ( int64  port_index)

◆ message_input_port_value()

const pointer & sydevs::systems::node_interface::message_input_port_value ( int64  port_index)

◆ message_input_tostring_func()

tostring_function sydevs::systems::node_interface::message_input_tostring_func ( int64  port_index)

◆ message_output_index()

int64 sydevs::systems::node_interface::message_output_index ( int64  list_index)

◆ message_output_list_size()

int64 sydevs::systems::node_interface::message_output_list_size ( )

◆ message_output_port_count()

int64 sydevs::systems::node_interface::message_output_port_count ( )

◆ message_output_port_name()

const std::string & sydevs::systems::node_interface::message_output_port_name ( int64  port_index)

◆ message_output_tostring_func()

tostring_function sydevs::systems::node_interface::message_output_tostring_func ( int64  port_index)

◆ message_output_value()

const pointer & sydevs::systems::node_interface::message_output_value ( int64  list_index)

◆ missing_flow_input()

int64 sydevs::systems::node_interface::missing_flow_input ( )

◆ missing_flow_output()

int64 sydevs::systems::node_interface::missing_flow_output ( )

◆ node_index()

int64 sydevs::systems::node_interface::node_index ( )
inline

◆ node_name()

const std::string & sydevs::systems::node_interface::node_name ( )
inline

◆ operator=() [1/2]

node_interface& sydevs::systems::node_interface::operator= ( const node_interface )
delete

No copy assignment.

◆ operator=() [2/2]

node_interface& sydevs::systems::node_interface::operator= ( node_interface &&  )
delete

No move assignment.

◆ print_command_text()

void sydevs::systems::node_interface::print_command_text ( const std::string &  command,
const std::string &  text 
)

◆ print_elapsed_duration()

void sydevs::systems::node_interface::print_elapsed_duration ( duration  elapsed_dt)

◆ print_event()

void sydevs::systems::node_interface::print_event ( const std::string &  text)

◆ print_flow_input()

void sydevs::systems::node_interface::print_flow_input ( int64  port_index)

◆ print_flow_output()

void sydevs::systems::node_interface::print_flow_output ( int64  port_index)

◆ print_message_input()

void sydevs::systems::node_interface::print_message_input ( int64  port_index)

◆ print_message_output()

void sydevs::systems::node_interface::print_message_output ( int64  list_index,
int64  port_index 
)

◆ print_on_elapsed_duration()

void sydevs::systems::node_interface::print_on_elapsed_duration ( bool  flag)

◆ print_on_elapsed_duration_flag()

bool sydevs::systems::node_interface::print_on_elapsed_duration_flag ( )

◆ print_on_event()

void sydevs::systems::node_interface::print_on_event ( bool  flag = true)

◆ print_on_event_flag()

bool sydevs::systems::node_interface::print_on_event_flag ( )

◆ print_on_planned_duration()

void sydevs::systems::node_interface::print_on_planned_duration ( bool  flag)

◆ print_on_planned_duration_flag()

bool sydevs::systems::node_interface::print_on_planned_duration_flag ( )

◆ print_planned_duration()

void sydevs::systems::node_interface::print_planned_duration ( duration  planned_dt)

◆ print_port_value()

void sydevs::systems::node_interface::print_port_value ( const std::string &  port_name,
const std::string &  val_string 
)

◆ set_flow_input_printable()

void sydevs::systems::node_interface::set_flow_input_printable ( int64  port_index,
tostring_function  tostring_func 
)

◆ set_flow_output_printable()

void sydevs::systems::node_interface::set_flow_output_printable ( int64  port_index,
tostring_function  tostring_func 
)

◆ set_message_input()

void sydevs::systems::node_interface::set_message_input ( int64  port_index,
const pointer val 
)

◆ set_message_input_printable()

void sydevs::systems::node_interface::set_message_input_printable ( int64  port_index,
tostring_function  tostring_func 
)

◆ set_message_output_printable()

void sydevs::systems::node_interface::set_message_output_printable ( int64  port_index,
tostring_function  tostring_func 
)

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