Inviwo  0.9.10.1
Inviwo documentation
inviwo::Outport Class Reference

Abstract base class for all outports The Outport can be connected to an arbitrary number of Inports. More...

#include <outport.h>

+ Inheritance diagram for inviwo::Outport:

Public Member Functions

virtual bool isConnected () const override
 
virtual bool isReady () const override
 
virtual void invalidate (InvalidationLevel invalidationLevel)
 
virtual InvalidationLevel getInvalidationLevel () const
 
virtual void propagateEvent (Event *event, Inport *source)
 
bool isConnectedTo (const Inport *port) const
 
const std::vector< Inport * > & getConnectedInports () const
 
const BaseCallBack * onConnect (std::function< void()> lambda)
 
const BaseCallBack * onDisconnect (std::function< void()> lambda)
 
void removeOnConnect (const BaseCallBack *callback)
 
void removeOnDisconnect (const BaseCallBack *callback)
 
virtual void setValid ()
 
- Public Member Functions inherited from inviwo::Port
std::string getIdentifier () const
 
void setIdentifier (const std::string &name)
 
ProcessorgetProcessor () const
 
virtual std::string getClassIdentifier () const =0
 
virtual uvec3 getColorCode () const =0
 
virtual Document getInfo () const =0
 
virtual void serialize (Serializer &s) const override
 
virtual void deserialize (Deserializer &d) override
 

Protected Member Functions

 Outport (std::string identifier="")
 
virtual void connectTo (Inport *port)
 
virtual void disconnectFrom (Inport *port)
 
- Protected Member Functions inherited from inviwo::Port
 Port (std::string identifier="")
 
void setProcessor (Processor *processor)
 

Protected Attributes

StateCoordinator< bool > isReady_
 
InvalidationLevel invalidationLevel_
 
std::vector< Inport * > connectedInports_
 
CallBackList onConnectCallback_
 
CallBackList onDisconnectCallback_
 
- Protected Attributes inherited from inviwo::Port
std::string identifier_
 
Processorprocessor_
 

Friends

class Inport
 
class Processor
 

Detailed Description

Abstract base class for all outports The Outport can be connected to an arbitrary number of Inports.

Member Function Documentation

◆ invalidate()

void inviwo::Outport::invalidate ( InvalidationLevel  invalidationLevel)
virtual

Called by Processor::invalidate, will invalidate its connected inports.

Reimplemented in inviwo::ImageOutport.

◆ isReady()

bool inviwo::Outport::isReady ( ) const
overridevirtual

An outport is ready if it has data and is valid. The port is set valid after its processor successfully finishes processing.

See also
invalidate
setValid

Implements inviwo::Port.

◆ onConnect()

const BaseCallBack * inviwo::Outport::onConnect ( std::function< void()>  lambda)

Called each time connected to an inport.

◆ onDisconnect()

const BaseCallBack * inviwo::Outport::onDisconnect ( std::function< void()>  lambda)

Called each time disconnected from an inport.

◆ propagateEvent()

void inviwo::Outport::propagateEvent ( Event event,
Inport source 
)
virtual

Propagate events upwards, i.e. to the owning processor.

Reimplemented in inviwo::ImageOutport.

◆ setValid()

void inviwo::Outport::setValid ( )
virtual

Called by Processor::setValid, will call setValid its connected inports.


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