blockfactory::core Namespace Reference

Classes
class	Block
	Basic abstract class for wrapping generic algorithms. More...
class	BlockInformation
	Abstract class for storing generic core::Block properties. More...
class	ClassFactorySingleton
	Class for interfacing with shlibpp plugin library. More...
class	Log
	Class for handling log messages. More...
class	Parameter
	Class for storing a generic parameter. More...
class	ParameterMetadata
	Class for storing parameter metadata. More...
class	Parameters
	Class for storing block's parameters. More...
class	Port
	Class that stores port properties. More...
class	Signal
	Class to access data shared by blocks, represented as signals. More...

Typedefs
using	InputPortsInfo = std::vector< Port::Info >
using	OutputPortsInfo = std::vector< Port::Info >
using	InputSignalPtr = std::shared_ptr< const blockfactory::core::Signal >
using	OutputSignalPtr = std::shared_ptr< blockfactory::core::Signal >

Enumerations
enum	ParameterType {   ParameterType::INT, ParameterType::BOOL, ParameterType::DOUBLE, ParameterType::STRING,   ParameterType::CELL_INT, ParameterType::CELL_BOOL, ParameterType::CELL_DOUBLE, ParameterType::CELL_STRING,   ParameterType::STRUCT_INT, ParameterType::STRUCT_BOOL, ParameterType::STRUCT_DOUBLE, ParameterType::STRUCT_STRING,   ParameterType::STRUCT_CELL_INT, ParameterType::STRUCT_CELL_BOOL, ParameterType::STRUCT_CELL_DOUBLE, ParameterType::STRUCT_CELL_STRING }
	Defines the types of parameters supported by core::Parameter. More...

Functions
template<typename Tin , typename Tout >
void	convertStdVector (const std::vector< Tin > &input, std::vector< Tout > &output)
template<>
void	convertStdVector< std::string, int > (const std::vector< std::string > &input, std::vector< int > &output)
template<>
void	convertStdVector< std::string, bool > (const std::vector< std::string > &input, std::vector< bool > &output)
template<>
void	convertStdVector< std::string, double > (const std::vector< std::string > &input, std::vector< double > &output)
template<>
void	convertStdVector< int, std::string > (const std::vector< int > &input, std::vector< std::string > &output)
template<>
void	convertStdVector< bool, std::string > (const std::vector< bool > &input, std::vector< std::string > &output)
template<>
void	convertStdVector< double, std::string > (const std::vector< double > &input, std::vector< std::string > &output)
template<>
bool	Parameters::getParameter< std::string > (const Parameters::ParamName &name, std::string &param) const
template bool	Parameters::getParameter< std::string > (const Parameters::ParamName &name, std::vector< std::string > &param) const
template<>
bool	Parameters::storeParameter< std::string > (const std::string &param, const ParameterMetadata &paramMetadata)
template bool	Parameters::storeParameter< std::string > (const std::vector< std::string > &param, const ParameterMetadata &paramMetadata)
template bool	Parameters::storeParameter< std::string > (const Parameter< std::string > &parameter)

Variables
const std::string	BlockOptionPrioritizeOrder = "wbt.BlockOptionPrioritizeOrder"
const int	PARAM_INVALID_INDEX = -1
const std::string	PARAM_INVALID_NAME = {}

Typedef Documentation

using blockfactory::core::InputPortsInfo = typedef std::vector<Port::Info>

using blockfactory::core::InputSignalPtr = typedef std::shared_ptr<const blockfactory::core::Signal>

using blockfactory::core::OutputPortsInfo = typedef std::vector<Port::Info>

using blockfactory::core::OutputSignalPtr = typedef std::shared_ptr<blockfactory::core::Signal>

Enumeration Type Documentation

enum blockfactory::core::ParameterType

strong

Defines the types of parameters supported by core::Parameter.

See also

core::ParameterMetadata, core::Parameter

Enumerator
INT
BOOL
DOUBLE
STRING
CELL_INT
CELL_BOOL
CELL_DOUBLE
CELL_STRING
STRUCT_INT
STRUCT_BOOL
STRUCT_DOUBLE
STRUCT_STRING
STRUCT_CELL_INT
STRUCT_CELL_BOOL
STRUCT_CELL_DOUBLE
STRUCT_CELL_STRING

Function Documentation

template<typename Tin , typename Tout >

void blockfactory::core::convertStdVector	(	const std::vector< Tin > &	input,
		std::vector< Tout > &	output
	)

template<>

void blockfactory::core::convertStdVector< bool, std::string >	(	const std::vector< bool > &	input,
		std::vector< std::string > &	output
	)

template<>

void blockfactory::core::convertStdVector< double, std::string >	(	const std::vector< double > &	input,
		std::vector< std::string > &	output
	)

template<>

void blockfactory::core::convertStdVector< int, std::string >	(	const std::vector< int > &	input,
		std::vector< std::string > &	output
	)

template<>

void blockfactory::core::convertStdVector< std::string, bool >	(	const std::vector< std::string > &	input,
		std::vector< bool > &	output
	)

template<>

void blockfactory::core::convertStdVector< std::string, double >	(	const std::vector< std::string > &	input,
		std::vector< double > &	output
	)

template<>

void blockfactory::core::convertStdVector< std::string, int >	(	const std::vector< std::string > &	input,
		std::vector< int > &	output
	)

template<>

bool blockfactory::core::Parameters::getParameter< std::string >	(	const Parameters::ParamName &	name,
		std::string &	param
	)		const

template bool blockfactory::core::Parameters::getParameter< std::string >	(	const Parameters::ParamName &	name,
		std::vector< std::string > &	param
	)		const

template<>

bool blockfactory::core::Parameters::storeParameter< std::string >	(	const std::string &	param,
		const ParameterMetadata &	paramMetadata
	)

template bool blockfactory::core::Parameters::storeParameter< std::string >	(	const std::vector< std::string > &	param,
		const ParameterMetadata &	paramMetadata
	)

template bool blockfactory::core::Parameters::storeParameter< std::string >

(

const Parameter< std::string > &

parameter

)

Variable Documentation

const std::string blockfactory::core::BlockOptionPrioritizeOrder = "wbt.BlockOptionPrioritizeOrder"

const int blockfactory::core::PARAM_INVALID_INDEX = -1

const std::string blockfactory::core::PARAM_INVALID_NAME = {}