XDA communication factory. More...

#include <xdacommunicatorfactory.h>

Inheritance diagram for XdaCommunicatorFactory:

Public Member Functions
Communicator *	create (const XsPortInfo &portInfo) const
	Create a communicator based on a port info. More...

Communicator *	create (const XsString &filename) const
	Create a communicator based on a filename. More...

void	registerCommunicatorTypes () override
	Register the communicator types. More...

	XdaCommunicatorFactory ()
	Construct this factory. More...

Public Member Functions inherited from CommunicatorFactory
	CommunicatorFactory ()
	Create the factory. More...

Communicator *	create (const XsPortInfo &portInfo) const
	Create a communicator based on a port info. More...

Communicator *	create (const XsString &filename) const
	Create a communicator based on a filename. More...

bool	registerType (CommunicatorTypeId typeId, CommunicatorConstructFunc constructFunc, PortInfoMatchFunc matchFunc)
	Register a communicator type with the factory. More...

virtual	~CommunicatorFactory ()
	Destory the factory. More...

Protected Member Functions
virtual CommunicatorTypeId	filenameToCommunicatorId (const XsString &filename) const
	Match a filename to a communicator. More...

virtual CommunicatorTypeId	portInfoToCommunicatorId (const XsPortInfo &portInfo) const
	Match a XsPortInfo to a communicator. More...

Protected Member Functions inherited from CommunicatorFactory
virtual Communicator *	construct (CommunicatorTypeId communicator) const
	Construct a communicator based on typeId. More...

ConstructorsMap const &	constructors () const

Additional Inherited Members
Public Types inherited from CommunicatorFactory
typedef Communicator (	CommunicatorConstructFunc) ()
	The typedef of the communicator constructor function. More...

typedef unsigned int	CommunicatorTypeId
	The typedef of the communicator type ID. More...

typedef bool(*	PortInfoMatchFunc) (const XsPortInfo &)
	The typedef of the port info match function. More...

Static Public Member Functions inherited from CommunicatorFactory
template<typename T >
static std::unique_ptr< T >	createFactory ()
	Create a new CommunicatorFactory and register its basic types. More...

Protected Types inherited from CommunicatorFactory
typedef std::map< CommunicatorTypeId, std::pair< CommunicatorConstructFunc, PortInfoMatchFunc > >	ConstructorsMap
	The typedef of a map for a communicator type ID and constructors map. More...

Detailed Description

XDA communication factory.

Definition at line 70 of file xdacommunicatorfactory.h.

Constructor & Destructor Documentation

◆ XdaCommunicatorFactory()

XdaCommunicatorFactory::XdaCommunicatorFactory ( )

Construct this factory.

Definition at line 83 of file xdacommunicatorfactory.cpp.

Member Function Documentation

◆ create() [1/2]

Communicator * CommunicatorFactory::create

Create a communicator based on a port info.

Definition at line 88 of file communicatorfactory.cpp.

◆ create() [2/2]

Communicator * CommunicatorFactory::create

Create a communicator based on a filename.

Definition at line 96 of file communicatorfactory.cpp.

◆ filenameToCommunicatorId()

XdaCommunicatorFactory::CommunicatorTypeId XdaCommunicatorFactory::filenameToCommunicatorId ( const XsString & filename ) const

protectedvirtual

Match a filename to a communicator.

Parameters

filename A name of file

Returns: A communicator type ID

Implements CommunicatorFactory.

Definition at line 88 of file xdacommunicatorfactory.cpp.

◆ portInfoToCommunicatorId()

XdaCommunicatorFactory::CommunicatorTypeId XdaCommunicatorFactory::portInfoToCommunicatorId ( const XsPortInfo & portInfo ) const

protectedvirtual

Match a XsPortInfo to a communicator.

Parameters

portInfo An information about the port

Returns: A communicator type ID

Implements CommunicatorFactory.

Definition at line 99 of file xdacommunicatorfactory.cpp.

◆ registerCommunicatorTypes()

void XdaCommunicatorFactory::registerCommunicatorTypes ( )

overridevirtual

Register the communicator types.

Reimplemented from CommunicatorFactory.

Definition at line 128 of file xdacommunicatorfactory.cpp.

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

Public Member Functions

Protected Member Functions

Additional Inherited Members