![]() |
Developer Application Interface (ARC API) v4.5.8
ARC, Inc. GenIV Application Interface
|
#include <CArcDisplay.h>
Public Member Functions | |
CArcDisplay (void) | |
virtual | ~CArcDisplay (void) |
void | launch (std::uint32_t uiMSDelay=1000) |
void | show (const std::filesystem::path &tFitsFile) const |
void | clear (const std::int32_t iFrame=-1) const |
void | terminate (void) const |
void | setBoxShape (void) const |
void | getVersion (void) const |
![]() | |
virtual | ~CArcBase (void) |
Static Public Member Functions | |
static const std::string | version (void) noexcept |
![]() | |
static const std::string | version (void) |
static void | zeroMemory (void *pDest, std::size_t uiSize) |
static void | copyMemory (void *pDest, void *pSrc, std::size_t uiSize) |
template<typename T > | |
static std::tuple< T *, T * > | copyAndIncrement (void *pDest, void *pSrc, const std::size_t uiSize) |
template<typename ErrCode > requires std::is_integral_v<ErrCode> | |
static const std::string | getSystemErrorMessage (ErrCode iErrCode) |
static const std::string | getSystemErrorMessage (void) |
static std::uint32_t | getSystemError (void) noexcept |
static pStringList_t | splitString (const std::string &sString, const char &zDelim=' ') |
static std::string | formatString (const char *pszFmt,...) |
static const std::filesystem::path | incrementFileName (const std::filesystem::path &tFilePath="", const std::int32_t iStartValue=-1) |
static std::string | convertWideToAnsi (const wchar_t wzString[]) noexcept |
static std::string | convertWideToAnsi (const std::wstring &wsString) |
static std::wstring | convertAnsiToWide (const char *pszString) |
static std::string | cmdToString (const std::uint32_t uiCmd) |
template<typename T > | |
static std::string | iterToString (T *begin, T *end, const char zSeperator=' ') |
static std::string | setDots (const std::string &sText, const std::size_t uiMaxLength, const char szDot='.') |
static std::string | trim (const std::string &sText) noexcept |
static const std::chrono::time_point< std::chrono::high_resolution_clock > | startCodeTime (void) noexcept |
template<typename T > | |
static constexpr auto | endCodeTime (const std::chrono::time_point< std::chrono::high_resolution_clock > tStartTimePoint) noexcept |
Additional Inherited Members | |
![]() | |
CArcBase (void)=default | |
CArcBase (const CArcBase &)=delete | |
CArcBase (CArcBase &&)=delete | |
CArcBase & | operator= (const CArcBase &)=delete |
CArcBase & | operator= (CArcBase &&)=delete |
![]() | |
static const std::string | m_sVersion |
arc::gen4::CArcDisplay::CArcDisplay | ( | void | ) |
Default constructor
|
virtual |
Destructor
|
staticnoexcept |
Returns a textual representation of the library version.
void arc::gen4::CArcDisplay::launch | ( | std::uint32_t | uiMSDelay = 1000 | ) |
Attempts to launch the DS9 application as a new process.
uiMSDelay | - The amount of time to delay before attempting to access the program ( Default = 1000 ). |
std::ios_base::failure | |
std::runtime_error |
void arc::gen4::CArcDisplay::show | ( | const std::filesystem::path & | tFitsFile | ) | const |
Displays the specified FITS image data in DS9.
tFitsFile | - FITS file to display. |
std::ios_base::failure | |
std::runtime_error |
void arc::gen4::CArcDisplay::clear | ( | const std::int32_t | iFrame = -1 | ) | const |
Clears the specified frame or all if no frame number is specified.
iFrame | - Frame number to clear or -1 to clear all ( default = -1 ). |
std::ios_base::failure | |
std::runtime_error |
void arc::gen4::CArcDisplay::terminate | ( | void | ) | const |
Forces the termination of the display process.
std::runtime_error |
void arc::gen4::CArcDisplay::setBoxShape | ( | void | ) | const |
Sets the "region" shape to box [].
std::runtime_error |
void arc::gen4::CArcDisplay::getVersion | ( | void | ) | const |
Returns the DS9 version number
std::runtime_error |