sza::antenna::control::Encoder Class Reference

Objects of the following type are used to aggregate the encoder calibration parameters of each axis. More...

#include <carma/antenna/sza/antenna/control/Encoder.h>

Public Member Functions
double	convertCountsToSky (int count)
	Convert from encoder counts to radians on the sky. More...
void	convertMountToEncoder (double angle, double rate, PmacAxis *axis, int current, bool ignoreWrapLogic=true)
	Convert from radians to encoder values on a given axis. More...
	Encoder (sza::util::Axis::Type axis)
	Constructor. More...
sza::util::Axis::Type	getAxis ()
	Return the axis type of this encoder. More...
double	getMountMax ()
	Get the mount maximum. More...
double	getMountMin ()
	Get the mount minimum. More...
signed	getSlewRate ()
	Get the slew rate. More...
WrapMode::Mode	getWrapMode ()
	Method to get the requested wrap mode. More...
std::string	getWrapModeString ()
	Method to get the requested wrap mode as a string. More...
void	packCountsPerTurn (signed *s_elements)
	Pack this encoder multiplier for archival in the register database. More...
void	packLimits (signed *s_elements)
	Method for packing data to be archived in the register database. More...
void	packZero (signed *s_elements)
	Pack encoder zero points for archival in the register database. More...
void	reset ()
	Reset the parameters of this object. More...
void	setCountsPerRadian (double countsPerRadian)
	Set the counts per radian for this encoder. More...
void	setCountsPerTurn (int per_turn)
	Set the counts per turn for this encoder. More...
void	setLimits (long min, long max)
	Set the limits. More...
void	setSlewRate (long rate)
	Set the slew rate. More...
void	setWrapMode (WrapMode::Mode mode)
	Method to set a requested wrap mode (ignored if this is not the AZ axis) More...
void	setZero (double zero)
	Set the zero point of this encoder. More...
void	updateMountLimits ()
	Update the mount limits. More...

Detailed Description

Objects of the following type are used to aggregate the encoder calibration parameters of each axis.

Definition at line 24 of file Encoder.h.

Constructor & Destructor Documentation

sza::antenna::control::Encoder::Encoder

(

sza::util::Axis::Type

axis

)

Constructor.

Member Function Documentation

double sza::antenna::control::Encoder::convertCountsToSky

(

int

count

)

Convert from encoder counts to radians on the sky.

void sza::antenna::control::Encoder::convertMountToEncoder	(	double	angle,
		double	rate,
		PmacAxis *	axis,
		int	current,
		bool	ignoreWrapLogic = true
	)

Convert from radians to encoder values on a given axis.

sza::util::Axis::Type sza::antenna::control::Encoder::getAxis

(

)

Return the axis type of this encoder.

double sza::antenna::control::Encoder::getMountMax

(

)

Get the mount maximum.

double sza::antenna::control::Encoder::getMountMin

(

)

Get the mount minimum.

signed sza::antenna::control::Encoder::getSlewRate

(

)

Get the slew rate.

WrapMode::Mode sza::antenna::control::Encoder::getWrapMode

(

)

Method to get the requested wrap mode.

std::string sza::antenna::control::Encoder::getWrapModeString

(

)

Method to get the requested wrap mode as a string.

void sza::antenna::control::Encoder::packCountsPerTurn

(

signed *

s_elements

)

Pack this encoder multiplier for archival in the register database.

void sza::antenna::control::Encoder::packLimits

(

signed *

s_elements

)

Method for packing data to be archived in the register database.

void sza::antenna::control::Encoder::packZero

(

signed *

s_elements

)

Pack encoder zero points for archival in the register database.

void sza::antenna::control::Encoder::reset

(

)

Reset the parameters of this object.

void sza::antenna::control::Encoder::setCountsPerRadian

(

double

countsPerRadian

)

Set the counts per radian for this encoder.

void sza::antenna::control::Encoder::setCountsPerTurn

(

int

per_turn

)

Set the counts per turn for this encoder.

void sza::antenna::control::Encoder::setLimits	(	long	min,
		long	max
	)

Set the limits.

void sza::antenna::control::Encoder::setSlewRate

(

long

rate

)

Set the slew rate.

void sza::antenna::control::Encoder::setWrapMode

(

WrapMode::Mode

mode

)

Method to set a requested wrap mode (ignored if this is not the AZ axis)

void sza::antenna::control::Encoder::setZero

(

double

zero

)

Set the zero point of this encoder.

void sza::antenna::control::Encoder::updateMountLimits

(

)

Update the mount limits.

---

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

• carma/antenna/sza/antenna/control/Encoder.h