Frame Lock

FrameLock objects in C++ are referenced by the following shared pointer typedef:

typedef std::shared_ptr<rogue::interfaces::stream::FrameLock> rogue::interfaces::stream::FrameLockPtr

Alias for using shared pointer as FrameLockPtr.

The class description is shown below:

class FrameLock

Frame Lock.

The FrameLock is a container for holding a lock on Frame data while accessing that data. This lock allows multiple stream Slave objects to read and update Frame data while ensuring only one thread is updating at a time. The lock is released when the FrameLock object is destroyed. The FrameLock object is never created directly, instead it is returned by the Frame::lock() method.

Public Functions

void lock()

Lock associated frame if not locked.

Exposed as lock() to Python

void unlock()

UnLock associated frame if locked.

Exposed as unlock() to Python

void enter()

Enter method for python, does nothing.

This exists only to support the with call in python.

Exposed as enter() to Python

void exit(void*, void*, void*)

Exit method for python, does nothing.

This exists only to support the with call in python.

Exposed as exit() to Python