versadac  1
versadac - Scalable Recorder Firmware
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
uhh_navigator_cpp Class Reference

Public Member Functions

 uhh_navigator_cpp (char *z_sHost)
 
 ~uhh_navigator_cpp ()
 
int GetRemoteVer ()
 
void navClose ()
 
int getFinalRecStatus ()
 
int getGroupNumbers (int *target, int max)
 
int getInstrumentNumbers (int *target, int max)
 
int getNextItem (UhhDataItem *target)
 
int getNextItems (UhhDataItem **target, int max)
 
int getNextMessage (UhhMessageItem *NextMsg, double lEarliestPtime)
 
int getPtime (double *out)
 
int getPtimeEarliest (double *out)
 
int getPtimeEarliestSameNumPoints (double *out)
 
int getPtimeLatest (double *out)
 
int getSegmentHeader (UhhSegHdr *target, bool bOther, bool bPoint)
 
int getUhhSequenceNumberSupported ()
 
int getUhhSequenceNumbers (int *target, int max)
 
int navOpen (int z_nGroup, bool z_bSuspended, int z_nMaxPoints)
 
int openForMessages (int z_nGroup)
 
int refresh ()
 
int resume ()
 
void suspend ()
 
void setDirection (bool z_bDirection)
 
int setDirectory (uc_char *z_sDirectory)
 
void setUhhSequenceNumbers (int z_nMin, int z_nMax)
 
void setInstrumentNumber (int z_n)
 
void setInterval (long z_lInterval)
 
void setMessageFilter (int z_nCategories)
 
void setMessageMode (int z_nMode)
 
int setPtime (double z_lPtime, int *confChanges)
 
int setPtimeEarliest (double *pTimeSet)
 
int setPtimeLatest (double *pTimeSet)
 
void setTraceMode (int z_nMode)
 
double subtractClockPeriod (double z_lPtime, double z_lClockPeriod)
 
double timeFromPtime (double z_lPtime)
 
int getErrorCond ()
 

Public Attributes

long m_interval
 
bool m_requireMessages
 
uc_char * m_directory
 
int m_instNumbers
 
int * m_instruments
 
int m_UhhSeqNumbers
 
int * m_uhhSequence
 
int m_navOpenStatus
 
int m_NoOfSamples
 
UhhSegHdrm_segHeader
 

Static Public Attributes

static const bool FORWARD = true
 
static const bool BACKWARD = false
 
static const int TRACE_MODE_NONE = 0
 
static const int TRACE_MODE_NORMAL = 1
 
static const int TRACE_MODE_NORMAL_INT = 2
 
static const int TRACE_MODE_AVERAGE = 3
 
static const int TRACE_MODE_AVERAGE_INT = 4
 
static const int TRACE_MODE_MINMAX = 5
 
static const int MSG_MODE_NONE = 0
 
static const int MSG_MODE_ALL = 1
 
static const int MSG_MODE_EARLIEST = 2
 
static const int MSG_MODE_LATEST = 3
 

Constructor & Destructor Documentation

uhh_navigator_cpp::uhh_navigator_cpp ( char *  z_sHost)

Class constructor

z_sHost - The system running the navigator to connect to

uhh_navigator_cpp::~uhh_navigator_cpp ( )

Class destructor

Closes the navigator at the other end of the socket and frees the objects system resources

Member Function Documentation

int uhh_navigator_cpp::getFinalRecStatus ( )

getFinalRecStatus()

Gets the final recording status. This may be different from the status at the latest pseudotime, because it takes account of a possible 'after' status in the end record of the last file

Returns the final recording status

int uhh_navigator_cpp::getGroupNumbers ( int *  target,
int  max 
)

getGroupNumbers(int* target, int max)

Supplies the available group numbers for the current instrument/UHH

Target is a pointer to an array to place the data, max is the size of this structure. The return value is the number of group IDs retrieved. If the target pointer is NULL, the function returns the number of group IDs available

int uhh_navigator_cpp::getInstrumentNumbers ( int *  target,
int  max 
)

getInstrumentNumbers(int* target, int max)

Supplies the available instrument numbers

Target is a pointer to an array to place the data, max is the size of this structure. The return value is the number of instument IDs retrieved. If the target pointer is NULL and max = 0, the function returns the number of instrument IDs available

void uhh_navigator_cpp::navClose ( )

Close()

Closes the currently open history

int uhh_navigator_cpp::setDirectory ( uc_char *  z_sDirectory)

uhh_navigator_cpp - C Implementation of UhhNavigatorM Java Class for history navigation

Unlike it's Java counterpart, this implementation is restricted solely to a sockets implementation. Sets the directory to navigate z_sDirectory - The directory to navigate Returns - Error code, as defined in ENUM_UhhMsg_Err.h


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