SeaBreeze
Public Member Functions
seabreeze::IrradCalProtocolInterface Class Referenceabstract
Inheritance diagram for seabreeze::IrradCalProtocolInterface:
Inheritance graph
Collaboration diagram for seabreeze::IrradCalProtocolInterface:
Collaboration graph

Public Member Functions

 IrradCalProtocolInterface (Protocol *protocol)
 
virtual std::vector< float > * readIrradCal (const Bus &bus)=0 throw (ProtocolException)
 
virtual int writeIrradCal (const Bus &bus, const std::vector< float > &cal)=0 throw (ProtocolException)
 
virtual int hasCollectionArea (const Bus &bus)=0
 
virtual float readCollectionArea (const Bus &bus)=0 throw (ProtocolException)
 
virtual void writeCollectionArea (const Bus &bus, float area)=0 throw (ProtocolException)
 
- Public Member Functions inherited from seabreeze::ProtocolHelper
 ProtocolHelper (Protocol *proto)
 
ProtocolgetProtocol ()
 

Additional Inherited Members

- Protected Attributes inherited from seabreeze::ProtocolHelper
Protocolprotocol
 

Member Function Documentation

◆ readIrradCal()

virtual std::vector<float>* seabreeze::IrradCalProtocolInterface::readIrradCal ( const Bus bus)
throw (ProtocolException
)
pure virtual

Get the irradiance calibration from the device.

Implemented in seabreeze::ooiProtocol::OOIIrradCalProtocol, and seabreeze::oceanBinaryProtocol::OBPIrradCalProtocol.

◆ writeIrradCal()

virtual int seabreeze::IrradCalProtocolInterface::writeIrradCal ( const Bus bus,
const std::vector< float > &  cal 
)
throw (ProtocolException
)
pure virtual

Write a new irradiance calibration to the device.

Implemented in seabreeze::ooiProtocol::OOIIrradCalProtocol, and seabreeze::oceanBinaryProtocol::OBPIrradCalProtocol.

◆ hasCollectionArea()

virtual int seabreeze::IrradCalProtocolInterface::hasCollectionArea ( const Bus bus)
pure virtual

Determine whether the device has a stored irradiance collection area. This will trap any exceptions so it is always safe to call.

Implemented in seabreeze::ooiProtocol::OOIIrradCalProtocol, and seabreeze::oceanBinaryProtocol::OBPIrradCalProtocol.

◆ readCollectionArea()

virtual float seabreeze::IrradCalProtocolInterface::readCollectionArea ( const Bus bus)
throw (ProtocolException
)
pure virtual

Get the irradiance collection area from the device.

Implemented in seabreeze::ooiProtocol::OOIIrradCalProtocol, and seabreeze::oceanBinaryProtocol::OBPIrradCalProtocol.

◆ writeCollectionArea()

virtual void seabreeze::IrradCalProtocolInterface::writeCollectionArea ( const Bus bus,
float  area 
)
throw (ProtocolException
)
pure virtual

Write a new irradiance collection area to the device.

Implemented in seabreeze::ooiProtocol::OOIIrradCalProtocol, and seabreeze::oceanBinaryProtocol::OBPIrradCalProtocol.


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