![]() |
VisionWorks Toolkit ReferenceDecember 18, 2015 | 1.2 Release |
FrameSource interface.
Common interface for reading frames from all sources.
Definition at line 80 of file FrameSource.hpp.
Data Structures | |
struct | Parameters |
FrameSource parameters. More... | |
Public Types | |
enum | FrameStatus { OK, TIMEOUT, CLOSED } |
Defines the status of read operations. More... | |
enum | SourceType { UNKNOWN_SOURCE, SINGLE_IMAGE_SOURCE, IMAGE_SEQUENCE_SOURCE, VIDEO_SOURCE, CAMERA_SOURCE } |
Defines the type of source. More... | |
Public Member Functions | |
virtual void | close ()=0 |
Closes the FrameSource. More... | |
virtual FrameSource::FrameStatus | fetch (vx_image image, vx_uint32 timeout=5)=0 |
Fetches frames from the source. More... | |
virtual FrameSource::Parameters | getConfiguration ()=0 |
Gets the configuration of the FrameSource . More... | |
std::string | getSourceName () const |
Returns the source name of the FrameSource. More... | |
FrameSource::SourceType | getSourceType () const |
Returns the source type of the FrameSource . More... | |
virtual bool | open ()=0 |
Opens the FrameSource. More... | |
virtual bool | setConfiguration (const FrameSource::Parameters ¶ms)=0 |
Sets the configuration of the FrameSource . More... | |
virtual | ~FrameSource () |
Destructor. More... | |
Protected Member Functions | |
FrameSource (FrameSource::SourceType type=FrameSource::UNKNOWN_SOURCE, const std::string &name="Undefined") | |
Protected Attributes | |
const std::string | sourceName |
const FrameSource::SourceType | sourceType |
Defines the type of source.
Definition at line 104 of file FrameSource.hpp.
Defines the status of read operations.
Enumerator | |
---|---|
OK |
Indicates the frame has been read successfully. |
TIMEOUT |
Indicates a timeout has been exceeded. |
CLOSED |
Indicates the frame source has been closed. |
Definition at line 116 of file FrameSource.hpp.
|
inlinevirtual |
Destructor.
Definition at line 164 of file FrameSource.hpp.
|
inlineprotected |
Definition at line 188 of file FrameSource.hpp.
|
pure virtual |
Opens the FrameSource.
|
pure virtual |
Fetches frames from the source.
FrameSource
is treated as abandoned and FrameSource::fetch return a CLOSED status.[out] | image | The read image. |
[in] | timeout | Specifies the maximum wait time for the next frame in milliseconds (ms). |
vx_status
enumerator.
|
pure virtual |
Gets the configuration of the FrameSource
.
FrameSource
.
|
pure virtual |
Sets the configuration of the FrameSource
.
[in] | params | A reference to the new configuration of the FrameSource . |
|
pure virtual |
Closes the FrameSource.
|
inline |
Returns the source type of the FrameSource
.
Definition at line 172 of file FrameSource.hpp.
References sourceType.
|
inline |
Returns the source name of the FrameSource.
Definition at line 182 of file FrameSource.hpp.
References sourceName.
|
protected |
Definition at line 193 of file FrameSource.hpp.
Referenced by getSourceType().
|
protected |
Definition at line 194 of file FrameSource.hpp.
Referenced by getSourceName().