Inviwo 0.9.12-pre
Inviwo documentation
inviwo::PythonOutport Class Reference
Inheritance diagram for inviwo::PythonOutport:

Public Member Functions

 PythonOutport (std::string_view identifier, Document help={})
virtual std::string_view getClassIdentifier () const override
virtual glm::uvec3 getColorCode () const override
virtual Document getInfo () const override
pybind11::object getData () const
virtual void clear () override
virtual void setData (pybind11::object data)
virtual bool hasData () const override
Public Member Functions inherited from inviwo::Outport
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
 Port (const Port &)=delete
Portoperator= (const Port &)=delete
 Port (Port &&)=delete
Portoperator= (Port &&)=delete
const std::string & getIdentifier () const
void setIdentifier (const std::string &name)
ProcessorgetProcessor () const
std::string getPath () const
 Get the port path i.e. <processor identifier>.<port identifier>
void getPath (std::pmr::string &out) const
const DocumentgetHelp () const
DocumentgetHelp ()
PortsetHelp (Document help)
virtual void serialize (Serializer &s) const override
virtual void deserialize (Deserializer &d) override

Additional Inherited Members

Protected Member Functions inherited from inviwo::Outport
 Outport (std::string_view identifier, Document help)
virtual void connectTo (Inport *port)
virtual void disconnectFrom (Inport *port)
Protected Member Functions inherited from inviwo::Port
 Port (std::string_view identifier, Document help)
void setProcessor (Processor *processor)
Static Protected Member Functions inherited from inviwo::Outport
static Document getDefaultPortInfo (const Outport *port, std::string_view portname)
Protected Attributes inherited from inviwo::Outport
StateCoordinator< bool > isReady_
InvalidationLevel invalidationLevel_
std::vector< Inport * > connectedInports_
CallBackList onConnectCallback_
CallBackList onDisconnectCallback_
Protected Attributes inherited from inviwo::Port
std::string identifier_
Processorprocessor_
Document help_

Member Function Documentation

◆ clear()

virtual void inviwo::PythonOutport::clear ( )
overridevirtual

Clear the outport of any data

Implements inviwo::Outport.

◆ getClassIdentifier()

std::string_view inviwo::PythonOutport::getClassIdentifier ( ) const
inlineoverridevirtual

Implements inviwo::Port.

◆ getColorCode()

virtual glm::uvec3 inviwo::PythonOutport::getColorCode ( ) const
inlineoverridevirtual

Returns the RGB color code used to colorize all ports of this type. This color code is for instance used in the NetworkEditor. To distinguish different port types through their color, this method should be overloaded in derived classes.

Implements inviwo::Port.

◆ getInfo()

virtual Document inviwo::PythonOutport::getInfo ( ) const
overridevirtual

This function should describe the state of the port and the data it holds. Derived ports should extend this function and add information about their state. The port help is usually included in this information. The description is usually shown as a tooltip in the GUI.

Implements inviwo::Port.

◆ hasData()

virtual bool inviwo::PythonOutport::hasData ( ) const
overridevirtual

Query if the outport has any data

Implements inviwo::Outport.


The documentation for this class was generated from the following file:
  • pythonoutport.h