#include <Shutter.h>
Inherits NetOceanDirect::ManagedObject< ShutterAPI >.
◆ Shutter() [1/2]
◆ Shutter() [2/2]
Shutter::Shutter |
( |
ShutterAPI * | instance | ) |
|
◆ ~Shutter()
virtual NetOceanDirect::Shutter::~Shutter |
( |
| ) |
|
|
inlinevirtual |
◆ getInstance()
◆ getShutterState()
bool Shutter::getShutterState |
( |
long | deviceID, |
|
|
int% | errorCode ) |
Get the shutter on whether it's open or closed.
- See also
- setShutterOpen()
- Parameters
-
[in] | deviceID | the ID of the device returned by getDeviceIDs. |
[out] | errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
- Returns
- Return true if the shutter is open otherwise it's false.
◆ setShutterOpen()
void Shutter::setShutterOpen |
( |
long | deviceID, |
|
|
int% | errorCode, |
|
|
bool | opened ) |
Set the shutter to open or closed.
- See also
- getShutterState()
- Parameters
-
[in] | deviceID | the ID of the device returned by getDeviceIDs. |
[out] | errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
[in] | opened | true to open the shutter false to close the shutter. |
◆ shutter
Shutter NetOceanDirect::Shutter::shutter |
|
staticprotected |
The documentation for this class was generated from the following files: