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

First generation implemenation (alta) of the ethernet interface. More...

#include <AltaEthernetIo.h>

Inheritance diagram for AltaEthernetIo:
Inheritance graph
Collaboration diagram for AltaEthernetIo:
Collaboration graph

Public Member Functions

 AltaEthernetIo (const std::string url)
 
virtual ~AltaEthernetIo ()
 
std::map< uint16_t, uint16_tReadRegs (const std::vector< uint16_t > &Regs)
 
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 SetupImgXfer (uint16_t Rows, uint16_t Cols, uint16_t NumOfImages, bool IsBulkSeq)
 
void CancelImgXfer ()
 
void GetImageData (std::vector< uint16_t > &data)
 
void GetStatus (CameraStatusRegs::AdvStatus &status)
 
void GetStatus (CameraStatusRegs::BasicStatus &status)
 
void GetMacAddress (std::string &Mac)
 
void Reboot ()
 
std::string GetNetworkSettings ()
 
std::string GetDriverVersion ()
 
uint16_t GetFirmwareRev ()
 
std::string GetInfo ()
 
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)
 
bool IsError ()
 
- Public Member Functions inherited from ICamIo
virtual ~ICamIo ()
 
- Public Member Functions inherited from IAltaSerialPortIo
virtual ~IAltaSerialPortIo ()=0
 

Private Member Functions

void OpenSession ()
 
void CloseSession ()
 
 AltaEthernetIo (const AltaEthernetIo &)
 
AltaEthernetIooperator= (AltaEthernetIo &)
 

Private Attributes

const std::string m_url
 
const std::string m_fileName
 
std::vector< uint16_tm_StatusRegs
 

Additional Inherited Members

- Protected Member Functions inherited from ICamIo
 ICamIo ()
 

Detailed Description

First generation implemenation (alta) of the ethernet interface.

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) 2009 Apogee Instruments, Inc.

Constructor & Destructor Documentation

◆ AltaEthernetIo() [1/2]

AltaEthernetIo::AltaEthernetIo ( const std::string  url)

◆ ~AltaEthernetIo()

AltaEthernetIo::~AltaEthernetIo ( )
virtual

◆ AltaEthernetIo() [2/2]

AltaEthernetIo::AltaEthernetIo ( const AltaEthernetIo )
private

Member Function Documentation

◆ CancelImgXfer()

void AltaEthernetIo::CancelImgXfer ( )
virtual

Cancel the pending image transfer.

Implements ICamIo.

◆ CloseSession()

void AltaEthernetIo::CloseSession ( )
private

◆ GetDriverVersion()

std::string AltaEthernetIo::GetDriverVersion ( )
virtual

Implements ICamIo.

◆ GetFirmwareRev()

uint16_t AltaEthernetIo::GetFirmwareRev ( )
virtual

Implements ICamIo.

◆ GetImageData()

void AltaEthernetIo::GetImageData ( std::vector< uint16_t > &  data)
virtual

Moves the data from the camera to the host PC. Called at different times depending on the cameras acquistion mode

Parameters
[in]NumberOfPixelsTotal number of pixels to transfer from the camera to host
Returns
ImageData Image from the camera

Implements ICamIo.

◆ GetInfo()

std::string AltaEthernetIo::GetInfo ( )
virtual

Implements ICamIo.

◆ GetMacAddress()

void AltaEthernetIo::GetMacAddress ( std::string &  Mac)

◆ GetNetworkSettings()

std::string AltaEthernetIo::GetNetworkSettings ( )

◆ GetSerialBaudRate()

uint32_t AltaEthernetIo::GetSerialBaudRate ( uint16_t  PortId)
virtual

Implements IAltaSerialPortIo.

◆ GetSerialFlowControl()

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

Implements IAltaSerialPortIo.

◆ GetSerialParity()

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

Implements IAltaSerialPortIo.

◆ GetStatus() [1/2]

void AltaEthernetIo::GetStatus ( CameraStatusRegs::AdvStatus status)
virtual

Fetches the camera's status. This function should be used on rev 16 firmware and higher

Parameters
[out]statusAdvanced status structure

Implements ICamIo.

◆ GetStatus() [2/2]

void AltaEthernetIo::GetStatus ( CameraStatusRegs::BasicStatus status)
virtual

Fetches the camera's status. This function should be used on rev 15 firmware or lower

Parameters
[out]statusBasic status structure

Implements ICamIo.

◆ IsError()

bool AltaEthernetIo::IsError ( )
inlinevirtual

Implements ICamIo.

◆ OpenSession()

void AltaEthernetIo::OpenSession ( )
private

◆ operator=()

AltaEthernetIo& AltaEthernetIo::operator= ( AltaEthernetIo )
private

◆ ReadReg()

uint16_t AltaEthernetIo::ReadReg ( uint16_t  reg) const
virtual

Reads camera control registers

Parameters
[in]regRegister to read.

Implements ICamIo.

◆ ReadRegs()

std::map< uint16_t, uint16_t > AltaEthernetIo::ReadRegs ( const std::vector< uint16_t > &  Regs)

◆ ReadSerial()

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

Implements IAltaSerialPortIo.

◆ Reboot()

void AltaEthernetIo::Reboot ( )

◆ SetSerialBaudRate()

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

Implements IAltaSerialPortIo.

◆ SetSerialFlowControl()

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

Implements IAltaSerialPortIo.

◆ SetSerialParity()

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

Implements IAltaSerialPortIo.

◆ SetupImgXfer()

void AltaEthernetIo::SetupImgXfer ( uint16_t  Rows,
uint16_t  Cols,
uint16_t  NumOfImages,
bool  IsBulkSeq 
)
virtual

Prime the IO interface for an upcoming image transfer.

Parameters
[in]RowsImage height in pixels
[in]ColsImage width in pixels
[in]NumOfImagesNumber of images in the set

Implements ICamIo.

◆ WriteMRMD()

void AltaEthernetIo::WriteMRMD ( uint16_t  reg,
const std::vector< uint16_t > &  data 
)
virtual

Writes data to a Multiple Request Multiple Data (MRMD) controller on the camera

Parameters
[in]regRegister to write to.
[out]dataData vector

Implements ICamIo.

◆ WriteReg()

void AltaEthernetIo::WriteReg ( uint16_t  reg,
uint16_t  val 
)
virtual

Writes data to camera control registers

Parameters
[in]regRegister to write to.
[out]valData value in the register

Implements ICamIo.

◆ WriteSerial()

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

Implements IAltaSerialPortIo.

◆ WriteSRMD()

void AltaEthernetIo::WriteSRMD ( uint16_t  reg,
const std::vector< uint16_t > &  data 
)
virtual

Writes data to a Single Request Multiple Data (SRMD) controller on the camera

Parameters
[in]regRegister to write to.
[out]dataData vector

Implements ICamIo.

Member Data Documentation

◆ m_fileName

const std::string AltaEthernetIo::m_fileName
private

◆ m_StatusRegs

std::vector<uint16_t> AltaEthernetIo::m_StatusRegs
private

◆ m_url

const std::string AltaEthernetIo::m_url
private

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