Inviwo 0.9.12-pre
Inviwo documentation
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Attributes | List of all members
inviwo::DataOutport< T > Class Template Reference
Ports

#include <dataoutport.h>

+ Inheritance diagram for inviwo::DataOutport< T >:

Public Types

using type = T
 
- Public Types inherited from inviwo::OutportIterableImpl< DataOutport< T >, T >
using Container
 
using const_iterator
 

Public Member Functions

 DataOutport (std::string_view identifier, Document help={})
 
virtual std::string getClassIdentifier () const override
 
virtual glm::uvec3 getColorCode () const override
 
virtual Document getInfo () const override
 
virtual std::shared_ptr< const T > getData () const
 
virtual std::shared_ptr< const T > detachData ()
 
virtual void clear () override
 
virtual void setData (std::shared_ptr< const T > data)
 
virtual void setData (const T *data)
 
template<typename U = T, typename = std::enable_if_t<std::is_move_constructible_v<U>>>
void setData (T &&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
 
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>
 
const Document & getHelp () const
 
Document & getHelp ()
 
Port & setHelp (Document help)
 
virtual void serialize (Serializer &s) const override
 
virtual void deserialize (Deserializer &d) override
 
- Public Member Functions inherited from inviwo::Serializable
- Public Member Functions inherited from inviwo::OutportIterableImpl< DataOutport< T >, T >
virtual const_iterator begin () const override
 
virtual const_iterator end () const override
 
- Public Member Functions inherited from inviwo::OutportIterable< T >

Protected Attributes

std::shared_ptr< const T > data_
 
- 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_
 
Processor * processor_
 
Document help_
 

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)
 

Detailed Description

template<typename T>
class inviwo::DataOutport< T >

DataOutport hold data of type T

Member Function Documentation

◆ clear()

template<typename T >
void inviwo::DataOutport< T >::clear ( )
overridevirtual

Clear the outport of any data

Implements inviwo::Outport.

Reimplemented in inviwo::ImageOutport.

◆ detachData()

template<typename T >
std::shared_ptr< const T > inviwo::DataOutport< T >::detachData ( )
virtual

Return data and release ownership. Data in the port will be nullptr after call.

Reimplemented in inviwo::ImageOutport.

◆ getClassIdentifier()

template<typename T >
std::string inviwo::DataOutport< T >::getClassIdentifier ( ) const
overridevirtual

Implements inviwo::Port.

◆ getColorCode()

template<typename T >
glm::uvec3 inviwo::DataOutport< T >::getColorCode ( ) const
overridevirtual

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()

template<typename T >
Document inviwo::DataOutport< T >::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.

Reimplemented in inviwo::ImageOutport.

◆ hasData()

template<typename T >
bool inviwo::DataOutport< T >::hasData ( ) const
overridevirtual

Query if the outport has any data

Implements inviwo::Outport.

◆ setData()

template<typename T >
template<typename , typename >
void inviwo::DataOutport< T >::setData ( T && data)

Pass data along to the port using the Move constructor. Example:

++
void SomePorcessor::process() {
std::vector<vec3> points;
myPort_.setData(std::move(points));
}
The documentation for this class was generated from the following files: