ssInstrumentRecordTail Class Reference
[C++/Common/Vtk/ReaderWriter]

Base class for those that monitor raw instrument data files for records. More...

#include <ssInstrumentRecordTail.h>

Inheritance diagram for ssInstrumentRecordTail:

Inheritance graph
[legend]
Collaboration diagram for ssInstrumentRecordTail:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 vtkTypeMacro (ssInstrumentRecordTail, vtkObject)
void PrintSelf (ostream &os, vtkIndent indent)
 Print the state of this object.
void SetFileName (const char *name)
 Specify the name of the file to monitor.
virtual void Run ()
 Monitor the file and issue notifies as required.
void Break ()
 Break the Run() loop.
virtual bool RecordPending ()
 Give the status of the disk file.

Static Public Member Functions

static ssInstrumentRecordTailNew ()
 Instantiate a new object of this type.

Protected Member Functions

 ssInstrumentRecordTail ()
 Ctor.
virtual ~ssInstrumentRecordTail ()
 Dtor.
 SP (vtkMutexLock) pendingLock
 Access lock for pending.

Protected Attributes

std::string name
 The FQFN that we are monitoring.
int pending
 Count of pending records.
bool breaker
 Whether a Break() has been requested,.

Detailed Description

Base class for those that monitor raw instrument data files for records.

Definition at line 21 of file ssInstrumentRecordTail.h.


Constructor & Destructor Documentation

ssInstrumentRecordTail::ssInstrumentRecordTail (  )  [protected]

Ctor.

virtual ssInstrumentRecordTail::~ssInstrumentRecordTail (  )  [protected, virtual]

Dtor.


Member Function Documentation

static ssInstrumentRecordTail* ssInstrumentRecordTail::New (  )  [static]

Instantiate a new object of this type.

This is the only method that objects of this type may be created.

Returns:
The new object.

Reimplemented from vtkObject.

Reimplemented in ssPolyDataRecordTail.

ssInstrumentRecordTail::vtkTypeMacro ( ssInstrumentRecordTail  ,
vtkObject   
)

void ssInstrumentRecordTail::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Print the state of this object.

Parameters:
os The output stream.
indent The indentation level. Used for formating output.

Reimplemented from vtkObject.

Reimplemented in ssPolyDataRecordTail.

void ssInstrumentRecordTail::SetFileName ( const char *  name  ) 

Specify the name of the file to monitor.

Parameters:
name The FQFN of the file.

virtual void ssInstrumentRecordTail::Run (  )  [virtual]

Monitor the file and issue notifies as required.

If all goes well then this function will not return until Break() is called. However, if there is some sort of error this function will return and the state of this object will be NOGO.

Reimplemented in ssPolyDataRecordTail.

void ssInstrumentRecordTail::Break (  ) 

Break the Run() loop.

virtual bool ssInstrumentRecordTail::RecordPending (  )  [virtual]

Give the status of the disk file.

Returns:
If the monitored file has added another record since this function was called last then return true.

ssInstrumentRecordTail::SP ( vtkMutexLock   )  [protected]

Access lock for pending.


Member Data Documentation

std::string ssInstrumentRecordTail::name [protected]

The FQFN that we are monitoring.

Definition at line 87 of file ssInstrumentRecordTail.h.

int ssInstrumentRecordTail::pending [protected]

Count of pending records.

Definition at line 97 of file ssInstrumentRecordTail.h.

bool ssInstrumentRecordTail::breaker [protected]

Whether a Break() has been requested,.

Definition at line 102 of file ssInstrumentRecordTail.h.


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