TwiceAsNice  2019-02-18
Enumerations | Functions | Variables
Pulsar2Commands Namespace Reference

Enumerations

enum  PECorrection { PECorrectionOff = 0, PECorrectionOn = 1 }
 
enum  RCorrection { RCorrectionOff = 0, RCorrectionOn = 1 }
 
enum  SideOfPier { EastOfPier = 0, WestOfPier = 1 }
 
enum  PoleCrossing { PoleCrossingOff = 0, PoleCrossingOn = 1 }
 
enum  SlewMode {
  SlewMax = 0, SlewFind, SlewCenter, SlewGuide,
  NumSlewRates
}
 
enum  Direction {
  North = 0, East, South, West,
  NumDirections
}
 

Functions

int ACK (const int fd)
 
void resynchronize (const int fd)
 
bool send (const int fd, const char *cmd)
 
bool confirmed (const int fd, const char *cmd, char &response)
 
bool receive (const int fd, char response[])
 
bool getString (const int fd, const char *cmd, char response[])
 
bool getVersion (const int fd, char response[])
 
bool getPECorrection (const int fd, PECorrection *PECra, PECorrection *PECdec)
 
bool getRCorrection (const int fd, RCorrection *Rra, RCorrection *Rdec)
 
bool getInt (const int fd, const char *cmd, int *value)
 
bool getSideOfPier (const int fd, SideOfPier *side_of_pier)
 
bool getPoleCrossing (const int fd, PoleCrossing *pole_crossing)
 
bool getSexa (const int fd, const char *cmd, double *value)
 
bool getObjectRADec (const int fd, double *ra, double *dec)
 
bool getDegreesMinutes (const int fd, const char *cmd, int *d, int *m)
 
bool getSiteLatitude (const int fd, int *d, int *m)
 
bool getSiteLongitude (const int fd, int *d, int *m)
 
bool getUTCDate (const int fd, int *m, int *d, int *y)
 
bool getUTCTime (const int fd, int *h, int *m, int *s)
 
bool setDegreesMinutes (const int fd, const char *cmd, const double value)
 
bool setSite (const int fd, const double longitude, const double latitude)
 
bool setSlewMode (const int fd, const SlewMode slewMode)
 
bool moveTo (const int fd, const Direction direction)
 
bool haltMovement (const int fd, const Direction direction)
 
bool startSlew (const int fd)
 
bool abortSlew (const int fd)
 
bool pulseGuide (const int fd, const Direction direction, const float ms)
 
bool setTime (const int fd, const int h, const int m, const int s)
 
bool setDate (const int fd, const int dd, const int mm, const int yy)
 
bool ensureLongFormat (const int fd)
 
bool setObjectRA (const int fd, const double ra)
 
bool setObjectDEC (const int fd, const double dec)
 
bool setObjectRADec (const int fd, const double ra, const double dec)
 
bool park (const int fd)
 
bool unpark (const int fd)
 
bool sync (const int fd)
 
bool setSideOfPier (const int fd, const SideOfPier side_of_pier)
 
bool setPECorrection (const int fd, const PECorrection pec_ra, const PECorrection pec_dec)
 
bool setPoleCrossing (const int fd, const PoleCrossing pole_crossing)
 
bool setRCorrection (const int fd, const RCorrection rc_ra, const RCorrection rc_dec)
 
bool isHomeSet (const int fd)
 
bool isParked (const int fd)
 
bool isParking (const int fd)
 

Variables

static constexpr int TimeOut = 1
 
static constexpr int BufferSize = 32
 
static constexpr int MaxAttempts = 3
 
static constexpr char Null = '\0'
 
static constexpr char Acknowledge = '\006'
 
static constexpr char Termination = '#'
 
static bool resynchronize_needed
 
static const char * DirectionName [NumDirections] = { "North", "East", "South", "West" }
 
static const char OnOff [2] = { '0', '1' }
 

Enumeration Type Documentation

◆ Direction

Enumerator
North 
East 
South 
West 
NumDirections 

◆ PECorrection

Enumerator
PECorrectionOff 
PECorrectionOn 

◆ PoleCrossing

Enumerator
PoleCrossingOff 
PoleCrossingOn 

◆ RCorrection

Enumerator
RCorrectionOff 
RCorrectionOn 

◆ SideOfPier

Enumerator
EastOfPier 
WestOfPier 

◆ SlewMode

Enumerator
SlewMax 
SlewFind 
SlewCenter 
SlewGuide 
NumSlewRates 

Function Documentation

◆ abortSlew()

bool Pulsar2Commands::abortSlew ( const int  fd)
inline

◆ ACK()

int Pulsar2Commands::ACK ( const int  fd)

◆ confirmed()

bool Pulsar2Commands::confirmed ( const int  fd,
const char *  cmd,
char &  response 
)

◆ ensureLongFormat()

bool Pulsar2Commands::ensureLongFormat ( const int  fd)

◆ getDegreesMinutes()

bool Pulsar2Commands::getDegreesMinutes ( const int  fd,
const char *  cmd,
int *  d,
int *  m 
)

◆ getInt()

bool Pulsar2Commands::getInt ( const int  fd,
const char *  cmd,
int *  value 
)

◆ getObjectRADec()

bool Pulsar2Commands::getObjectRADec ( const int  fd,
double *  ra,
double *  dec 
)
inline

◆ getPECorrection()

bool Pulsar2Commands::getPECorrection ( const int  fd,
PECorrection PECra,
PECorrection PECdec 
)

◆ getPoleCrossing()

bool Pulsar2Commands::getPoleCrossing ( const int  fd,
PoleCrossing pole_crossing 
)
inline

◆ getRCorrection()

bool Pulsar2Commands::getRCorrection ( const int  fd,
RCorrection Rra,
RCorrection Rdec 
)

◆ getSexa()

bool Pulsar2Commands::getSexa ( const int  fd,
const char *  cmd,
double *  value 
)

◆ getSideOfPier()

bool Pulsar2Commands::getSideOfPier ( const int  fd,
SideOfPier side_of_pier 
)
inline

◆ getSiteLatitude()

bool Pulsar2Commands::getSiteLatitude ( const int  fd,
int *  d,
int *  m 
)
inline

◆ getSiteLongitude()

bool Pulsar2Commands::getSiteLongitude ( const int  fd,
int *  d,
int *  m 
)
inline

◆ getString()

bool Pulsar2Commands::getString ( const int  fd,
const char *  cmd,
char  response[] 
)
inline

◆ getUTCDate()

bool Pulsar2Commands::getUTCDate ( const int  fd,
int *  m,
int *  d,
int *  y 
)

◆ getUTCTime()

bool Pulsar2Commands::getUTCTime ( const int  fd,
int *  h,
int *  m,
int *  s 
)

◆ getVersion()

bool Pulsar2Commands::getVersion ( const int  fd,
char  response[] 
)
inline

◆ haltMovement()

bool Pulsar2Commands::haltMovement ( const int  fd,
const Direction  direction 
)

◆ isHomeSet()

bool Pulsar2Commands::isHomeSet ( const int  fd)
inline

◆ isParked()

bool Pulsar2Commands::isParked ( const int  fd)
inline

◆ isParking()

bool Pulsar2Commands::isParking ( const int  fd)
inline

◆ moveTo()

bool Pulsar2Commands::moveTo ( const int  fd,
const Direction  direction 
)

◆ park()

bool Pulsar2Commands::park ( const int  fd)
inline

◆ pulseGuide()

bool Pulsar2Commands::pulseGuide ( const int  fd,
const Direction  direction,
const float  ms 
)

◆ receive()

bool Pulsar2Commands::receive ( const int  fd,
char  response[] 
)

◆ resynchronize()

void Pulsar2Commands::resynchronize ( const int  fd)

◆ send()

bool Pulsar2Commands::send ( const int  fd,
const char *  cmd 
)

◆ setDate()

bool Pulsar2Commands::setDate ( const int  fd,
const int  dd,
const int  mm,
const int  yy 
)

◆ setDegreesMinutes()

bool Pulsar2Commands::setDegreesMinutes ( const int  fd,
const char *  cmd,
const double  value 
)

◆ setObjectDEC()

bool Pulsar2Commands::setObjectDEC ( const int  fd,
const double  dec 
)

◆ setObjectRA()

bool Pulsar2Commands::setObjectRA ( const int  fd,
const double  ra 
)

◆ setObjectRADec()

bool Pulsar2Commands::setObjectRADec ( const int  fd,
const double  ra,
const double  dec 
)
inline

◆ setPECorrection()

bool Pulsar2Commands::setPECorrection ( const int  fd,
const PECorrection  pec_ra,
const PECorrection  pec_dec 
)

◆ setPoleCrossing()

bool Pulsar2Commands::setPoleCrossing ( const int  fd,
const PoleCrossing  pole_crossing 
)

◆ setRCorrection()

bool Pulsar2Commands::setRCorrection ( const int  fd,
const RCorrection  rc_ra,
const RCorrection  rc_dec 
)

◆ setSideOfPier()

bool Pulsar2Commands::setSideOfPier ( const int  fd,
const SideOfPier  side_of_pier 
)

◆ setSite()

bool Pulsar2Commands::setSite ( const int  fd,
const double  longitude,
const double  latitude 
)
inline

◆ setSlewMode()

bool Pulsar2Commands::setSlewMode ( const int  fd,
const SlewMode  slewMode 
)

◆ setTime()

bool Pulsar2Commands::setTime ( const int  fd,
const int  h,
const int  m,
const int  s 
)

◆ startSlew()

bool Pulsar2Commands::startSlew ( const int  fd)
inline

◆ sync()

bool Pulsar2Commands::sync ( const int  fd)
inline

◆ unpark()

bool Pulsar2Commands::unpark ( const int  fd)
inline

Variable Documentation

◆ Acknowledge

constexpr char Pulsar2Commands::Acknowledge = '\006'
static

◆ BufferSize

constexpr int Pulsar2Commands::BufferSize = 32
static

◆ DirectionName

const char* Pulsar2Commands::DirectionName[NumDirections] = { "North", "East", "South", "West" }
static

◆ MaxAttempts

constexpr int Pulsar2Commands::MaxAttempts = 3
static

◆ Null

constexpr char Pulsar2Commands::Null = '\0'
static

◆ OnOff

const char Pulsar2Commands::OnOff[2] = { '0', '1' }
static

◆ resynchronize_needed

bool Pulsar2Commands::resynchronize_needed
static
Initial value:
=
false

◆ Termination

constexpr char Pulsar2Commands::Termination = '#'
static

◆ TimeOut

constexpr int Pulsar2Commands::TimeOut = 1
static