inviwo::PythonOutport Class Reference

Inheritance diagram for inviwo::PythonOutport:

Public Member Functions
virtual void	clear () override
virtual std::string_view	getClassIdentifier () const override
virtual glm::uvec3	getColorCode () const override
pybind11::object	getData () const
virtual DataInfo	getDataInfo () const override
virtual Document	getInfo () const override
virtual bool	hasData () const override
	PythonOutport (std::string_view identifier, Document help={})
virtual void	setData (pybind11::object data)
Public Member Functions inherited from inviwo::Outport
const std::vector< Inport * > &	getConnectedInports () const
virtual void	invalidate (InvalidationLevel invalidationLevel)
virtual bool	isConnected () const override
bool	isConnectedTo (const Inport *port) const
virtual bool	isReady () const override
const BaseCallBack *	onConnect (std::function< void()> lambda)
const BaseCallBack *	onDisconnect (std::function< void()> lambda)
virtual void	propagateEvent (Event *event, Inport *source)
void	removeOnConnect (const BaseCallBack *callback)
void	removeOnDisconnect (const BaseCallBack *callback)
virtual void	setValid ()
Public Member Functions inherited from inviwo::Port
virtual void	deserialize (Deserializer &d) override
Document &	getHelp ()
const Document &	getHelp () const
const std::string &	getIdentifier () const
std::string	getPath () const
	Get the port path i.e. <processor identifier>.<port identifier>
void	getPath (std::pmr::string &out) const
Processor *	getProcessor () const
Port &	operator= (const Port &)=delete
Port &	operator= (Port &&)=delete
	Port (const Port &)=delete
	Port (Port &&)=delete
virtual void	serialize (Serializer &s) const override
Port &	setHelp (Document help)
void	setIdentifier (const std::string &name)

Additional Inherited Members
Protected Member Functions inherited from inviwo::Outport
virtual void	connectTo (Inport *port)
virtual void	disconnectFrom (Inport *port)
	Outport (std::string_view identifier, Document help)
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
std::vector< Inport * >	connectedInports_
InvalidationLevel	invalidationLevel_
StateCoordinator< bool >	isReady_
CallBackList	onConnectCallback_
CallBackList	onDisconnectCallback_
Protected Attributes inherited from inviwo::Port
Document	help_
std::string	identifier_
Processor *	processor_

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.

getDataInfo()

virtual DataInfo inviwo::PythonOutport::getDataInfo ( ) const

overridevirtual

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:

• modules/python3/include/modules/python3/pythonoutport.h