stromx  0.8.0
Public Types | Public Member Functions | Protected Member Functions | Friends | List of all members
stromx::runtime::Connector Class Reference

Identifier of a connector of an operator. More...

#include <Connector.h>

Inheritance diagram for stromx::runtime::Connector:
stromx::runtime::InputConnector stromx::runtime::OutputConnector

Public Types

enum  Type { UNDEFINED, INPUT, OUTPUT }
 

Public Member Functions

 Connector ()
 
const Operatorop () const
 
unsigned int id () const
 
bool valid () const
 
Type type () const
 

Protected Member Functions

 Connector (const Type type, const Operator *const op, const unsigned int id)
 

Friends

STROMX_RUNTIME_API bool operator== (const Connector &lhs, const Connector &rhs)
 

Detailed Description

Identifier of a connector of an operator.

Member Enumeration Documentation

§ Type

The possible types of a connector.

Enumerator
UNDEFINED 

An invalid connector has undefined type.

INPUT 

An input connector.

OUTPUT 

An output connector.

Constructor & Destructor Documentation

§ Connector()

stromx::runtime::Connector::Connector ( )
inline

Constructs an invalid connector. Valid connectors can only be constructed using the derived classes InputConnector and OutputConnector.

Member Function Documentation

§ id()

unsigned int stromx::runtime::Connector::id ( ) const
inline

Returns the ID of the connector.

§ op()

const Operator* stromx::runtime::Connector::op ( ) const
inline

Returns a pointer to the operator the connector belongs to.

§ type()

Type stromx::runtime::Connector::type ( ) const
inline

Returns the type of the connector, i.e. whether this connector is an input or output connector.

§ valid()

bool stromx::runtime::Connector::valid ( ) const
inline

Returns true if this connector is valid, i.e. it does point to a valid connector. If the connector is invalid its operator pointer is 0 and its type UNDEFINED.


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