ATEsystem_PIRIS::Factory Class Reference

More...

#include <ATEsystem.PIRIS.h>

Public Member Functions
	Factory (Factory const &)=delete
Factory &	operator= (Factory const &)=delete
	~Factory ()
DevID_t	CreateDevice (Mode mode=Mode::ETHERNET)
DevID_t	CreateDevice (const std::string &name, Mode mode)
IDevice *	GetDeviceInstance (DevID_t id)
std::string	GetDeviceName (DevID_t id)
Status	RemoveDevice (DevID_t id)

Static Public Member Functions
static Factory *	getInstance ()

Detailed Description

Factory class for manage PIRIS unique instances. Driver supports multiple opened PIRIS devices, that can be easily manipulated by unique DevID and IPiris Smart Pointer.

Constructor & Destructor Documentation

Factory()

ATEsystem_PIRIS::Factory::Factory ( Factory const &  )

delete

~Factory()

ATEsystem_PIRIS::Factory::~Factory ( )

inline

Member Function Documentation

CreateDevice() [1/2]

DevID_t ATEsystem_PIRIS::Factory::CreateDevice

(

Mode

mode = Mode::ETHERNET

)

Create a PIRIS device with random string name. Usually first method to call.

Parameters

mode	Mode - PIRIS device product type (SERIAL/ETHERNET)

Returns

Device unique id

CreateDevice() [2/2]

DevID_t ATEsystem_PIRIS::Factory::CreateDevice	(	const std::string &	name,
		Mode	mode
	)

Create a PIRIS device with specific string name. Usually first method to call.

Parameters

name	string name of created object

Parameters

mode	PIRIS device product type (SERIAL/ETHERNET)

Returns

PIRIS Device unique id

GetDeviceInstance()

IDevice * ATEsystem_PIRIS::Factory::GetDeviceInstance

(

DevID_t

id

)

Return Smart Pointer IPiris (IDevice). Usually call this when need to do any action with PIRIS.

Parameters

id	PIRIS Device unique id

Returns

Smart Pointer IPiris (IDevice)

GetDeviceName()

std::string ATEsystem_PIRIS::Factory::GetDeviceName

(

DevID_t

id

)

Return PIRIS device name, either random or specified string.

Parameters

id	PIRIS Device unique id

Returns

PIRIS device string name

getInstance()

static Factory* ATEsystem_PIRIS::Factory::getInstance ( )

inlinestatic

Return instance to singleton Factory class.

Returns

Factory class pointer

operator=()

Factory& ATEsystem_PIRIS::Factory::operator= ( Factory const &  )

delete

RemoveDevice()

Status ATEsystem_PIRIS::Factory::RemoveDevice

(

DevID_t

id

)

Remove PIRIS device. Usually call this, when driver is used to manipulate multiple PIRIS devices.

Parameters

id	PIRIS Device unique id

Returns

Status class

---

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

• ATEsystem.PIRIS-driver/ATEsystem.PIRIS-driver-Shared/include/ATEsystem.PIRIS.h
• ATEsystem.PIRIS-driver/ATEsystem.PIRIS-driver-Shared/src/ATEsystem.PIRIS.cpp