Developer Application Interface (ARC API) v4.5.8
ARC, Inc. GenIV Application Interface
Public Member Functions | Static Public Member Functions | List of all members
arc::gen4::CArcDisplay Class Reference

#include <CArcDisplay.h>

Inheritance diagram for arc::gen4::CArcDisplay:
arc::gen4::CArcBase

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
 
- Public Member Functions inherited from arc::gen4::CArcBase
virtual ~CArcBase (void)
 

Static Public Member Functions

static const std::string version (void) noexcept
 
- Static Public Member Functions inherited from arc::gen4::CArcBase
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

- Protected Member Functions inherited from arc::gen4::CArcBase
 CArcBase (void)=default
 
 CArcBase (const CArcBase &)=delete
 
 CArcBase (CArcBase &&)=delete
 
CArcBase & operator= (const CArcBase &)=delete
 
CArcBase & operator= (CArcBase &&)=delete
 
- Static Protected Attributes inherited from arc::gen4::CArcBase
static const std::string m_sVersion
 

Detailed Description

SAOImage DS9 display class

See also
arc::gen4::CArcBase

Definition at line 37 of file CArcDisplay.h.

Constructor & Destructor Documentation

◆ CArcDisplay()

arc::gen4::CArcDisplay::CArcDisplay ( void  )

Default constructor

◆ ~CArcDisplay()

virtual arc::gen4::CArcDisplay::~CArcDisplay ( void  )
virtual

Destructor

Member Function Documentation

◆ version()

static const std::string arc::gen4::CArcDisplay::version ( void  )
staticnoexcept

Returns a textual representation of the library version.

Returns
A string representation of the library version.

◆ launch()

void arc::gen4::CArcDisplay::launch ( std::uint32_t  uiMSDelay = 1000)

Attempts to launch the DS9 application as a new process.

Parameters
uiMSDelay- The amount of time to delay before attempting to access the program ( Default = 1000 ).
Exceptions
std::ios_base::failure
std::runtime_error

◆ show()

void arc::gen4::CArcDisplay::show ( const std::filesystem::path &  tFitsFile) const

Displays the specified FITS image data in DS9.

Parameters
tFitsFile- FITS file to display.
Exceptions
std::ios_base::failure
std::runtime_error

◆ clear()

void arc::gen4::CArcDisplay::clear ( const std::int32_t  iFrame = -1) const

Clears the specified frame or all if no frame number is specified.

Parameters
iFrame- Frame number to clear or -1 to clear all ( default = -1 ).
Exceptions
std::ios_base::failure
std::runtime_error

◆ terminate()

void arc::gen4::CArcDisplay::terminate ( void  ) const

Forces the termination of the display process.

Exceptions
std::runtime_error

◆ setBoxShape()

void arc::gen4::CArcDisplay::setBoxShape ( void  ) const

Sets the "region" shape to box [].

Exceptions
std::runtime_error

◆ getVersion()

void arc::gen4::CArcDisplay::getVersion ( void  ) const

Returns the DS9 version number

Returns
The DS9 version number
Exceptions
std::runtime_error