inviwo::PythonInport Class Reference

Inheritance diagram for inviwo::PythonInport:

Public Member Functions
	PythonInport (std::string_view identifier, Document help={})
virtual std::string_view	getClassIdentifier () const override
virtual uvec3	getColorCode () const override
virtual Document	getInfo () const override
virtual size_t	getMaxNumberOfConnections () const override
virtual bool	canConnectTo (const Port *port) const override
pybind11::object	getData () const
bool	hasData () const
Public Member Functions inherited from inviwo::Inport
virtual bool	isConnected () const override
virtual bool	isReady () const override
void	setOptional (bool optional)
bool	isOptional () const
virtual bool	isChanged () const
virtual void	connectTo (Outport *outport)
virtual void	disconnectFrom (Outport *outport)
virtual bool	isConnectedTo (const Outport *outport) const
virtual Outport *	getConnectedOutport () const
virtual const std::vector< Outport * > &	getConnectedOutports () const
virtual size_t	getNumberOfConnections () const
virtual const std::vector< const Outport * > &	getChangedOutports () const
virtual void	propagateEvent (Event *event, Outport *target=nullptr)
const BaseCallBack *	onChange (std::function< void()> lambda)
std::shared_ptr< std::function< void()> >	onChangeScoped (std::function< void()> lambda)
const BaseCallBack *	onInvalid (std::function< void()> lambda)
std::shared_ptr< std::function< void()> >	onInvalidScoped (std::function< void()> lambda)
const BaseCallBack *	onConnect (std::function< void()> lambda)
const BaseCallBack *	onDisconnect (std::function< void()> lambda)
std::shared_ptr< std::function< void()> >	onConnectScoped (std::function< void()> lambda)
std::shared_ptr< std::function< void()> >	onDisconnectScoped (std::function< void()> lambda)
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)
void	removeOnChange (const BaseCallBack *callback)
void	removeOnInvalid (const BaseCallBack *callback)
void	removeOnConnect (const BaseCallBack *callback)
void	removeOnDisconnect (const BaseCallBack *callback)
void	readyUpdate ()
void	setIsReadyUpdater (std::function< bool()> updater)
Public Member Functions inherited from inviwo::Port
	Port (const Port &)=delete
Port &	operator= (const Port &)=delete
	Port (Port &&)=delete
Port &	operator= (Port &&)=delete
const std::string &	getIdentifier () const
void	setIdentifier (const std::string &name)
Processor *	getProcessor () const
std::string	getPath () const
	Get the port path i.e. <processor identifier>.<port identifier>.
void	getPath (std::pmr::string &out) const
const Document &	getHelp () const
Document &	getHelp ()
Port &	setHelp (Document help)
virtual void	serialize (Serializer &s) const override
virtual void	deserialize (Deserializer &d) override

Additional Inherited Members
Protected Member Functions inherited from inviwo::Inport
	Inport (std::string_view identifier, Document help)
bool	circularConnection (const Port *port) const
virtual void	invalidate (InvalidationLevel invalidationLevel)
virtual void	setValid (const Outport *source)
virtual void	setChanged (bool changed=true, const Outport *source=nullptr)
void	callOnChangeIfChanged () const
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 >	isReady_
StateCoordinator< bool >	isOptional_
std::vector< Outport * >	connectedOutports_
Protected Attributes inherited from inviwo::Port
std::string	identifier_
Processor *	processor_
Document	help_

Member Function Documentation

canConnectTo()

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

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.

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.

---

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

• pythoninport.h