inviwo::PythonInport Class Reference

Inheritance diagram for inviwo::PythonInport:

Public Member Functions
virtual bool	canConnectTo (const Port *port) const override
virtual void	connectTo (Outport *outport) override
virtual void	disconnectFrom (Outport *outport) override
virtual std::string_view	getClassIdentifier () const override
virtual uvec3	getColorCode () const override
Outport *	getConnectedOutport () const
virtual Outport *	getConnectedOutport (size_t i) const override
virtual Outport *	getConnectedOutport (size_t i) const=0
pybind11::object	getData () const
virtual DataInfo	getDataInfo () const override
virtual Document	getInfo () const override
virtual size_t	getMaxNumberOfConnections () const override
virtual size_t	getNumberOfConnections () const override
bool	hasData () const
	PythonInport (std::string_view identifier, Document help={})
Public Member Functions inherited from inviwo::Inport
Outport *	getConnectedOutport () const
auto	getConnectedOutports () const
virtual bool	isChanged () const
virtual bool	isConnected () const override
virtual bool	isConnectedTo (const Outport *outport) const
bool	isOptional () const
virtual bool	isReady () const override
const BaseCallBack *	onChange (std::function< void()> lambda)
std::shared_ptr< std::function< void()> >	onChangeScoped (std::function< void()> lambda)
const BaseCallBack *	onConnect (std::function< void()> lambda)
std::shared_ptr< std::function< void()> >	onConnectScoped (std::function< void()> lambda)
const BaseCallBack *	onDisconnect (std::function< void()> lambda)
std::shared_ptr< std::function< void()> >	onDisconnectScoped (std::function< void()> lambda)
virtual void	propagateEvent (Event *event, Outport *target=nullptr)
void	readyUpdate ()
void	removeOnChange (const BaseCallBack *callback)
void	removeOnConnect (const BaseCallBack *callback)
void	removeOnDisconnect (const BaseCallBack *callback)
void	setIsReadyUpdater (std::function< bool()> updater)
void	setOptional (bool optional)
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
Public Attributes inherited from inviwo::Inport
std::shared_ptr< std::function< void(Outport *)>	onConnectScoped )(std::function< void(Outport *)> lambda)
std::shared_ptr< std::function< void(Outport *)>	onDisconnectScoped )(std::function< void(Outport *)> lambda)
Protected Member Functions inherited from inviwo::Inport
void	callOnChangeIfChanged () const
bool	circularConnection (const Port *port) const
void	doConnectTo (Outport *outport)
void	doDisconnectFrom (Outport *outport)
	Inport (std::string_view identifier, Document help)
virtual void	invalidate (InvalidationLevel invalidationLevel)
virtual void	setChanged (bool changed)
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::Inport
static Document	getDefaultPortInfo (const Inport *port, std::string_view portname)
Protected Attributes inherited from inviwo::Inport
StateCoordinator< bool >	isOptional_
StateCoordinator< bool >	isReady_
Protected Attributes inherited from inviwo::Port
Document	help_
std::string	identifier_
Processor *	processor_

Member Function Documentation

canConnectTo()

virtual bool inviwo::PythonInport::canConnectTo ( const Port * port ) const

overridevirtual

Implements inviwo::Inport.

connectTo()

virtual void inviwo::PythonInport::connectTo ( Outport * outport )

overridevirtual

Implements inviwo::Inport.

disconnectFrom()

virtual void inviwo::PythonInport::disconnectFrom ( Outport * outport )

overridevirtual

Implements inviwo::Inport.

getClassIdentifier()

std::string_view inviwo::PythonInport::getClassIdentifier ( ) const

inlineoverridevirtual

Implements inviwo::Port.

getColorCode()

virtual uvec3 inviwo::PythonInport::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.

getConnectedOutport() [1/2]

virtual Outport * inviwo::PythonInport::getConnectedOutport ( size_t i ) const

overridevirtual

Implements inviwo::Inport.

getConnectedOutport() [2/2]

virtual Outport * inviwo::Inport::getConnectedOutport ( size_t i ) const

virtual

Implements inviwo::Inport.

getDataInfo()

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

overridevirtual

Implements inviwo::Port.

getInfo()

virtual Document inviwo::PythonInport::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.

getMaxNumberOfConnections()

virtual size_t inviwo::PythonInport::getMaxNumberOfConnections ( ) const

inlineoverridevirtual

Implements inviwo::Inport.

getNumberOfConnections()

virtual size_t inviwo::PythonInport::getNumberOfConnections ( ) const

overridevirtual

Implements inviwo::Inport.

---

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

• modules/python3/include/modules/python3/pythoninport.h