NetOceanDirect  3.1.1
OceanDirect .NET API
Public Member Functions | Static Public Member Functions | Static Protected Attributes | List of all members
NetOceanDirect::Shutter Class Reference

Inherits NetOceanDirect::ManagedObject< ShutterAPI >.

Public Member Functions

 Shutter (ShutterAPI *instance)
 
bool getShutterState (long deviceID, int% errorCode)
 
void setShutterOpen (long deviceID, int% errorCode, bool opened)
 
- Public Member Functions inherited from NetOceanDirect::ManagedObject< ShutterAPI >
 ManagedObject (ShutterAPI *instance)
 
ShutterAPI * GetInstance ()
 

Static Public Member Functions

static Shutter getInstance ()
 

Static Protected Attributes

static Shutter shutter
 

Additional Inherited Members

- Protected Attributes inherited from NetOceanDirect::ManagedObject< ShutterAPI >
ShutterAPI * m_Instance
 

Member Function Documentation

◆ getShutterState()

bool Shutter::getShutterState ( long  deviceID,
int%  errorCode 
)

Get the shutter on whether it's open or closed.

See also
setShutterOpen()
Parameters
[in]deviceIDthe ID of the device returned by getDeviceIDs.
[out]errorCodea 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]deviceIDthe ID of the device returned by getDeviceIDs.
[out]errorCodea 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]openedtrue to open the shutter false to close the shutter.

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