WireCell::Pgraph::Port Class Reference

#include <Port.h>

Public Types
enum	Type {   tail =0, output =0, head =1, input =1,   ntypes =2 }

Public Member Functions
	Port (Node *node, Type type, std::string signature, std::string name="")
bool	isinput ()
bool	isoutput ()
Edge	edge ()
Edge	plug (Edge edge)
size_t	size ()
bool	empty ()
Data	get (bool pop=true)
void	put (Data &data)
Node *	node ()
const std::string &	name ()
const std::string &	signature ()

Private Attributes
Node *	m_node
Type	m_type
std::string	m_name
std::string	m_sig
Edge	m_edge

Detailed Description

Definition at line 31 of file Port.h.

Member Enumeration Documentation

enum WireCell::Pgraph::Port::Type

Enumerator
tail
output
head
input
ntypes

Definition at line 33 of file Port.h.

{ tail=0, output=0, head=1, input=1, ntypes=2 };

Constructor & Destructor Documentation

Port< T >::Port	(	Node *	node,
		Type	type,
		std::string	signature,
		std::string	name = ""
	)

Definition at line 9 of file Port.cxx.

    : m_node(node)
    , m_type(type)
    , m_name(name)
    , m_sig(signature)
    , m_edge(nullptr)
{ }

Member Function Documentation

Edge Port< T >::edge

(

)

Definition at line 20 of file Port.cxx.

{ return m_edge; }

bool Port< T >::empty

(

void

)

Definition at line 36 of file Port.cxx.

                 {
    if (!m_edge or m_edge->empty()) { return true; }
    return false;
}

Data Port< T >::get

(

bool

pop = true

)

Definition at line 43 of file Port.cxx.

                       {
    if (isoutput()) {
        THROW(RuntimeError()
              << errmsg{"can not get from output port"});
    }
    if (!m_edge) {
        THROW(RuntimeError() << errmsg{"port has no edge"});
    }
    if (m_edge->empty()) {
        THROW(RuntimeError() << errmsg{"edge is empty"});
    }
    Data ret = m_edge->front();
    if (pop) {
        m_edge->pop_front();
    }
    return ret;
}

bool Port< T >::isinput

(

)

Definition at line 17 of file Port.cxx.

{ return m_type == Port::input; }

bool Port< T >::isoutput

(

)

Definition at line 18 of file Port.cxx.

{ return m_type == Port::output; }

const std::string & Port< T >::name

(

)

Definition at line 72 of file Port.cxx.

{ return m_name; }

Node* WireCell::Pgraph::Port::node

(

)

Edge Port< T >::plug

(

Edge

edge

)

Definition at line 23 of file Port.cxx.

                         {
    Edge ret = m_edge;
    m_edge = edge;
    return ret;
}

void Port< T >::put

(

Data &

data

)

Definition at line 62 of file Port.cxx.

                         {
    if (isinput()) {
        THROW(RuntimeError() << errmsg{"can not put to input port"});
    }
    if (!m_edge) {
        THROW(RuntimeError() << errmsg{"port has no edge"});
    }
    m_edge->push_back(data);
}

const std::string & Port< T >::signature

(

)

Definition at line 73 of file Port.cxx.

{ return m_sig; }

size_t Port< T >::size

(

void

)

Definition at line 30 of file Port.cxx.

                  {
    if (!m_edge) { return 0; }
    return m_edge->size();
}

Member Data Documentation

Edge WireCell::Pgraph::Port::m_edge

private

Definition at line 67 of file Port.h.

std::string WireCell::Pgraph::Port::m_name

private

Definition at line 66 of file Port.h.

Node* WireCell::Pgraph::Port::m_node

private

Definition at line 64 of file Port.h.

std::string WireCell::Pgraph::Port::m_sig

private

Definition at line 66 of file Port.h.

Type WireCell::Pgraph::Port::m_type

private

Definition at line 65 of file Port.h.

---

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

• wire-cell-build/pgraph/inc/WireCellPgraph/Port.h
• wire-cell-build/pgraph/src/Port.cxx