TwiceAsNice  2019-02-18
Classes | Public Member Functions | Private Member Functions | Private Attributes | List of all members
AltaUsbIo Class Reference

class for managing the AltaU series IO More...

#include <AltaUsbIo.h>

Inheritance diagram for AltaUsbIo:
Inheritance graph
Collaboration diagram for AltaUsbIo:
Collaboration graph

Classes

struct  SerialPortSettings
 

Public Member Functions

 AltaUsbIo (const std::string &DeviceEnum)
 
 ~AltaUsbIo ()
 
void Program (const std::string &FilenameCamCon, const std::string &FilenameBufCon, const std::string &FilenameFx2, const std::string &FilenameGpifCamCon, const std::string &FilenameGpifBufCon, const std::string &FilenameGpifFifo, bool Print2StdOut=false)
 
void ReadHeader (Eeprom::Header &hdr)
 
void SetSerialNumber (const std::string &num)
 
std::string GetSerialNumber ()
 
void SetSerialBaudRate (uint16_t PortId, uint32_t BaudRate)
 
uint32_t GetSerialBaudRate (uint16_t PortId)
 
Apg::SerialFC GetSerialFlowControl (uint16_t PortId)
 
void SetSerialFlowControl (uint16_t PortId, Apg::SerialFC FlowControl)
 
Apg::SerialParity GetSerialParity (uint16_t PortId)
 
void SetSerialParity (uint16_t PortId, Apg::SerialParity Parity)
 
void ReadSerial (uint16_t PortId, std::string &buffer)
 
void WriteSerial (uint16_t PortId, const std::string &buffer)
 
- Public Member Functions inherited from CamUsbIo
virtual ~CamUsbIo ()
 
uint16_t ReadReg (uint16_t reg) const
 
void WriteReg (uint16_t reg, uint16_t val)
 
void WriteSRMD (uint16_t reg, const std::vector< uint16_t > &data)
 
void WriteMRMD (uint16_t reg, const std::vector< uint16_t > &data)
 
void GetUsbVendorInfo (uint16_t &VendorId, uint16_t &ProductId, uint16_t &DeviceId)
 
std::string GetUsbFirmwareVersion ()
 
void SetupImgXfer (uint16_t Rows, uint16_t Cols, uint16_t NumOfImages, bool IsBulkSeq)
 
void CancelImgXfer ()
 
void GetImageData (std::vector< uint16_t > &data)
 
void GetStatus (CameraStatusRegs::BasicStatus &status)
 
void GetStatus (CameraStatusRegs::AdvStatus &status)
 
uint16_t GetFirmwareRev ()
 
std::string GetInfo ()
 
uint8_t ReadBufConReg (uint16_t reg)
 
void WriteBufConReg (uint16_t reg, uint8_t val)
 
uint8_t ReadFx2Reg (uint16_t reg)
 
void WriteFx2Reg (uint16_t reg, uint8_t val)
 
uint32_t GetMaxXferBufSize ()
 
std::string GetDriverVersion ()
 
bool IsError ()
 
- Public Member Functions inherited from ICamIo
virtual ~ICamIo ()
 
- Public Member Functions inherited from IAltaSerialPortIo
virtual ~IAltaSerialPortIo ()=0
 

Private Member Functions

AltaUsbIo::SerialPortSettings ReadSerialSettings (uint16_t PortId)
 
void WriteSerialSettings (uint16_t PortId, AltaUsbIo::SerialPortSettings &settings)
 
void DownloadFirmware ()
 
void IncrEepromAddrBlockBank (uint16_t IncrSize, uint16_t &Addr, uint8_t &Bank, uint8_t &Block)
 

Private Attributes

std::string m_fileName
 

Additional Inherited Members

- Protected Member Functions inherited from CamUsbIo
 CamUsbIo (const std::string &DeviceEnum, uint32_t MaxBufSize, bool ApplyPad)
 
void Progress2StdOut (const int32_t percentComplete)
 
int32_t GetPadding (const int32_t Num)
 
- Protected Member Functions inherited from ICamIo
 ICamIo ()
 
- Protected Attributes inherited from CamUsbIo
bool m_Print2StdOut
 
std::shared_ptr< IUsbm_Usb
 
const std::string m_fileName
 
bool m_ApplyPadding
 
uint32_t m_MaxBufSize
 

Detailed Description

class for managing the AltaU series IO

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

Copyright(c) 2012 Apogee Imaging Systems, Inc.

Constructor & Destructor Documentation

◆ AltaUsbIo()

AltaUsbIo::AltaUsbIo ( const std::string &  DeviceEnum)

◆ ~AltaUsbIo()

AltaUsbIo::~AltaUsbIo ( )

Member Function Documentation

◆ DownloadFirmware()

void AltaUsbIo::DownloadFirmware ( )
private

◆ GetSerialBaudRate()

uint32_t AltaUsbIo::GetSerialBaudRate ( uint16_t  PortId)
virtual

Implements IAltaSerialPortIo.

◆ GetSerialFlowControl()

Apg::SerialFC AltaUsbIo::GetSerialFlowControl ( uint16_t  PortId)
virtual

Implements IAltaSerialPortIo.

◆ GetSerialNumber()

std::string AltaUsbIo::GetSerialNumber ( )
virtual

Implements CamUsbIo.

◆ GetSerialParity()

Apg::SerialParity AltaUsbIo::GetSerialParity ( uint16_t  PortId)
virtual

Implements IAltaSerialPortIo.

◆ IncrEepromAddrBlockBank()

void AltaUsbIo::IncrEepromAddrBlockBank ( uint16_t  IncrSize,
uint16_t Addr,
uint8_t Bank,
uint8_t Block 
)
private

◆ Program()

void AltaUsbIo::Program ( const std::string &  FilenameCamCon,
const std::string &  FilenameBufCon,
const std::string &  FilenameFx2,
const std::string &  FilenameGpifCamCon,
const std::string &  FilenameGpifBufCon,
const std::string &  FilenameGpifFifo,
bool  Print2StdOut = false 
)

◆ ReadHeader()

void AltaUsbIo::ReadHeader ( Eeprom::Header hdr)
virtual

Implements CamUsbIo.

◆ ReadSerial()

void AltaUsbIo::ReadSerial ( uint16_t  PortId,
std::string &  buffer 
)
virtual

Implements IAltaSerialPortIo.

◆ ReadSerialSettings()

AltaUsbIo::SerialPortSettings AltaUsbIo::ReadSerialSettings ( uint16_t  PortId)
private

◆ SetSerialBaudRate()

void AltaUsbIo::SetSerialBaudRate ( uint16_t  PortId,
uint32_t  BaudRate 
)
virtual

Implements IAltaSerialPortIo.

◆ SetSerialFlowControl()

void AltaUsbIo::SetSerialFlowControl ( uint16_t  PortId,
Apg::SerialFC  FlowControl 
)
virtual

Implements IAltaSerialPortIo.

◆ SetSerialNumber()

void AltaUsbIo::SetSerialNumber ( const std::string &  num)
virtual

Implements CamUsbIo.

◆ SetSerialParity()

void AltaUsbIo::SetSerialParity ( uint16_t  PortId,
Apg::SerialParity  Parity 
)
virtual

Implements IAltaSerialPortIo.

◆ WriteSerial()

void AltaUsbIo::WriteSerial ( uint16_t  PortId,
const std::string &  buffer 
)
virtual

Implements IAltaSerialPortIo.

◆ WriteSerialSettings()

void AltaUsbIo::WriteSerialSettings ( uint16_t  PortId,
AltaUsbIo::SerialPortSettings settings 
)
private

Member Data Documentation

◆ m_fileName

std::string AltaUsbIo::m_fileName
private

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