Public Member Functions |
Static Public Member Functions |
Protected Member Functions |
List of all members
mitk::IGTL3DImageDeviceSource Class Reference
Connects a mitk::IGTLDevice to a MITK-OpenIGTLink-Message-Filter-Pipeline. More...
#include <mitkIGTL3DImageDeviceSource.h>
Inheritance diagram for mitk::IGTL3DImageDeviceSource:
Collaboration diagram for mitk::IGTL3DImageDeviceSource:
Public Member Functions | |
| mitkClassMacro (IGTL3DImageDeviceSource, IGTLDeviceSource) | |
| Pointer | Clone () const |
 Public Member Functions inherited from mitk::IGTLDeviceSource | |
| mitkClassMacro (IGTLDeviceSource, IGTLMessageSource) | |
| Pointer | Clone () const |
| virtual void | SetIGTLDevice (mitk::IGTLDevice *td) |
| sets the OpenIGTLink device that will be used as a data source More... | |
| virtual mitk::IGTLDevice * | GetIGTLDevice () |
| returns the OpenIGTLink device that is used by this filter More... | |
| void | RegisterAsMicroservice () override |
| Registers this object as a Microservice, making it available to every module and/or plugin. To unregister, call UnregisterMicroservice(). More... | |
| void | Connect () |
| Establishes a connection to the OpenIGTLink device. If there is already a connection the method does nothing. More... | |
| void | Disconnect () |
| Closes the connection to the OpenIGTLink device. More... | |
| void | StartCommunication () |
| starts the communication of the device. This needs to be called before Update() or GetOutput()->Update(). If the device is already communicating the method does nothing. More... | |
| void | StopCommunication () |
| stops the communication of the device. More... | |
| virtual bool | IsConnected () |
| returns true if a connection to the OpenIGTLink device is established More... | |
| virtual bool | IsCommunicating () |
| returns true if communication is in progress More... | |
| void | UpdateOutputInformation () override |
| Used for pipeline update. More... | |
| Public Member Functions inherited from mitk::IGTLMessageSource | |
| mitkClassMacroItkParent (IGTLMessageSource, itk::ProcessObject) | |
| virtual std::string | GetName () |
| virtual void | SetName (std::string _arg) |
| Sets the human readable name of this source. There is also a default name, but you can use this method if you need to define it on your own. More... | |
| virtual std::string | GetType () |
| virtual void | SetType (std::string _arg) |
| Sets the human readable type of this source. There will be a default type, or you can set the name with the method SetType(). You have to set this parameter otherwise it will not be found by the message provider. More... | |
| IGTLMessage * | GetOutput (void) |
| return the output (output with id 0) of the filter More... | |
| IGTLMessage * | GetOutput (DataObjectPointerArraySizeType idx) |
| return the output with id idx of the filter More... | |
| IGTLMessage * | GetOutput (const std::string &messageName) |
| return the output with name messageName of the filter More... | |
| DataObjectPointerArraySizeType | GetOutputIndex (std::string messageName) |
| return the index of the output with name messageName, -1 if no output with that name was found More... | |
| virtual void | UnRegisterMicroservice () |
| Registers this object as a Microservice, making it available to every module and/or plugin. More... | |
| std::string | GetMicroserviceID () |
| Returns the id that this device is registered with. The id will only be valid, if the IGTLMessageSource has been registered using RegisterAsMicroservice(). More... | |
| virtual void | GraftNthOutput (unsigned int idx, itk::DataObject *graft) |
| Graft the specified DataObject onto this ProcessObject's output. More... | |
| virtual void | GraftOutput (itk::DataObject *graft) |
| Graft the specified DataObject onto this ProcessObject's output. More... | |
| itk::DataObject::Pointer | MakeOutput (DataObjectPointerArraySizeType idx) override |
| itk::DataObject::Pointer | MakeOutput (const DataObjectIdentifierType &name) override |
| virtual void | SetParameters (const mitk::PropertyList *) |
| Set all filter parameters as the PropertyList p. More... | |
| virtual mitk::PropertyList::ConstPointer | GetParameters () const |
| Get all filter parameters as a PropertyList. More... | |
| void | SetFPS (unsigned int fps) |
| Sets the fps used for streaming this source. More... | |
| unsigned int | GetFPS () |
| Gets the fps used for streaming this source. More... | |
Static Public Member Functions | |
| static Pointer | New () |
| Static Public Member Functions inherited from mitk::IGTLDeviceSource | |
| static Pointer | New () |
Protected Member Functions | |
| IGTL3DImageDeviceSource () | |
| ~IGTL3DImageDeviceSource () override | |
| void | GenerateData () override |
| filter execute method More... | |
| Protected Member Functions inherited from mitk::IGTLDeviceSource | |
| IGTLDeviceSource () | |
| ~IGTLDeviceSource () override | |
| void | GenerateData () override |
| filter execute method More... | |
| void | CreateOutputs () |
| Create the necessary outputs for the m_IGTLDevice. More... | |
| virtual void | OnIncomingMessage () |
| This method is called when the IGTL device hold by this class receives a new message. More... | |
| virtual void | OnIncomingCommand () |
| This method is called when the IGTL device hold by this class receives a new command. More... | |
| virtual void | OnLostConnection () |
| This method is called when the IGTL device lost the connection to the other side. More... | |
| virtual void | RemoveObservers () |
| Removes all observers that listen to the igtl device. More... | |
| virtual void | SetInput (unsigned int idx, const IGTLMessage *msg) |
| Set input with id idx of this filter. More... | |
| const IGTLMessage * | GetInput (void) const |
| Get the input of this filter. More... | |
| const IGTLMessage * | GetInput (unsigned int idx) const |
| Get the input with id idx of this filter. More... | |
| const IGTLMessage * | GetInput (std::string msgName) const |
| Get the input with name messageName of this filter. More... | |
| DataObjectPointerArraySizeType | GetInputIndex (std::string msgName) |
| return the index of the input with name msgName, throw std::invalid_argument exception if that name was not found More... | |
| DataObjectPointerArraySizeType | GetOutputIndex (std::string msgName) |
| return the index of the output with name msgName, -1 if no output with that name was found More... | |
| Protected Member Functions inherited from mitk::IGTLMessageSource | |
| IGTLMessageSource () | |
| ~IGTLMessageSource () override | |
Additional Inherited Members | |
| Static Public Attributes inherited from mitk::IGTLDeviceSource | |
| static const std::string | US_PROPKEY_IGTLDEVICENAME |
| These Constants are used in conjunction with Microservices. More... | |
| Static Public Attributes inherited from mitk::IGTLMessageSource | |
| static const std::string | US_INTERFACE_NAME |
| These Constants are used in conjunction with Microservices. More... | |
| static const std::string | US_PROPKEY_DEVICENAME |
| static const std::string | US_PROPKEY_DEVICETYPE |
| static const std::string | US_PROPKEY_ID |
| static const std::string | US_PROPKEY_ISACTIVE |
| Protected Attributes inherited from mitk::IGTLDeviceSource | |
| mitk::IGTLDevice::Pointer | m_IGTLDevice |
| unsigned int | m_LostConnectionObserverTag |
| unsigned int | m_IncomingCommandObserverTag |
| unsigned int | m_IncomingMessageObserverTag |
| Protected Attributes inherited from mitk::IGTLMessageSource | |
| std::string | m_Name |
| std::string | m_Type |
| std::mutex | m_StreamingFPSMutex |
| unsigned int | m_StreamingFPS |
| us::ServiceRegistration< Self > | m_ServiceRegistration |
Detailed Description
Connects a mitk::IGTLDevice to a MITK-OpenIGTLink-Message-Filter-Pipeline.
This class is the source of most OpenIGTLink pipelines. It encapsulates a mitk::IGTLDevice and provides the information/messages of the connected OpenIGTLink devices as igtl::MessageBase objects. Note, that there is just one single output.
Definition at line 29 of file mitkIGTL3DImageDeviceSource.h.
Constructor & Destructor Documentation
◆ IGTL3DImageDeviceSource()
|
protected |
◆ ~IGTL3DImageDeviceSource()
|
overrideprotected |
Member Function Documentation
◆ Clone()
| Pointer mitk::IGTL3DImageDeviceSource::Clone | ( | ) | const |
◆ GenerateData()
|
overrideprotected |
filter execute method
queries the OpenIGTLink device for new messages and updates its output igtl::MessageBase objects with it.
- Warning
- Will raise a std::out_of_range exception, if tools were added to the OpenIGTLink device after it was set as input for this filter
◆ mitkClassMacro()
| mitk::IGTL3DImageDeviceSource::mitkClassMacro | ( | IGTL3DImageDeviceSource | , |
| IGTLDeviceSource | |||
| ) |
◆ New()
|
static |
The documentation for this class was generated from the following file:
