A Port is the fundamental point of data production or consumption.

Refinement of
Refinements
Notation

The following expressions are used in this document:

T

A Tag type. If omitted, T defaults to default_tag.

PC

A PortCategory type.

S

A Side type.

M

A Mechanism type.

P

A Port type, for Tag T.

PT

PortTraits of P for T.

p

An object of type P

Port Requirements

The requirements are listed only when different or in addition to Entity requirements.

Name

Expression

Result Type

Semantics

Port Traits

traits_of<P, T>::type

PT

The PortTraits of the Port.

Port Concept Check

is_port<P, T>::type

Boolean MPL Metafunction that evaulates to true

Concept check for the Port concept.

Has Default Port

has_default_port<P,S,M,T>::type

Boolean MPL Metafunction that evaulates to true

A Port has a default port for any Side and Mechanism (it is the port object itself).

Get Default Port

get_default_port<S,M,T>(p)

p

Returns the port object (the default port of a Port object is the object itself).

PortTraits Requirements

The requirements are listed only when different or in addition to Traits requirements.

Name

Expression

Result Type

Semantics

Port Category

PT::category

PortCategory type

The category of the port

Header

The types, templates, and functions shown here are declared in the following files: 

#include <boost/dataflow/support/port.hpp> // or
#include <boost/dataflow/support.hpp>

Models