OCameraSequence Struct Reference

#include <OCamera.h>

Collaboration diagram for OCameraSequence:

Collaboration graph
[legend]
List of all members.

Detailed Description

Container for acquisition of image sequences.


Public Types

enum  eResult {
  RES_OK = 0, RES_ERR_Z_TOO_LARGE = 1, RES_ERR_A_WRONG = 2, RES_ERR_Z_t_TOO_LARGE = 4,
  RES_ERR_ACQ_IMPOSSIBLE = 8, RES_ABORTED = 16, RES_FINISHED = 0, RES_NOT_INITIALIZED = 32,
  RES_NOT_STARTED = 64, RES_RUNNING = 128
}

Static Public Member Functions

static char * pcGetResultString (eResult enRes)
 get readable string for an eResult code

Public Attributes

OCameraSequenceImagehead
 pointer to first image (linked list)
unsigned long nImages
 number of images acquired
long nTriggerMicroSec
 timestamp of trigger time, micro seconds (1E-6)
long nTriggerSec
 timestamp of trigger time, seconds
eResult result
 result code
OCameraSequenceImagetail
 pointer to last image (linked list)


Member Enumeration Documentation

enum OCameraSequence::eResult

Enumerator:
RES_OK  sequence acquired successfully
RES_ERR_Z_TOO_LARGE  sequence length (Z) is too large for ring buffer
RES_ERR_A_WRONG  for some reason, start time A is wrong
RES_ERR_Z_t_TOO_LARGE  Z+t is too large for ring buffer.
RES_ERR_ACQ_IMPOSSIBLE  unable to make an acquisition due to parameters
RES_ABORTED  sequence acquisition has been aborted
RES_FINISHED  sequence is acquired
RES_NOT_INITIALIZED  acquisition has not been initialized yet
RES_NOT_STARTED  acquisition has not been started yet
RES_RUNNING  acquisition currently running


Member Function Documentation

static char* OCameraSequence::pcGetResultString ( eResult  enRes  )  [static]

get readable string for an eResult code


Member Data Documentation

OCameraSequenceImage* OCameraSequence::head

pointer to first image (linked list)

unsigned long OCameraSequence::nImages

number of images acquired

long OCameraSequence::nTriggerMicroSec

timestamp of trigger time, micro seconds (1E-6)

long OCameraSequence::nTriggerSec

timestamp of trigger time, seconds

eResult OCameraSequence::result

result code

OCameraSequenceImage* OCameraSequence::tail

pointer to last image (linked list)


The documentation for this struct was generated from the following file:
Generated on Fri Oct 12 10:31:12 2007 for Festo SBOx-C API by  doxygen 1.5.1-4