Pothos::Connectable Class Reference

#include <Connectable.hpp>

Inheritance diagram for Pothos::Connectable:

Public Member Functions
virtual	~Connectable (void)
	virtual destructor for inheritance More...
void	setName (const std::string &name)
const std::string &	getName (void) const
virtual std::vector< PortInfo >	inputPortInfo (void)=0
virtual std::vector< PortInfo >	outputPortInfo (void)=0
std::vector< std::string >	inputPortNames (void)
std::vector< std::string >	outputPortNames (void)
virtual Object	opaqueCallMethod (const std::string &name, const Object *inputArgs, const size_t numArgs) const =0
Public Member Functions inherited from Pothos::CallInterface
virtual	~CallInterface (void)
template<typename ReturnType , typename... ArgsType>
ReturnType	call (ArgsType &&...args) const
	Call a bound method/function with a return type and variable args. More...
template<typename... ArgsType>
Object	callObject (ArgsType &&...args) const
	Call a bound method/function with an Object return and variable args. More...
template<typename... ArgsType>
void	callVoid (ArgsType &&...args) const
	Call a bound method/function with a void return and variable args. More...
Public Member Functions inherited from Pothos::Util::UID
	UID (void)
	Default constructor. More...
const std::string &	uid (void) const
	Get the UID as a string. More...
Public Member Functions inherited from Pothos::Util::RefHolder
virtual	~RefHolder (void)
	Virtual destructor for derived classes. More...
void	holdRef (const Object &container)
	Store a copy of this object container. More...
void	dropRef (const Object &container)
	Drop a copy of this object container. More...

Additional Inherited Members
Protected Member Functions inherited from Pothos::CallRegistry
virtual	~CallRegistry (void)
	Virtual destructor for subclassing. More...
template<typename... ArgsType, typename ReturnType , typename ClassType , typename InstanceType >
void	registerCall (InstanceType *instance, const std::string &name, ReturnType(ClassType::*method)(ArgsType...))
template<typename... ArgsType, typename ReturnType , typename ClassType , typename InstanceType >
void	registerCall (InstanceType *instance, const std::string &name, ReturnType(ClassType::*method)(ArgsType...) const)
virtual void	registerCallable (const std::string &name, const Callable &call)=0
virtual	~CallInterface (void)
template<typename ReturnType , typename... ArgsType>
ReturnType	call (ArgsType &&...args) const
	Call a bound method/function with a return type and variable args. More...
template<typename... ArgsType>
Object	callObject (ArgsType &&...args) const
	Call a bound method/function with an Object return and variable args. More...
template<typename... ArgsType>
void	callVoid (ArgsType &&...args) const
	Call a bound method/function with a void return and variable args. More...
Protected Member Functions inherited from Pothos::Util::UID
	UID (void)
	Default constructor. More...
const std::string &	uid (void) const
	Get the UID as a string. More...
Protected Member Functions inherited from Pothos::Util::RefHolder
virtual	~RefHolder (void)
	Virtual destructor for derived classes. More...
void	holdRef (const Object &container)
	Store a copy of this object container. More...
void	dropRef (const Object &container)
	Drop a copy of this object container. More...

Detailed Description

Connectable interface for topological elements.

Constructor & Destructor Documentation

virtual Pothos::Connectable::~Connectable ( void  )

virtual

virtual destructor for inheritance

Member Function Documentation

const std::string& Pothos::Connectable::getName

(

void

)

const

Get the displayable name for this topology element.

Returns

the displayable name string

virtual std::vector<PortInfo> Pothos::Connectable::inputPortInfo ( void  )

pure virtual

Get a vector of info about all of the input ports available.

Implemented in Pothos::Topology, and Pothos::Block.

std::vector<std::string> Pothos::Connectable::inputPortNames

(

void

)

Get the names of the input ports available.

virtual Object Pothos::Connectable::opaqueCallMethod ( const std::string &  name, const Object *  inputArgs, const size_t  numArgs  ) const

pure virtual

Call a method on a derived instance of block with opaque input and return types.

Parameters

name	the name of the method as a string
inputArgs	an array of input arguments
numArgs	the size of the input array

Returns

the return value as type Object

Implemented in Pothos::Topology, and Pothos::Block.

virtual std::vector<PortInfo> Pothos::Connectable::outputPortInfo ( void  )

pure virtual

Get a vector of info about all of the output ports available.

Implemented in Pothos::Topology, and Pothos::Block.

std::vector<std::string> Pothos::Connectable::outputPortNames

(

void

)

Get the names of the output ports available.

void Pothos::Connectable::setName

(

const std::string &

name

)

Set a displayable name for this topology element. The name is a string to be used in debug outputs.

Parameters

name	a new displayable name

---

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

• include/Pothos/Framework/Connectable.hpp