#include <ATEsystem.PIRIS.h>

Inheritance diagram for ATEsystem_PIRIS::CPirisMain:

Public Member Functions
Status	Open (void *dev, PirisDeviceType type, VerboseLevel verbose=VerboseLevel::NONE)

Status	Open (const PirisDevice &dev, VerboseLevel verbose=VerboseLevel::NONE)

Status	Close ()

std::tuple< StatusEx, DataID >	ReadID ()

std::tuple< StatusEx, DataPosition >	ReadPosition ()

std::tuple< StatusEx, DataParams >	ReadParams ()

std::tuple< StatusEx, DataState >	ReadState ()

StatusEx	DevReset ()

StatusEx	DevHoming ()

StatusEx	SetAbsolute (uint16_t focus=0, uint16_t zoom=0, uint16_t iris=0, bool ir_filter=false)

StatusEx	SetAbsolute (const FocusZoomIris< uint16_t > &values, bool ir_filter=false)

StatusEx	SetRelative (int16_t focus=0, int16_t zoom=0, int16_t iris=0)

StatusEx	SetRelative (const FocusZoomIris< int16_t > &values)

YesNoNA	GetFwPollSupport ()

VerboseLevel	GetVerboseLevel ()

void	SetVerboseLevel (VerboseLevel level)

	CPirisMain ()

virtual	~CPirisMain ()

Static Public Member Functions
static int16_t	ScanEthernet (std::vector< Pylon::CDeviceInfo > &devices, bool verbose=false)

static int16_t	ScanSerial (std::vector< serial::PortInfo > &devices, bool verbose=false)

Protected Member Functions
void	state_set (State _state)

State	state_get ()

bool	state_is (State _state)

void	state_reset ()

bool	verbose_is (VerboseLevel _verbose)

void	verbose_set (VerboseLevel _verbose)

Protected Attributes
uint16_t	rx_timeout = RX_TIMEOUT_NEW_FW

Detailed Description

Main abstract class with all key functionality, need to have overridden comm func in derived class.

Constructor & Destructor Documentation

◆ CPirisMain()

ATEsystem_PIRIS::CPirisMain::CPirisMain ( )

◆ ~CPirisMain()

virtual ATEsystem_PIRIS::CPirisMain::~CPirisMain ( )

inlinevirtual

Member Function Documentation

◆ Close()

Status ATEsystem_PIRIS::CPirisMain::Close ( )

◆ DevHoming()

StatusEx ATEsystem_PIRIS::CPirisMain::DevHoming ( )

◆ DevReset()

StatusEx ATEsystem_PIRIS::CPirisMain::DevReset ( )

◆ GetFwPollSupport()

YesNoNA ATEsystem_PIRIS::CPirisMain::GetFwPollSupport ( )

◆ GetVerboseLevel()

VerboseLevel ATEsystem_PIRIS::CPirisMain::GetVerboseLevel ( )

◆ Open() [1/2]

Status ATEsystem_PIRIS::CPirisMain::Open	(	void *	dev,
		PirisDeviceType	type,
		VerboseLevel	verbose = `VerboseLevel::NONE`
	)

◆ Open() [2/2]

Status ATEsystem_PIRIS::CPirisMain::Open	(	const PirisDevice &	dev,
		VerboseLevel	verbose = `VerboseLevel::NONE`
	)

◆ ReadID()

std::tuple< StatusEx, DataID > ATEsystem_PIRIS::CPirisMain::ReadID ( )

◆ ReadParams()

std::tuple< StatusEx, DataParams > ATEsystem_PIRIS::CPirisMain::ReadParams ( )

◆ ReadPosition()

std::tuple< StatusEx, DataPosition > ATEsystem_PIRIS::CPirisMain::ReadPosition ( )

◆ ReadState()

std::tuple< StatusEx, DataState > ATEsystem_PIRIS::CPirisMain::ReadState ( )

◆ ScanEthernet()

int16_t ATEsystem_PIRIS::CPirisMain::ScanEthernet	(	std::vector< Pylon::CDeviceInfo > &	devices,
		bool	verbose = `false`
	)

static

◆ ScanSerial()

int16_t ATEsystem_PIRIS::CPirisMain::ScanSerial	(	std::vector< serial::PortInfo > &	devices,
		bool	verbose = `false`
	)

static

◆ SetAbsolute() [1/2]

StatusEx ATEsystem_PIRIS::CPirisMain::SetAbsolute	(	uint16_t	focus = `0`,
		uint16_t	zoom = `0`,
		uint16_t	iris = `0`,
		bool	ir_filter = `false`
	)

◆ SetAbsolute() [2/2]

StatusEx ATEsystem_PIRIS::CPirisMain::SetAbsolute	(	const FocusZoomIris< uint16_t > &	values = `FocusZoomIris<uint16_t>(0, 0, 0)`,
		bool	ir_filter = `false`
	)

◆ SetRelative() [1/2]

StatusEx ATEsystem_PIRIS::CPirisMain::SetRelative	(	int16_t	focus = `0`,
		int16_t	zoom = `0`,
		int16_t	iris = `0`
	)

◆ SetRelative() [2/2]

StatusEx ATEsystem_PIRIS::CPirisMain::SetRelative ( const FocusZoomIris< int16_t > & values = FocusZoomIris<int16_t>(0, 0, 0) )

◆ SetVerboseLevel()

void ATEsystem_PIRIS::CPirisMain::SetVerboseLevel ( VerboseLevel level )

◆ state_get()

State ATEsystem_PIRIS::CPirisMain::state_get ( )

protected

◆ state_is()

bool ATEsystem_PIRIS::CPirisMain::state_is ( State _state )

protected

◆ state_reset()

void ATEsystem_PIRIS::CPirisMain::state_reset ( )

protected

◆ state_set()

void ATEsystem_PIRIS::CPirisMain::state_set ( State _state )

protected

◆ verbose_is()

bool ATEsystem_PIRIS::CPirisMain::verbose_is ( VerboseLevel _verbose )

protected

◆ verbose_set()

void ATEsystem_PIRIS::CPirisMain::verbose_set ( VerboseLevel _verbose )

protected

Member Data Documentation

◆ rx_timeout

uint16_t ATEsystem_PIRIS::CPirisMain::rx_timeout = RX_TIMEOUT_NEW_FW

protected

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

ATEsystem.PIRIS-driver: ATEsystem_PIRIS::CPirisMain Class Reference

ATEsystem.PIRIS

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CPirisMain()

◆ ~CPirisMain()

Member Function Documentation

◆ Close()

◆ DevHoming()

◆ DevReset()

◆ GetFwPollSupport()

◆ GetVerboseLevel()

◆ Open() [1/2]

◆ Open() [2/2]

◆ ReadID()

◆ ReadParams()

◆ ReadPosition()

◆ ReadState()

◆ ScanEthernet()

◆ ScanSerial()

◆ SetAbsolute() [1/2]

◆ SetAbsolute() [2/2]

◆ SetRelative() [1/2]

◆ SetRelative() [2/2]

◆ SetVerboseLevel()

◆ state_get()

◆ state_is()

◆ state_reset()

◆ state_set()

◆ verbose_is()

◆ verbose_set()

Member Data Documentation

◆ rx_timeout

Get in touch