SyDEVS  v0.6.6
Multiscale Simulation and Systems Modeling Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
sydevs::systems::port_base< dmode, dgoal, T > Class Template Reference

A base class template for all port classes. More...

#include <port.h>

Inherited by sydevs::systems::port< dmode, dgoal, T >.

Public Member Functions

 port_base (const port_base &)=delete
 No copy constructor. More...
 
port_baseoperator= (const port_base &)=delete
 No copy assignment. More...
 
 port_base (port_base &&)=default
 Move constructor. More...
 
port_baseoperator= (port_base &&)=default
 Move assignment. More...
 
virtual ~port_base ()=default
 Destructor. More...
 
const std::string & port_name () const
 Returns the name of the port. More...
 
int64 port_index () const
 Returns the index of the port within the encompassing node_interface object. More...
 
int64 node_index () const
 Returns the index of the node within the encompassing node_structure object. More...
 
const node_interfaceexternal_interface () const
 Returns the encomassing node_interface object. More...
 

Protected Member Functions

 port_base (const std::string &port_name, int64 port_index, node_interface &external_interface)
 

Detailed Description

template<data_mode dmode, data_goal dgoal, typename T>
class sydevs::systems::port_base< dmode, dgoal, T >

A base class template for all port classes.

port_base contains indices and references common to all types of ports.

Constructor & Destructor Documentation

template<data_mode dmode, data_goal dgoal, typename T>
sydevs::systems::port_base< dmode, dgoal, T >::port_base ( const port_base< dmode, dgoal, T > &  )
delete

No copy constructor.

template<data_mode dmode, data_goal dgoal, typename T>
sydevs::systems::port_base< dmode, dgoal, T >::port_base ( port_base< dmode, dgoal, T > &&  )
default

Move constructor.

template<data_mode dmode, data_goal dgoal, typename T>
virtual sydevs::systems::port_base< dmode, dgoal, T >::~port_base ( )
virtualdefault

Destructor.

template<data_mode dmode, data_goal dgoal, typename T >
sydevs::systems::port_base< dmode, dgoal, T >::port_base ( const std::string &  port_name,
int64  port_index,
node_interface external_interface 
)
protected

Member Function Documentation

template<data_mode dmode, data_goal dgoal, typename T >
const node_interface & sydevs::systems::port_base< dmode, dgoal, T >::external_interface ( ) const

Returns the encomassing node_interface object.

template<data_mode dmode, data_goal dgoal, typename T >
int64 sydevs::systems::port_base< dmode, dgoal, T >::node_index ( ) const

Returns the index of the node within the encompassing node_structure object.

template<data_mode dmode, data_goal dgoal, typename T>
port_base& sydevs::systems::port_base< dmode, dgoal, T >::operator= ( const port_base< dmode, dgoal, T > &  )
delete

No copy assignment.

template<data_mode dmode, data_goal dgoal, typename T>
port_base& sydevs::systems::port_base< dmode, dgoal, T >::operator= ( port_base< dmode, dgoal, T > &&  )
default

Move assignment.

template<data_mode dmode, data_goal dgoal, typename T >
int64 sydevs::systems::port_base< dmode, dgoal, T >::port_index ( ) const

Returns the index of the port within the encompassing node_interface object.

template<data_mode dmode, data_goal dgoal, typename T >
const std::string & sydevs::systems::port_base< dmode, dgoal, T >::port_name ( ) const

Returns the name of the port.


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