CARMA C++
Public Types | Public Member Functions | Public Attributes | List of all members
sza::util::Axis Class Reference

The following class just enumerates valid axes. More...

#include <carma/szautil/Axis.h>

Public Types

enum  Type {
  NONE = 0x0, AZ = 0x1, EL = 0x2, PA = 0x4,
  BOTH = AZ|EL, ALL = AZ|EL|PA
}
 An enumerator to identify a valid axis. More...
 

Public Member Functions

 Axis (Type type)
 Constructor. More...
 
bool isSet (Type type)
 Return true if a requested axis is set in the mask. More...
 
bool isValidSingleAxis ()
 Return true if this represents a single telescope axis. More...
 

Public Attributes

enum sza::util::Axis::Type type_
 

Detailed Description

The following class just enumerates valid axes.

Definition at line 17 of file Axis.h.

Member Enumeration Documentation

enum sza::util::Axis::Type

An enumerator to identify a valid axis.

Definition at line 24 of file Axis.h.

Constructor & Destructor Documentation

sza::util::Axis::Axis ( Type  type)

Constructor.

Definition at line 37 of file Axis.h.

Member Function Documentation

bool sza::util::Axis::isSet ( Type  type)

Return true if a requested axis is set in the mask.

Definition at line 55 of file Axis.h.

bool sza::util::Axis::isValidSingleAxis ( )

Return true if this represents a single telescope axis.

Definition at line 45 of file Axis.h.

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