+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27#include "MMDeviceConstants.h"
+
+
29#include "DeviceUtils.h"
+
30#include "ModuleInterface.h"
+
31#include "DeviceThreads.h"
+
+
+
+
+
+
+
+
+
+
+
+
43const char*
const g_Msg_ERR =
"Unknown error in the device";
+
44const char*
const g_Msg_INVALID_PROPERTY =
"Invalid property name encountered";
+
45const char*
const g_Msg_INVALID_PROPERTY_VALUE =
"Invalid property value";
+
46const char*
const g_Msg_DUPLICATE_PROPERTY =
"Duplicate property names are not allowed";
+
47const char*
const g_Msg_INVALID_PROPERTY_TYPE =
"Invalid property type";
+
48const char*
const g_Msg_NATIVE_MODULE_FAILED =
"Native module failed to load";
+
49const char*
const g_Msg_UNSUPPORTED_DATA_FORMAT =
"Unsupported data format encountered";
+
50const char*
const g_Msg_INTERNAL_INCONSISTENCY =
"Device adapter inconsistent with the actual device";
+
51const char*
const g_Msg_NOT_SUPPORTED =
"Device not supported by the adapter";
+
52const char*
const g_Msg_UNKNOWN_LABEL =
"Label not defined";
+
53const char*
const g_Msg_UNSUPPORTED_COMMAND =
"Unsupported device command";
+
54const char*
const g_Msg_UNKNOWN_POSITION =
"Invalid state (position) requested";
+
55const char*
const g_Msg_NO_CALLBACK_REGISTERED =
"No callback registered";
+
56const char*
const g_Msg_SERIAL_BUFFER_OVERRUN =
"Serial buffer overrun.";
+
57const char*
const g_Msg_SERIAL_INVALID_RESPONSE =
"Unexpected response from serial port. Is the device connected to the correct serial port?";
+
58const char*
const g_Msg_SERIAL_TIMEOUT =
"Serial timeout occurred.";
+
59const char*
const g_Msg_SELF_REFERENCE =
"Self reference error.";
+
60const char*
const g_Msg_NO_PROPERTY_DATA =
"No property data error.";
+
61const char*
const g_Msg_DEVICE_DUPLICATE_LABEL =
"Position label already in use";
+
62const char*
const g_Msg_INVALID_INPUT_PARAM =
"Invalid input parameter.";
+
63const char*
const g_Msg_BUFFER_OVERFLOW =
"Buffer Overflow.";
+
64const char*
const g_Msg_SERIAL_COMMAND_FAILED =
"Serial command failed. Is the device connected to the serial port?";
+
65const char*
const g_Msg_DEVICE_NONEXISTENT_CHANNEL =
"Requested channel is not defined.";
+
66const char*
const g_Msg_DEVICE_INVALID_PROPERTY_LIMTS =
"Specified property limits are not valid."
+
67" Either the property already has a set of discrete values, or the range is invalid";
+
68const char*
const g_Msg_EXCEPTION_IN_THREAD =
"Exception in the thread function.";
+
69const char*
const g_Msg_EXCEPTION_IN_ON_THREAD_EXITING =
"Exception in the OnThreadExiting function.";
+
70const char*
const g_Msg_SEQUENCE_ACQUISITION_THREAD_EXITING=
"Sequence thread exiting";
+
71const char*
const g_Msg_DEVICE_CAMERA_BUSY_ACQUIRING=
"Camera is busy acquiring images. Stop camera activity before changing this property";
+
72const char*
const g_Msg_DEVICE_CAN_NOT_SET_PROPERTY=
"The device can not set this property at this moment";
+
73const char*
const g_Msg_DEVICE_NOT_CONNECTED=
"Unable to communicate with the device.";
+
74const char*
const g_Msg_DEVICE_COMM_HUB_MISSING=
"Parent module (Hub) is not available or defined for this device!";
+
75const char*
const g_Msg_DEVICE_DUPLICATE_LIBRARY=
"Duplicate Device Library Name";
+
76const char*
const g_Msg_DEVICE_PROPERTY_NOT_SEQUENCEABLE=
"This property is not sequenceable";
+
77const char*
const g_Msg_DEVICE_SEQUENCE_TOO_LARGE=
"Sequence is too large for this device";
+
78const char*
const g_Msg_DEVICE_NOT_YET_IMPLEMENTED=
"This command has not yet been implemented for this device.";
+
+
80inline long nint(
double value )
+
+
82 return (
long)floor( 0.5 + value);
+
+
+
91template <
class T,
class U>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
125 description_ = descr;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
200 SetMorePropertyErrorInfo(name);
+
201 int nRet = properties_.Get(name, strVal);
+
202 if (nRet == DEVICE_OK)
+
+
+
+
+
+
+
+
+
+
215 int nRet = properties_.Get(name, strVal);
+
216 if (nRet == DEVICE_OK)
+
217 val = atof(strVal.c_str());
+
+
+
+
+
+
+
+
+
229 int nRet = properties_.Get(name, strVal);
+
230 if (nRet == DEVICE_OK)
+
231 val = atol(strVal.c_str());
+
+
+
+
+
+
+
+
+
244 int nRet = properties_.Get(name, strVal);
+
245 if (nRet == DEVICE_OK)
+
246 return strcmp(val, strVal.c_str()) == 0;
+
+
+
+
+
+
+
+
+
+
+
+
+
262 SetMorePropertyErrorInfo(name);
+
263 return DEVICE_INVALID_PROPERTY;
+
+
265 readOnly = pProp->GetReadOnly();
+
+
+
+
+
+
+
+
+
+
+
+
+
281 SetMorePropertyErrorInfo(name);
+
282 return DEVICE_INVALID_PROPERTY;
+
+
284 preInit = pProp->GetInitStatus();
+
+
+
+
+
+
289 virtual int HasPropertyLimits(
const char* name,
bool& hasLimits)
const
+
+
+
+
+
+
295 SetMorePropertyErrorInfo(name);
+
296 return DEVICE_INVALID_PROPERTY;
+
+
298 hasLimits = pProp->HasLimits();
+
+
+
+
+
+
+
+
+
+
+
313 SetMorePropertyErrorInfo(name);
+
314 return DEVICE_INVALID_PROPERTY;
+
+
316 lowLimit = pProp->GetLowerLimit();
+
+
+
+
+
+
+
+
+
+
+
+
331 SetMorePropertyErrorInfo(name);
+
332 return DEVICE_INVALID_PROPERTY;
+
+
334 hiLimit = pProp->GetUpperLimit();
+
+
+
+
+
+
+
+
+
+
+
+
349 SetMorePropertyErrorInfo(name);
+
350 return DEVICE_INVALID_PROPERTY;
+
+
352 sequenceable = pProp->IsSequenceable();
+
+
+
+
+
+
+
+
+
+
+
+
+
368 SetMorePropertyErrorInfo(name);
+
369 return DEVICE_INVALID_PROPERTY;
+
+
+
+
373 if (ret != DEVICE_OK)
+
+
+
376 SetMorePropertyErrorInfo(name);
+
377 return DEVICE_PROPERTY_NOT_SEQUENCEABLE;
+
+
+
380 nrEvents = pProp->GetSequenceMaxSize();
+
+
+
+
+
+
+
+
+
+
+
+
+
396 SetMorePropertyErrorInfo(name);
+
397 return DEVICE_INVALID_PROPERTY;
+
+
+
+
401 if (ret != DEVICE_OK)
+
+
+
404 SetMorePropertyErrorInfo(name);
+
405 return DEVICE_PROPERTY_NOT_SEQUENCEABLE;
+
+
+
408 return pProp->StartSequence();
+
+
+
+
+
+
+
+
+
+
421 SetMorePropertyErrorInfo(name);
+
422 return DEVICE_INVALID_PROPERTY;
+
+
+
+
426 if (ret != DEVICE_OK)
+
+
+
429 SetMorePropertyErrorInfo(name);
+
430 return DEVICE_PROPERTY_NOT_SEQUENCEABLE;
+
+
+
433 return pProp->StopSequence();
+
+
+
+
+
+
+
+
443 int ret = GetSequenceableProperty(&pProp, name);
+
444 if (ret != DEVICE_OK)
+
+
+
447 return pProp->ClearSequence();
+
+
+
+
+
+
+
+
457 int ret = GetSequenceableProperty(&pProp, name);
+
458 if (ret != DEVICE_OK)
+
+
+
461 return pProp->AddToSequence(value);
+
+
+
+
+
+
+
+
472 int ret = GetSequenceableProperty(&pProp, name);
+
473 if (ret != DEVICE_OK)
+
+
+
476 return pProp->SendSequence();
+
+
+
+
+
+
+
+
488 if (!properties_.GetName(uIdx, strName))
+
+
+
+
+
+
+
+
+
+
+
+
+
502 return DEVICE_INVALID_PROPERTY;
+
+
504 pt = pProp->GetType();
+
+
+
+
+
+
+
+
515 int ret = properties_.Set(name, value);
+
516 if( DEVICE_OK != ret)
+
+
+
519 SetMorePropertyErrorInfo(name);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
548 return (
unsigned)pProp->GetAllowedValues().size();
+
+
+
+
+
+
+
+
+
+
+
564 std::vector<std::string> values = pProp->GetAllowedValues();
+
565 if (values.size() < index)
+
+
+
+
+
+
+
+
+
+
+
584 return properties_.CreateProperty(name, value, eType, readOnly, pAct, isPreInitProperty);
+
+
+
+
+
+
598 int(U::*memberFunction)(MM::PropertyBase* pProp, MM::ActionType eAct), bool isPreInitProperty=false) {
+
+
600 return CreateProperty(name, value, eType, readOnly, pAct, isPreInitProperty);
+
+
+
+
+
+
+
+
+
610 std::ostringstream oss;
+
+
612 return CreateProperty(name, oss.str().c_str(), MM::Integer, readOnly, pAct, isPreInitProperty);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
628 std::ostringstream oss;
+
+
630 return CreateProperty(name, oss.str().c_str(), MM::Float, readOnly, pAct, isPreInitProperty);
+
+
+
+
+
+
+
638 return CreateProperty(name, value, MM::String, readOnly, pAct, isPreInitProperty);
+
+
+
+
+
+
+
+
+
+
649 SetMorePropertyErrorInfo(name);
+
650 return DEVICE_INVALID_PROPERTY;
+
+
652 if (pProp->SetLimits(low, high))
+
+
+
655 std::ostringstream os;
+
656 os <<
"Device adapter requests invalid values ( " << low <<
", ";
+
657 os << high <<
") for property: " << name;
+
+
659 return DEVICE_INVALID_PROPERTY_LIMTS;
+
+
+
+
+
+
+
+
668 return properties_.SetAllowedValues(name, values);
+
+
+
+
+
+
+
676 return properties_.ClearAllowedValues(name);
+
+
+
+
+
+
+
684 return properties_.AddAllowedValue(name, value);
+
+
+
+
+
+
+
692 return properties_.AddAllowedValue(name, value, data);
+
+
+
+
+
+
+
700 int ret = properties_.GetPropertyData(name, value, data);
+
701 if( DEVICE_OK != ret)
+
+
703 SetMorePropertyErrorInfo(name);
+
+
+
+
+
+
+
+
+
713 int ret = properties_.GetCurrentPropertyData(name, data);
+
714 if( DEVICE_OK != ret)
+
+
716 SetMorePropertyErrorInfo(name);
+
+
+
+
+
+
+
+
+
727 return properties_.UpdateAll();
+
+
+
+
+
+
+
735 return properties_.Update(name);
+
+
+
+
+
+
+
+
744 return properties_.Apply(name);
+
+
+
+
+
+
+
752 std::map<int, std::string>::const_iterator it;
+
753 it = messages_.find(errorCode);
+
754 if (it == messages_.end())
+
+
+
757 std::ostringstream osTxt;
+
758 osTxt <<
"Error code " << errorCode <<
" (" << std::setbase(16) << errorCode <<
" hex)";
+
+
+
+
+
+
764 std::ostringstream stringStreamMessage;
+
765 stringStreamMessage << it->second.c_str();
+
+
767 if( 2<=errorCode && errorCode<=5 )
+
+
769 stringStreamMessage <<
": " << GetMorePropertyErrorInfo();
+
+
771 SetMorePropertyErrorInfo(
"");
+
+
+
+
+
+
+
+
+
779 virtual bool SupportsDeviceDetection(
void) {
+
+
+
782 virtual MM::DeviceDetectionStatus DetectDevice(
void){
+
783 return MM::Unimplemented;
+
+
+
+
787 virtual void SetParentID(
const char* parentId)
+
+
789 parentID_ = parentId;
+
+
+
792 if (parentID_.size() >= (
unsigned) MM::MaxStrLength)
+
793 parentID_ = parentID_.substr(MM::MaxStrLength-1);
+
+
+
+
797 this->
SetProperty(MM::g_Keyword_HubID, parentID_.c_str());
+
+
+
+
801 virtual void GetParentID(
char* parentID)
const
+
+
+
+
+
+
+
+
+
812 CDeviceBase() : module_(0), delayMs_(0), usesDelay_(false), callback_(0)
+
+
+
+
+
+
+
+
+
823 messages_[errorCode] = text;
+
+
+
+
826 const char* GetMorePropertyErrorInfo(
void)
const
+
+
828 return morePropertyErrorInfo_.c_str();
+
+
+
831 void SetMorePropertyErrorInfo(
const char* ptext)
const
+
+
833 morePropertyErrorInfo_ = ptext;
+
+
+
+
841 int LogMessage(
const char* msg,
bool debugOnly =
false)
const
+
+
+
844 return callback_->
LogMessage(
this, msg, debugOnly);
+
845 return DEVICE_NO_CALLBACK_REGISTERED;
+
+
+
+
+
853 int LogMessage(
const std::string& msg,
bool debugOnly =
false)
const
+
+
+
856 return callback_->
LogMessage(
this, msg.c_str(), debugOnly);
+
857 return DEVICE_NO_CALLBACK_REGISTERED;
+
+
+
+
+
+
+
+
+
869 char text[MM::MaxStrLength];
+
+
871 return callback_->
LogMessage(
this, text, debugOnly);
+
+
873 return DEVICE_NO_CALLBACK_REGISTERED;
+
+
+
+
+
+
+
+
887 std::ostringstream os;
+
+
889 os << message << t.toString() <<
" seconds";
+
+
891 return callback_->
LogMessage(
this, os.str().c_str(), debugOnly);
+
892 return DEVICE_NO_CALLBACK_REGISTERED;
+
+
+
+
+
+
+
904 return LogTimeDiff(start, end,
"Process took: " , debugOnly);
+
+
+
+
+
+
+
+
+
914 SetErrorText(DEVICE_INVALID_PROPERTY, g_Msg_INVALID_PROPERTY);
+
915 SetErrorText(DEVICE_INVALID_PROPERTY_VALUE, g_Msg_INVALID_PROPERTY_VALUE);
+
916 SetErrorText(DEVICE_DUPLICATE_PROPERTY, g_Msg_DUPLICATE_PROPERTY);
+
917 SetErrorText(DEVICE_INVALID_PROPERTY_TYPE, g_Msg_INVALID_PROPERTY_TYPE);
+
918 SetErrorText(DEVICE_NATIVE_MODULE_FAILED, g_Msg_NATIVE_MODULE_FAILED);
+
919 SetErrorText(DEVICE_UNSUPPORTED_DATA_FORMAT, g_Msg_UNSUPPORTED_DATA_FORMAT);
+
920 SetErrorText(DEVICE_INTERNAL_INCONSISTENCY, g_Msg_INTERNAL_INCONSISTENCY);
+
921 SetErrorText(DEVICE_NOT_SUPPORTED, g_Msg_NOT_SUPPORTED);
+
922 SetErrorText(DEVICE_UNKNOWN_LABEL, g_Msg_UNKNOWN_LABEL);
+
923 SetErrorText(DEVICE_UNSUPPORTED_COMMAND, g_Msg_UNSUPPORTED_COMMAND);
+
924 SetErrorText(DEVICE_UNKNOWN_POSITION, g_Msg_UNKNOWN_POSITION);
+
925 SetErrorText(DEVICE_NO_CALLBACK_REGISTERED, g_Msg_NO_CALLBACK_REGISTERED);
+
926 SetErrorText(DEVICE_SERIAL_COMMAND_FAILED, g_Msg_SERIAL_COMMAND_FAILED);
+
927 SetErrorText(DEVICE_SERIAL_BUFFER_OVERRUN, g_Msg_SERIAL_BUFFER_OVERRUN);
+
928 SetErrorText(DEVICE_SERIAL_INVALID_RESPONSE, g_Msg_SERIAL_INVALID_RESPONSE);
+
929 SetErrorText(DEVICE_SERIAL_TIMEOUT, g_Msg_SERIAL_TIMEOUT);
+
930 SetErrorText(DEVICE_SELF_REFERENCE, g_Msg_SELF_REFERENCE);
+
931 SetErrorText(DEVICE_NO_PROPERTY_DATA, g_Msg_NO_PROPERTY_DATA);
+
932 SetErrorText(DEVICE_DUPLICATE_LABEL, g_Msg_DEVICE_DUPLICATE_LABEL);
+
933 SetErrorText(DEVICE_INVALID_INPUT_PARAM, g_Msg_INVALID_INPUT_PARAM);
+
934 SetErrorText(DEVICE_BUFFER_OVERFLOW, g_Msg_BUFFER_OVERFLOW);
+
935 SetErrorText(DEVICE_NONEXISTENT_CHANNEL, g_Msg_DEVICE_NONEXISTENT_CHANNEL);
+
936 SetErrorText(DEVICE_INVALID_PROPERTY_LIMTS, g_Msg_DEVICE_INVALID_PROPERTY_LIMTS);
+
937 SetErrorText(DEVICE_CAMERA_BUSY_ACQUIRING, g_Msg_DEVICE_CAMERA_BUSY_ACQUIRING);
+
938 SetErrorText(DEVICE_CAN_NOT_SET_PROPERTY, g_Msg_DEVICE_CAN_NOT_SET_PROPERTY);
+
+
940 SetErrorText(DEVICE_NOT_CONNECTED, g_Msg_DEVICE_NOT_CONNECTED);
+
941 SetErrorText(DEVICE_COMM_HUB_MISSING, g_Msg_DEVICE_COMM_HUB_MISSING);
+
942 SetErrorText(DEVICE_DUPLICATE_LIBRARY, g_Msg_DEVICE_DUPLICATE_LIBRARY);
+
943 SetErrorText(DEVICE_PROPERTY_NOT_SEQUENCEABLE, g_Msg_DEVICE_PROPERTY_NOT_SEQUENCEABLE);
+
944 SetErrorText(DEVICE_SEQUENCE_TOO_LARGE, g_Msg_DEVICE_SEQUENCE_TOO_LARGE);
+
945 SetErrorText(DEVICE_NOT_YET_IMPLEMENTED, g_Msg_DEVICE_NOT_YET_IMPLEMENTED);
+
+
+
+
+
+
+
+
956 return callback_->
GetDevice(
this, deviceLabel);
+
+
+
+
+
+
+
+
+
+
+
+
985 int WriteToComPort(
const char* portLabel,
const unsigned char* buf,
unsigned bufLength)
+
+
+
988 return callback_->WriteToSerial(
this, portLabel, buf, bufLength);
+
+
990 return DEVICE_NO_CALLBACK_REGISTERED;
+
+
+
+
+
+
+
+
1002 return callback_->SetSerialCommand(
this, portName, command, term);
+
+
1004 return DEVICE_NO_CALLBACK_REGISTERED;
+
+
+
+
+
+
+
1016 const unsigned long MAX_BUFLEN = 2000;
+
1017 char buf[MAX_BUFLEN];
+
+
+
1020 int ret = callback_->GetSerialAnswer(
this, portName, MAX_BUFLEN, buf, term);
+
1021 if (ret != DEVICE_OK)
+
+
+
+
+
+
1027 return DEVICE_NO_CALLBACK_REGISTERED;
+
+
+
+
+
1033 int ReadFromComPort(
const char* portLabel,
unsigned char* buf,
unsigned bufLength,
unsigned long& read)
+
+
+
1036 return callback_->ReadFromSerial(
this, portLabel, buf, bufLength, read);
+
1037 return DEVICE_NO_CALLBACK_REGISTERED;
+
+
+
+
+
+
+
+
1046 return callback_->PurgeSerial(
this, portLabel);
+
1047 return DEVICE_NO_CALLBACK_REGISTERED;
+
+
+
+
+
+
+
+
1056 return callback_->GetSerialPortType(portLabel);
+
1057 return MM::InvalidPort;
+
+
+
+
+
+
+
+
1070 return callback_->OnPropertiesChanged(
this);
+
1071 return DEVICE_NO_CALLBACK_REGISTERED;
+
+
+
+
+
+
+
+
+
1081 return DEVICE_NO_CALLBACK_REGISTERED;
+
+
+
+
+
+
+
1087 int OnStagePositionChanged(
double pos)
+
+
+
+
1091 return DEVICE_NO_CALLBACK_REGISTERED;
+
+
+
+
+
1096 int OnXYStagePositionChanged(
double xPos,
double yPos)
+
+
+
+
1100 return DEVICE_NO_CALLBACK_REGISTERED;
+
+
+
+
+
1105 int OnExposureChanged(
double exposure)
+
+
+
+
1109 return DEVICE_NO_CALLBACK_REGISTERED;
+
+
+
+
+
1114 int OnSLMExposureChanged(
double exposure)
+
+
+
+
1118 return DEVICE_NO_CALLBACK_REGISTERED;
+
+
+
1123 int OnMagnifierChanged()
+
+
+
+
1127 return DEVICE_NO_CALLBACK_REGISTERED;
+
+
+
+
+
+
+
1137 return callback_->GetClockTicksUs(
this);
+
+
+
+
+
+
+
+
+
+
1148 return callback_->GetCurrentMMTime();
+
+
+
+
+
+
+
+
+
1158 return callback_ == 0 ? false :
true;
+
+
+
+
+
+
+
+
+
+
+
1185 char pid[MM::MaxStrLength];
+
1186 this->GetParentID(pid);
+
1187 this->
CreateProperty(MM::g_Keyword_HubID, pid, MM::String,
true);
+
+
+
+
+
+
1208 template<
class T_HUB>
+
+
+
+
+
+
+
1214 char hubLabel[MM::MaxStrLength];
+
1215 hub->GetLabel(hubLabel);
+
1216 SetParentID(hubLabel);
+
+
+
+
+
+
+
1222 bool PropertyDefined(
const char* propName)
const
+
+
1224 return properties_.Find(propName) != 0;
+
+
+
1234 int GetSequenceableProperty(
MM::Property** pProp,
const char* name)
const
+
+
1236 *pProp = properties_.Find(name);
+
+
+
1239 SetMorePropertyErrorInfo(name);
+
1240 return DEVICE_INVALID_PROPERTY;
+
+
+
1243 bool sequenceable = (*pProp)->IsSequenceable();
+
1244 if (!sequenceable) {
+
1245 SetMorePropertyErrorInfo(name);
+
1246 return DEVICE_PROPERTY_NOT_SEQUENCEABLE;
+
+
+
+
+
+
+
+
+
1255 std::string moduleName_;
+
1256 std::string description_;
+
1257 std::map<int, std::string> messages_;
+
+
+
+
+
1262 mutable std::string morePropertyErrorInfo_;
+
1263 std::string parentID_;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
1303 CCameraBase() : busy_(false), stopWhenCBOverflows_(false), thd_(0)
+
+
+
1306 std::vector<std::string> allowedValues;
+
1307 allowedValues.push_back(
"0");
+
1308 allowedValues.push_back(
"1");
+
1309 CreateProperty(MM::g_Keyword_Transpose_SwapXY,
"0", MM::Integer,
false);
+
+
1311 CreateProperty(MM::g_Keyword_Transpose_MirrorX,
"0", MM::Integer,
false);
+
+
1313 CreateProperty(MM::g_Keyword_Transpose_MirrorY,
"0", MM::Integer,
false);
+
+
1315 CreateProperty(MM::g_Keyword_Transpose_Correction,
"0", MM::Integer,
false);
+
+
+
+
+
+
+
+
1323 if (!thd_->IsStopped()) {
+
+
+
+
+
+
+
1330 virtual bool Busy() {
return busy_;}
+
+
+
+
+
+
+
1346 if (!thd_->IsStopped()) {
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
1367 return DEVICE_NONEXISTENT_CHANNEL;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
1413 std::string data = metadata_.Serialize();
+
1414 data.copy(serializedMetadata, data.size(), 0);
+
+
+
+
+
+
+
+
+
+
+
1426 return DEVICE_CAMERA_BUSY_ACQUIRING;
+
+
+
1429 if (ret != DEVICE_OK)
+
+
1431 thd_->Start(numImages,interval_ms);
+
1432 stopWhenCBOverflows_ = stopOnOverflow;
+
+
+
+
+
1436 virtual int GetExposureSequenceMaxLength(
long& )
const
+
+
1438 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
1441 virtual int StartExposureSequence()
+
+
1443 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
1446 virtual int StopExposureSequence()
+
+
1448 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
1451 virtual int ClearExposureSequence()
+
+
1453 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
1456 virtual int AddToExposureSequence(
double )
+
+
1458 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
1461 virtual int SendExposureSequence()
const
+
+
1463 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
+
+
+
1468 virtual void AddTag(
const char* key,
const char* deviceLabel,
const char* value)
+
+
1470 metadata_.PutTag(key, deviceLabel, value);
+
+
+
+
+
+
+
+
1476 metadata_.RemoveTag(key);
+
+
+
+
1479 virtual bool SupportsMultiROI()
+
+
+
+
+
1484 virtual bool IsMultiROISet()
+
+
+
+
+
1489 virtual int GetMultiROICount(
unsigned& )
+
+
1491 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
1494 virtual int SetMultiROI(
const unsigned* ,
const unsigned* ,
+
1495 const unsigned* ,
const unsigned* ,
+
+
+
1498 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
1501 virtual int GetMultiROI(
unsigned* ,
unsigned* ,
+
1502 unsigned* ,
unsigned* ,
unsigned* )
+
+
1504 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
+
+
+
+
1512 virtual std::vector<std::string> GetTagKeys()
+
+
1514 return metadata_.GetKeys();
+
+
+
1517 virtual std::string GetTagValue(
const char* key)
+
+
1519 return metadata_.GetSingleTag(key).GetValue();
+
+
+
+
+
1524 virtual int ThreadRun (
void)
+
+
+
+
1528 if (ret != DEVICE_OK)
+
+
+
+
1532 ret = InsertImage();
+
1533 if (ret != DEVICE_OK)
+
+
+
+
+
+
+
1540 virtual int InsertImage()
+
+
1542 char label[MM::MaxStrLength];
+
+
+
1545 md.put(MM::g_Keyword_Metadata_CameraLabel, label);
+
+
+
1548 md.Serialize().c_str());
+
1549 if (!stopWhenCBOverflows_ && ret == DEVICE_BUFFER_OVERFLOW)
+
+
+
+
+
+
1555 md.Serialize().c_str());
+
+
+
+
+
1560 virtual double GetIntervalMs() {
return thd_->GetIntervalMs();}
+
1561 virtual long GetImageCounter() {
return thd_->GetImageCounter();}
+
1562 virtual long GetNumberOfImages() {
return thd_->GetNumberOfImages();}
+
+
+
1565 virtual void OnThreadExiting()
+
+
+
+
1569 LogMessage(g_Msg_SEQUENCE_ACQUISITION_THREAD_EXITING);
+
+
+
+
+
1574 LogMessage(g_Msg_EXCEPTION_IN_ON_THREAD_EXITING,
false);
+
+
+
+
1578 virtual bool isStopOnOverflow() {
return stopWhenCBOverflows_;}
+
1579 virtual void setStopOnOverflow(
bool stop) {stopWhenCBOverflows_ = stop;}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
1606 enum { default_numImages=1, default_intervalMS = 100 };
+
+
+
1609 :intervalMs_(default_intervalMS)
+
1610 ,numImages_(default_numImages)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
1627 void Start(
long numImages,
double intervalMs)
+
+
+
+
1631 numImages_=numImages;
+
1632 intervalMs_=intervalMs;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
1649 bool IsSuspended() {
+
+
+
+
+
+
+
+
1657 double GetIntervalMs(){
return intervalMs_;}
+
1658 void SetLength(
long images) {numImages_ = images;}
+
+
+
1661 long GetImageCounter(){
return imageCounter_;}
+
1662 MM::MMTime GetStartTime(){
return startTime_;}
+
1663 MM::MMTime GetActualDuration(){
return actualDuration_;}
+
+
+
1666 long GetNumberOfImages() {
return numImages_;}
+
+
1668 void UpdateActualDuration() {actualDuration_ = camera_->
GetCurrentMMTime() - startTime_;}
+
+
+
+
+
+
+
+
+
+
1678 ret=camera_->ThreadRun();
+
1679 }
while (DEVICE_OK == ret && !IsStopped() && imageCounter_++ < numImages_-1);
+
+
1681 camera_->
LogMessage(
"SeqAcquisition interrupted by the user\n");
+
+
+
1684 camera_->
LogMessage(g_Msg_EXCEPTION_IN_THREAD,
false);
+
+
+
1687 UpdateActualDuration();
+
1688 camera_->OnThreadExiting();
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
1710 bool stopWhenCBOverflows_;
+
+
+
+
+
+
+
+
+
+
+
+
+
1724 virtual int GetPositionUm(
double& pos) = 0;
+
1725 virtual int SetPositionUm(
double pos) = 0;
+
+
1730 virtual int SetRelativePositionUm(
double d)
+
+
+
1733 int ret = GetPositionUm(pos);
+
1734 if (ret != DEVICE_OK)
+
+
1736 return SetPositionUm(pos + d);
+
+
+
1739 virtual int SetAdapterOriginUm(
double )
+
+
1741 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
1744 virtual int Move(
double )
+
+
1746 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
+
+
+
+
+
+
+
+
+
+
1759 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
1762 virtual int GetFocusDirection(MM::FocusDirection& direction)
+
+
+
+
+
1767 direction = MM::FocusDirectionUnknown;
+
+
+
+
1771 virtual int IsStageLinearSequenceable(
bool& isSequenceable)
const
+
+
1773 isSequenceable =
false;
+
+
+
+
1777 virtual int GetStageSequenceMaxLength(
long& )
const
+
+
1779 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
1782 virtual int StartStageSequence()
+
+
1784 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
1787 virtual int StopStageSequence()
+
+
1789 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
1792 virtual int ClearStageSequence()
+
+
1794 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
1797 virtual int AddToStageSequence(
double )
+
+
1799 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
1802 virtual int SendStageSequence()
+
+
1804 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
1807 virtual int SetStageLinearSequence(
double,
long)
+
+
1809 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
+
+
+
+
+
+
+
1822 CXYStageBase() : originXSteps_(0), originYSteps_(0), xPos_(0), yPos_(0)
+
+
+
1825 this->
CreateProperty(MM::g_Keyword_Transpose_MirrorX,
"0", MM::Integer,
false);
+
+
+
+
1829 this->
CreateProperty(MM::g_Keyword_Transpose_MirrorY,
"0", MM::Integer,
false);
+
+
+
+
+
+
1835 virtual int SetPositionUm(
double x,
double y)
+
+
1837 bool mirrorX, mirrorY;
+
1838 GetOrientation(mirrorX, mirrorY);
+
+
+
+
+
+
+
+
1846 xSteps = originXSteps_ - nint (x / this->GetStepSizeXUm());
+
+
1848 xSteps = originXSteps_ + nint (x / this->GetStepSizeXUm());
+
+
1850 ySteps = originYSteps_ - nint (y / this->GetStepSizeYUm());
+
+
1852 ySteps = originYSteps_ + nint (y / this->GetStepSizeYUm());
+
+
1854 int ret = this->SetPositionSteps(xSteps, ySteps);
+
1855 if (ret == DEVICE_OK) {
+
+
+
1858 this->OnXYStagePositionChanged(xPos_, yPos_);
+
+
+
+
+
+
+
+
1868 bool mirrorX, mirrorY;
+
1869 GetOrientation(mirrorX, mirrorY);
+
1870 double xPos = xPos_ + dx;
+
1871 double yPos = yPos_ + dy;
+
+
+
+
+
+
+
+
1879 if (ret == DEVICE_OK) {
+
+
+
1882 this->OnXYStagePositionChanged(xPos_, yPos_);
+
+
+
+
+
+
+
+
+
1896 bool mirrorX, mirrorY;
+
1897 GetOrientation(mirrorX, mirrorY);
+
+
+
1900 int ret = this->GetPositionSteps(xStep, yStep);
+
1901 if (ret != DEVICE_OK)
+
+
+
+
1905 originXSteps_ = xStep + nint(newXUm / this->GetStepSizeXUm());
+
+
1907 originXSteps_ = xStep - nint(newXUm / this->GetStepSizeXUm());
+
+
1909 originYSteps_ = yStep + nint(newYUm / this->GetStepSizeYUm());
+
+
1911 originYSteps_ = yStep - nint(newYUm / this->GetStepSizeYUm());
+
+
+
+
+
+
1916 virtual int GetPositionUm(
double& x,
double& y)
+
+
1918 bool mirrorX, mirrorY;
+
1919 GetOrientation(mirrorX, mirrorY);
+
+
1921 long xSteps, ySteps;
+
1922 int ret = this->GetPositionSteps(xSteps, ySteps);
+
1923 if (ret != DEVICE_OK)
+
+
+
+
1927 x = (originXSteps_ - xSteps) * this->GetStepSizeXUm();
+
+
1929 x = - ((originXSteps_ - xSteps) * this->GetStepSizeXUm());
+
+
+
1932 y = (originYSteps_ - ySteps) * this->GetStepSizeYUm();
+
+
1934 y = - ((originYSteps_ - ySteps) * this->GetStepSizeYUm());
+
+
+
+
+
+
+
+
+
+
+
1949 long xSteps, ySteps;
+
1950 int ret = this->GetPositionSteps(xSteps, ySteps);
+
1951 if (ret != DEVICE_OK)
+
+
+
1954 return this->SetPositionSteps(xSteps+x, ySteps+y);
+
+
+
+
1957 virtual int Move(
double ,
double )
+
+
1959 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
+
+
+
1964 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
+
+
+
+
1969 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
+
1972 virtual int GetXYStageSequenceMaxLength(
long& )
const
+
+
1974 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
1977 virtual int StartXYStageSequence()
+
+
1979 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
1982 virtual int StopXYStageSequence()
+
+
1984 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
+
+
+
1989 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
+
+
+
+
1994 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
+
+
+
+
1999 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
+
+
+
+
2012 double GetCachedYUm() {
return yPos_;}
+
+
+
+
2016 void GetOrientation(
bool& mirrorX,
bool& mirrorY)
+
+
2018 char val[MM::MaxStrLength];
+
2019 int ret = this->
GetProperty(MM::g_Keyword_Transpose_MirrorX, val);
+
2020 assert(ret == DEVICE_OK);
+
2021 mirrorX = strcmp(val,
"1") == 0 ? true :
false;
+
+
2023 ret = this->
GetProperty(MM::g_Keyword_Transpose_MirrorY, val);
+
2024 assert(ret == DEVICE_OK);
+
2025 mirrorY = strcmp(val,
"1") == 0 ? true :
false;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
2058 virtual int AutoSetParameters() {
return DEVICE_UNSUPPORTED_COMMAND;}
+
+
+
+
+
+
+
+
+
+
+
2075 virtual int GetDASequenceMaxLength(
long& )
const
+
+
2077 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
2080 virtual int StartDASequence()
+
+
2082 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
2085 virtual int StopDASequence() {
+
2086 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
2089 virtual int ClearDASequence() {
+
2090 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
2093 virtual int AddToDASequence(
double )
+
+
2095 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
2098 virtual int SendDASequence() {
+
2099 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
+
+
+
+
+
+
+
+
+
2117 virtual int GetSLMSequenceMaxLength(
long& )
const
+
+
2119 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
2122 virtual int StartSLMSequence()
+
+
2124 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
2127 virtual int StopSLMSequence() {
+
2128 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
2131 virtual int ClearSLMSequence() {
+
2132 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
2135 virtual int AddToSLMSequence(
const unsigned char *
const )
+
+
2137 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
2140 virtual int AddToSLMSequence(
const unsigned int *
const )
+
+
2142 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
2145 virtual int SendSLMSequence() {
+
2146 return DEVICE_UNSUPPORTED_COMMAND;
+
+
+
+
+
+
+
+
+
2156 double GetXMinimum() {
return 0.0;};
+
2157 double GetYMinimum() {
return 0.0;};
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
2197 for (
unsigned i=0; i<installedDevices.size(); i++)
+
2198 delete installedDevices[i];
+
2199 installedDevices.clear();
+
+
+
+
+
2203 void AddInstalledDevice(
MM::Device* pdev) {installedDevices.push_back(pdev);}
+
+
+
2206 std::vector<MM::Device*> installedDevices;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
2243 std::map<std::string, long>::const_iterator it;
+
2244 it = labels_.find(label);
+
2245 if (it == labels_.end())
+
2246 return DEVICE_UNKNOWN_LABEL;
+
+
+
+
+
+
+
+
+
+
2259 if (gateOpen_ != open) {
+
+
+
+
2263 if (ret != DEVICE_OK)
+
+
+
+
+
+
+
+
2270 virtual int GetGateOpen(
bool& open)
+
+
+
+
+
+
+
+
+
2282 char buf[MM::MaxStrLength];
+
+
2284 int ret = this->
GetProperty(MM::g_Keyword_State, buf);
+
2285 if (ret == DEVICE_OK)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
2302 if (ret == DEVICE_OK)
+
+
+
+
+
+
+
+
+
+
2313 std::map<std::string, long>::const_iterator it;
+
2314 for (it=labels_.begin(); it!=labels_.end(); it++)
+
+
+
+
2318 if (it->second == pos)
+
+
+
+
+
+
+
+
2326 return DEVICE_UNKNOWN_POSITION;
+
+
+
+
+
+
+
+
2335 std::map<std::string, long>::iterator it;
+
2336 it = labels_.find(label);
+
2337 if (it != labels_.end() && it->second != pos)
+
+
+
+
+
+
+
2344 for (it=labels_.begin(); it!=labels_.end(); it++)
+
2345 if (it->second == pos)
+
+
+
+
+
+
+
2352 labels_[label] = pos;
+
+
+
+
2356 std::string strLabel(label);
+
2357 std::vector<std::string> values;
+
2358 for (it=labels_.begin(); it!=labels_.end(); it++)
+
2359 values.push_back(it->first);
+
+
+
+
+
+
+
+
+
+
2370 std::map<std::string, long>::const_iterator it;
+
2371 it = labels_.find(label);
+
2372 if (it == labels_.end())
+
2373 return DEVICE_UNKNOWN_LABEL;
+
+
+
+
+
+
+
+
+
+
2384 if (eAct == MM::BeforeGet)
+
+
2386 char buf[MM::MaxStrLength];
+
+
2388 if (ret != DEVICE_OK)
+
+
+
+
2392 else if (eAct == MM::AfterSet)
+
+
+
+
+
2397 if (ret != DEVICE_OK)
+
+
+
2400 else if (eAct == MM::IsSequenceable)
+
+
+
+
+
2405 if (ret != DEVICE_OK)
+
+
+
+
+
+
2411 if (ret != DEVICE_OK)
+
+
+
2414 pProp->SetSequenceable(nrEvents);
+
+
2416 else if (eAct == MM::AfterLoadSequence) {
+
+
2418 std::vector<std::string> sequence = pProp->GetSequence();
+
2419 for (std::vector<std::string>::iterator it = sequence.begin(); it != sequence.end(); ++it) {
+
+
+
2422 if (ret != DEVICE_OK)
+
+
2424 std::stringstream s;
+
+
+
+
+
+
2430 if (ret != DEVICE_OK)
+
+
+
2433 std::vector<std::string>::iterator it;
+
2434 for ( it=sequence.begin() ; it < sequence.end(); it++ )
+
+
+
2437 if (ret != DEVICE_OK)
+
+
+
+
+
2442 if (ret != DEVICE_OK)
+
+
+
+
+
2447 else if (eAct == MM::StartSequence) {
+
+
+
+
2451 else if (eAct == MM::StopSequence) {
+
+
+
+
+
+
+
+
+
+
+
+
+
2466 if (ret != DEVICE_OK) {
+
+
+
+
2470 char label[MM::MaxStrLength];
+
+
+
+
+
+
+
+
+
+
+
2480 std::map<std::string, long> labels_;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
2493 LogMessage(#x, true); \
+
2494 _start_time = GetCurrentMMTime(); \
+
+
2496 _end_time = GetCurrentMMTime(); \
+
2497 LogTimeDiff(_start_time,_end_time, true); \
+
+
Definition DeviceBase.h:2057
+
Definition DeviceBase.h:1604
+
Definition DeviceBase.h:1584
+
Definition DeviceBase.h:1289
+
virtual int StartSequenceAcquisition(double interval)
Definition DeviceBase.h:1336
+
virtual int PrepareSequenceAcqusition()
Definition DeviceBase.h:1418
virtual unsigned GetImageBytesPerPixel() const =0
-
virtual int StartSequenceAcquisition(long numImages, double interval_ms, bool stopOnOverflow)
Definition: DeviceBase.h:1423
+
virtual int StartSequenceAcquisition(long numImages, double interval_ms, bool stopOnOverflow)
Definition DeviceBase.h:1423
virtual unsigned GetImageHeight() const =0
-
virtual void RemoveTag(const char *key)
Definition: DeviceBase.h:1474
-
virtual unsigned GetNumberOfChannels() const
Definition: DeviceBase.h:1377
-
virtual double GetPixelSizeUm() const
Definition: DeviceBase.h:1357
-
virtual int GetComponentName(unsigned channel, char *name)
Definition: DeviceBase.h:1364
-
virtual bool IsCapturing()
Definition: DeviceBase.h:1466
-
virtual unsigned GetNumberOfComponents() const
Definition: DeviceBase.h:1359
-
virtual const unsigned int * GetImageBufferAsRGB32()
Definition: DeviceBase.h:1403
-
virtual int StopSequenceAcquisition()
Definition: DeviceBase.h:1344
+
virtual void RemoveTag(const char *key)
Definition DeviceBase.h:1474
+
virtual unsigned GetNumberOfChannels() const
Definition DeviceBase.h:1377
+
virtual double GetPixelSizeUm() const
Definition DeviceBase.h:1357
+
virtual const unsigned char * GetImageBuffer()=0
+
virtual int GetComponentName(unsigned channel, char *name)
Definition DeviceBase.h:1364
+
virtual bool IsCapturing()
Definition DeviceBase.h:1466
+
virtual unsigned GetNumberOfComponents() const
Definition DeviceBase.h:1359
+
virtual int StopSequenceAcquisition()
Definition DeviceBase.h:1344
virtual int SnapImage()=0
virtual unsigned GetImageWidth() const =0
-
virtual void AddTag(const char *key, const char *deviceLabel, const char *value)
Definition: DeviceBase.h:1468
-
virtual void GetTags(char *serializedMetadata)
Definition: DeviceBase.h:1411
-
virtual int GetChannelName(unsigned, char *name)
Definition: DeviceBase.h:1386
-
Definition: DeviceBase.h:93
-
virtual bool GetErrorText(int errorCode, char *text) const
Definition: DeviceBase.h:750
-
virtual bool GetPropertyName(unsigned uIdx, char *name) const
Definition: DeviceBase.h:485
-
int CreateStringProperty(const char *name, const char *value, bool readOnly, MM::ActionFunctor *pAct=0, bool isPreInitProperty=false)
Definition: DeviceBase.h:636
-
void InitializeDefaultErrorMessages()
Definition: DeviceBase.h:910
-
int LogMessageCode(const int errorCode, bool debugOnly=false) const
Definition: DeviceBase.h:865
-
bool IsPropertyEqualTo(const char *name, const char *val) const
Definition: DeviceBase.h:241
-
int CreateFloatProperty(const char *name, double value, bool readOnly, MM::ActionFunctor *pAct=0, bool isPreInitProperty=false)
Definition: DeviceBase.h:618
-
void SetErrorText(int errorCode, const char *text)
Definition: DeviceBase.h:821
-
virtual void SetDelayMs(double delay)
Definition: DeviceBase.h:173
-
unsigned long GetClockTicksUs()
Definition: DeviceBase.h:1134
-
int UpdateStatus()
Definition: DeviceBase.h:725
-
int OnPropertiesChanged()
Definition: DeviceBase.h:1067
-
int SetPropertyLimits(const char *name, double low, double high)
Definition: DeviceBase.h:644
-
int CreateIntegerProperty(const char *name, long value, bool readOnly, MM::ActionFunctor *pAct=0, bool isPreInitProperty=false)
Definition: DeviceBase.h:606
-
bool IsCallbackRegistered() const
Definition: DeviceBase.h:1156
-
int CreateProperty(const char *name, const char *value, MM::PropertyType eType, bool readOnly, MM::ActionFunctor *pAct=0, bool isPreInitProperty=false)
Definition: DeviceBase.h:582
-
MM::Device * GetDevice(const char *deviceLabel) const
Definition: DeviceBase.h:953
-
int GetProperty(const char *name, long &val)
Definition: DeviceBase.h:226
-
int PurgeComPort(const char *portLabel)
Definition: DeviceBase.h:1043
-
void EnableDelay(bool state=true)
Definition: DeviceBase.h:1172
-
virtual int StartPropertySequence(const char *name)
Definition: DeviceBase.h:390
-
int LogTimeDiff(MM::MMTime start, MM::MMTime end, bool debugOnly=false) const
Definition: DeviceBase.h:902
-
void CreateHubIDProperty()
Definition: DeviceBase.h:1183
-
virtual void SetModuleHandle(HDEVMODULE hModule)
Definition: DeviceBase.h:139
-
void GetLoadedDeviceOfType(MM::DeviceType devType, char *deviceName, const unsigned int deviceIterator)
Definition: DeviceBase.h:972
-
int ClearAllowedValues(const char *name)
Definition: DeviceBase.h:674
-
int LogMessage(const char *msg, bool debugOnly=false) const
Definition: DeviceBase.h:841
-
int OnPropertyChanged(const char *propName, const char *propValue)
Definition: DeviceBase.h:1077
-
virtual double GetDelayMs() const
Definition: DeviceBase.h:166
-
virtual int ClearPropertySequence(const char *name)
Definition: DeviceBase.h:440
-
virtual bool HasProperty(const char *name) const
Definition: DeviceBase.h:528
-
int GetSerialAnswer(const char *portName, const char *term, std::string &ans)
Definition: DeviceBase.h:1014
-
virtual bool UsesDelay()
Definition: DeviceBase.h:184
-
int UpdateProperty(const char *name)
Definition: DeviceBase.h:733
-
virtual int AddToPropertySequence(const char *name, const char *value)
Definition: DeviceBase.h:454
-
MM::PortType GetSerialPortType(const char *portLabel)
Definition: DeviceBase.h:1053
-
T_HUB * AssignToHub()
Definition: DeviceBase.h:1209
-
virtual int GetPropertySequenceMaxLength(const char *name, long &nrEvents) const
Definition: DeviceBase.h:362
-
MM::MMTime GetCurrentMMTime()
Definition: DeviceBase.h:1145
-
virtual int StopPropertySequence(const char *name)
Definition: DeviceBase.h:416
-
virtual void SetModuleName(const char *name)
Definition: DeviceBase.h:107
-
virtual unsigned GetNumberOfPropertyValues(const char *propertyName) const
Definition: DeviceBase.h:542
-
MM::Hub * GetParentHub() const
Definition: DeviceBase.h:1196
-
virtual int SetProperty(const char *name, const char *value)
Definition: DeviceBase.h:513
-
virtual HDEVMODULE GetModuleHandle() const
Definition: DeviceBase.h:102
-
virtual int SendPropertySequence(const char *name)
Definition: DeviceBase.h:469
-
virtual void GetLabel(char *name) const
Definition: DeviceBase.h:156
-
int LogMessage(const std::string &msg, bool debugOnly=false) const
Definition: DeviceBase.h:853
-
virtual void GetDescription(char *name) const
Definition: DeviceBase.h:131
-
int WriteToComPort(const char *portLabel, const unsigned char *buf, unsigned bufLength)
Definition: DeviceBase.h:985
-
virtual void SetLabel(const char *label)
Definition: DeviceBase.h:146
-
virtual bool GetPropertyValueAt(const char *propertyName, unsigned index, char *value) const
Definition: DeviceBase.h:558
-
virtual void GetModuleName(char *name) const
Definition: DeviceBase.h:115
-
int SendSerialCommand(const char *portName, const char *command, const char *term)
Definition: DeviceBase.h:999
-
int GetPropertyData(const char *name, const char *value, long &data)
Definition: DeviceBase.h:698
-
int GetCurrentPropertyData(const char *name, long &data)
Definition: DeviceBase.h:711
-
virtual unsigned GetNumberOfProperties() const
Definition: DeviceBase.h:189
-
virtual int GetProperty(const char *name, char *value) const
Definition: DeviceBase.h:196
-
MM::Core * GetCoreCallback() const
Definition: DeviceBase.h:1164
-
int ApplyProperty(const char *name)
Definition: DeviceBase.h:742
-
virtual int GetPropertyType(const char *name, MM::PropertyType &pt) const
Definition: DeviceBase.h:498
-
int ReadFromComPort(const char *portLabel, unsigned char *buf, unsigned bufLength, unsigned long &read)
Definition: DeviceBase.h:1033
-
virtual int GetPropertyInitStatus(const char *name, bool &preInit) const
Definition: DeviceBase.h:275
-
int LogTimeDiff(MM::MMTime start, MM::MMTime end, const std::string &message, bool debugOnly=false) const
Definition: DeviceBase.h:885
-
virtual void SetDescription(const char *descr)
Definition: DeviceBase.h:123
-
virtual int GetPropertyLowerLimit(const char *name, double &lowLimit) const
Definition: DeviceBase.h:307
-
virtual int GetPropertyUpperLimit(const char *name, double &hiLimit) const
Definition: DeviceBase.h:325
-
virtual int GetPropertyReadOnly(const char *name, bool &readOnly) const
Definition: DeviceBase.h:256
-
int GetProperty(const char *name, double &val)
Definition: DeviceBase.h:212
-
int AddAllowedValue(const char *name, const char *value)
Definition: DeviceBase.h:682
-
int SetAllowedValues(const char *name, std::vector< std::string > &values)
Definition: DeviceBase.h:666
-
int AddAllowedValue(const char *name, const char *value, long data)
Definition: DeviceBase.h:690
-
int CreatePropertyWithHandler(const char *name, const char *value, MM::PropertyType eType, bool readOnly, int(U::*memberFunction)(MM::PropertyBase *pProp, MM::ActionType eAct), bool isPreInitProperty=false)
Definition: DeviceBase.h:597
-
virtual int IsPropertySequenceable(const char *name, bool &sequenceable) const
Definition: DeviceBase.h:343
-
virtual void SetCallback(MM::Core *cbk)
Definition: DeviceBase.h:178
-
static const char * ConvertToString(long lnVal)
Definition: DeviceUtils.cpp:63
-
static bool CopyLimitedString(char *pszTarget, const char *pszSource)
Definition: DeviceUtils.cpp:43
-
Definition: DeviceBase.h:2155
-
Definition: DeviceBase.h:1279
-
Definition: DeviceBase.h:2066
-
Definition: DeviceBase.h:2108
-
Definition: DeviceBase.h:2116
-
Definition: DeviceBase.h:2049
-
Definition: DeviceBase.h:2041
-
Definition: DeviceBase.h:2074
-
Definition: DeviceBase.h:1723
-
Definition: DeviceBase.h:2216
-
virtual int GetPosition(char *label) const
Definition: DeviceBase.h:2298
-
virtual int GetPositionLabel(long pos, char *label) const
Definition: DeviceBase.h:2311
-
virtual int SetPositionLabel(long pos, const char *label)
Definition: DeviceBase.h:2332
-
virtual int GetPosition(long &pos) const
Definition: DeviceBase.h:2280
-
int OnLabel(MM::PropertyBase *pProp, MM::ActionType eAct)
Definition: DeviceBase.h:2382
-
virtual int SetPosition(const char *label)
Definition: DeviceBase.h:2241
-
int OnStateChanged(long position)
Definition: DeviceBase.h:2463
-
virtual int GetLabelPosition(const char *label, long &pos) const
Definition: DeviceBase.h:2368
-
virtual int SetPosition(long pos)
Definition: DeviceBase.h:2232
-
virtual int SetGateOpen(bool open)
Definition: DeviceBase.h:2257
-
Definition: DeviceBase.h:1820
-
virtual int SetAdapterOriginUm(double newXUm, double newYUm)
Definition: DeviceBase.h:1894
-
virtual int AddToXYStageSequence(double, double)
Definition: DeviceBase.h:1992
-
virtual int SetYOrigin()
Definition: DeviceBase.h:1967
-
double GetCachedXUm()
Definition: DeviceBase.h:2011
-
virtual int SendXYStageSequence()
Definition: DeviceBase.h:1997
-
virtual int SetRelativePositionSteps(long x, long y)
Definition: DeviceBase.h:1947
-
virtual int SetRelativePositionUm(double dx, double dy)
Definition: DeviceBase.h:1866
-
virtual int ClearXYStageSequence()
Definition: DeviceBase.h:1987
-
virtual int SetXOrigin()
Definition: DeviceBase.h:1962
-
Definition: DeviceBase.h:2165
-
virtual unsigned GetNumberOfInstalledDevices()
Definition: DeviceBase.h:2183
-
virtual int DetectInstalledDevices()
Definition: DeviceBase.h:2177
-
virtual void ClearInstalledDevices()
Definition: DeviceBase.h:2195
-
virtual MM::Device * GetInstalledDevice(int devIdx)
Definition: DeviceBase.h:2189
-
Definition: Property.h:107
-
Definition: Property.h:75
-
Definition: Property.h:86
+
virtual void AddTag(const char *key, const char *deviceLabel, const char *value)
Definition DeviceBase.h:1468
+
virtual const unsigned char * GetImageBuffer(unsigned)
Definition DeviceBase.h:1396
+
virtual const unsigned int * GetImageBufferAsRGB32()
Definition DeviceBase.h:1403
+
virtual void GetTags(char *serializedMetadata)
Definition DeviceBase.h:1411
+
virtual int GetChannelName(unsigned, char *name)
Definition DeviceBase.h:1386
+
Definition DeviceBase.h:93
+
virtual bool GetErrorText(int errorCode, char *text) const
Definition DeviceBase.h:750
+
virtual bool GetPropertyName(unsigned uIdx, char *name) const
Definition DeviceBase.h:485
+
int CreateStringProperty(const char *name, const char *value, bool readOnly, MM::ActionFunctor *pAct=0, bool isPreInitProperty=false)
Definition DeviceBase.h:636
+
void InitializeDefaultErrorMessages()
Definition DeviceBase.h:910
+
int LogMessageCode(const int errorCode, bool debugOnly=false) const
Definition DeviceBase.h:865
+
bool IsPropertyEqualTo(const char *name, const char *val) const
Definition DeviceBase.h:241
+
int CreateFloatProperty(const char *name, double value, bool readOnly, MM::ActionFunctor *pAct=0, bool isPreInitProperty=false)
Definition DeviceBase.h:618
+
void SetErrorText(int errorCode, const char *text)
Definition DeviceBase.h:821
+
virtual void SetDelayMs(double delay)
Definition DeviceBase.h:173
+
unsigned long GetClockTicksUs()
Definition DeviceBase.h:1134
+
int UpdateStatus()
Definition DeviceBase.h:725
+
int OnPropertiesChanged()
Definition DeviceBase.h:1067
+
int SetPropertyLimits(const char *name, double low, double high)
Definition DeviceBase.h:644
+
int CreateIntegerProperty(const char *name, long value, bool readOnly, MM::ActionFunctor *pAct=0, bool isPreInitProperty=false)
Definition DeviceBase.h:606
+
MM::Hub * GetParentHub() const
Definition DeviceBase.h:1196
+
bool IsCallbackRegistered() const
Definition DeviceBase.h:1156
+
int CreateProperty(const char *name, const char *value, MM::PropertyType eType, bool readOnly, MM::ActionFunctor *pAct=0, bool isPreInitProperty=false)
Definition DeviceBase.h:582
+
int GetProperty(const char *name, long &val)
Definition DeviceBase.h:226
+
int PurgeComPort(const char *portLabel)
Definition DeviceBase.h:1043
+
void EnableDelay(bool state=true)
Definition DeviceBase.h:1172
+
virtual int StartPropertySequence(const char *name)
Definition DeviceBase.h:390
+
int LogTimeDiff(MM::MMTime start, MM::MMTime end, bool debugOnly=false) const
Definition DeviceBase.h:902
+
void CreateHubIDProperty()
Definition DeviceBase.h:1183
+
virtual void SetModuleHandle(HDEVMODULE hModule)
Definition DeviceBase.h:139
+
void GetLoadedDeviceOfType(MM::DeviceType devType, char *deviceName, const unsigned int deviceIterator)
Definition DeviceBase.h:972
+
int ClearAllowedValues(const char *name)
Definition DeviceBase.h:674
+
int LogMessage(const char *msg, bool debugOnly=false) const
Definition DeviceBase.h:841
+
int OnPropertyChanged(const char *propName, const char *propValue)
Definition DeviceBase.h:1077
+
virtual double GetDelayMs() const
Definition DeviceBase.h:166
+
virtual int ClearPropertySequence(const char *name)
Definition DeviceBase.h:440
+
virtual bool HasProperty(const char *name) const
Definition DeviceBase.h:528
+
int GetSerialAnswer(const char *portName, const char *term, std::string &ans)
Definition DeviceBase.h:1014
+
MM::Core * GetCoreCallback() const
Definition DeviceBase.h:1164
+
virtual bool UsesDelay()
Definition DeviceBase.h:184
+
int UpdateProperty(const char *name)
Definition DeviceBase.h:733
+
T_HUB * AssignToHub()
Definition DeviceBase.h:1209
+
virtual int AddToPropertySequence(const char *name, const char *value)
Definition DeviceBase.h:454
+
MM::PortType GetSerialPortType(const char *portLabel)
Definition DeviceBase.h:1053
+
virtual int GetPropertySequenceMaxLength(const char *name, long &nrEvents) const
Definition DeviceBase.h:362
+
MM::MMTime GetCurrentMMTime()
Definition DeviceBase.h:1145
+
virtual int StopPropertySequence(const char *name)
Definition DeviceBase.h:416
+
virtual void SetModuleName(const char *name)
Definition DeviceBase.h:107
+
virtual unsigned GetNumberOfPropertyValues(const char *propertyName) const
Definition DeviceBase.h:542
+
virtual int SetProperty(const char *name, const char *value)
Definition DeviceBase.h:513
+
virtual HDEVMODULE GetModuleHandle() const
Definition DeviceBase.h:102
+
virtual int SendPropertySequence(const char *name)
Definition DeviceBase.h:469
+
virtual void GetLabel(char *name) const
Definition DeviceBase.h:156
+
int LogMessage(const std::string &msg, bool debugOnly=false) const
Definition DeviceBase.h:853
+
virtual void GetDescription(char *name) const
Definition DeviceBase.h:131
+
int WriteToComPort(const char *portLabel, const unsigned char *buf, unsigned bufLength)
Definition DeviceBase.h:985
+
virtual void SetLabel(const char *label)
Definition DeviceBase.h:146
+
virtual bool GetPropertyValueAt(const char *propertyName, unsigned index, char *value) const
Definition DeviceBase.h:558
+
virtual void GetModuleName(char *name) const
Definition DeviceBase.h:115
+
int SendSerialCommand(const char *portName, const char *command, const char *term)
Definition DeviceBase.h:999
+
int GetPropertyData(const char *name, const char *value, long &data)
Definition DeviceBase.h:698
+
int GetCurrentPropertyData(const char *name, long &data)
Definition DeviceBase.h:711
+
virtual unsigned GetNumberOfProperties() const
Definition DeviceBase.h:189
+
virtual int GetProperty(const char *name, char *value) const
Definition DeviceBase.h:196
+
int ApplyProperty(const char *name)
Definition DeviceBase.h:742
+
virtual int GetPropertyType(const char *name, MM::PropertyType &pt) const
Definition DeviceBase.h:498
+
int ReadFromComPort(const char *portLabel, unsigned char *buf, unsigned bufLength, unsigned long &read)
Definition DeviceBase.h:1033
+
virtual int GetPropertyInitStatus(const char *name, bool &preInit) const
Definition DeviceBase.h:275
+
int LogTimeDiff(MM::MMTime start, MM::MMTime end, const std::string &message, bool debugOnly=false) const
Definition DeviceBase.h:885
+
virtual void SetDescription(const char *descr)
Definition DeviceBase.h:123
+
virtual int GetPropertyLowerLimit(const char *name, double &lowLimit) const
Definition DeviceBase.h:307
+
virtual int GetPropertyUpperLimit(const char *name, double &hiLimit) const
Definition DeviceBase.h:325
+
virtual int GetPropertyReadOnly(const char *name, bool &readOnly) const
Definition DeviceBase.h:256
+
int GetProperty(const char *name, double &val)
Definition DeviceBase.h:212
+
MM::Device * GetDevice(const char *deviceLabel) const
Definition DeviceBase.h:953
+
int AddAllowedValue(const char *name, const char *value)
Definition DeviceBase.h:682
+
int SetAllowedValues(const char *name, std::vector< std::string > &values)
Definition DeviceBase.h:666
+
int AddAllowedValue(const char *name, const char *value, long data)
Definition DeviceBase.h:690
+
int CreatePropertyWithHandler(const char *name, const char *value, MM::PropertyType eType, bool readOnly, int(U::*memberFunction)(MM::PropertyBase *pProp, MM::ActionType eAct), bool isPreInitProperty=false)
Definition DeviceBase.h:597
+
virtual int IsPropertySequenceable(const char *name, bool &sequenceable) const
Definition DeviceBase.h:343
+
virtual void SetCallback(MM::Core *cbk)
Definition DeviceBase.h:178
+
static const char * ConvertToString(long lnVal)
Definition DeviceUtils.cpp:63
+
static bool CopyLimitedString(char *pszTarget, const char *pszSource)
Definition DeviceUtils.cpp:43
+
Definition DeviceBase.h:2155
+
Definition DeviceBase.h:1279
+
Definition DeviceBase.h:2066
+
Definition DeviceBase.h:2108
+
Definition DeviceBase.h:2116
+
Definition DeviceBase.h:2049
+
Definition DeviceBase.h:2041
+
Definition DeviceBase.h:2074
+
Definition DeviceBase.h:1723
+
Definition DeviceBase.h:2216
+
virtual int GetPosition(char *label) const
Definition DeviceBase.h:2298
+
virtual int GetPositionLabel(long pos, char *label) const
Definition DeviceBase.h:2311
+
virtual int SetPositionLabel(long pos, const char *label)
Definition DeviceBase.h:2332
+
virtual int GetPosition(long &pos) const
Definition DeviceBase.h:2280
+
int OnLabel(MM::PropertyBase *pProp, MM::ActionType eAct)
Definition DeviceBase.h:2382
+
virtual int SetPosition(const char *label)
Definition DeviceBase.h:2241
+
int OnStateChanged(long position)
Definition DeviceBase.h:2463
+
virtual int GetLabelPosition(const char *label, long &pos) const
Definition DeviceBase.h:2368
+
virtual int SetPosition(long pos)
Definition DeviceBase.h:2232
+
virtual int SetGateOpen(bool open)
Definition DeviceBase.h:2257
+
Definition DeviceBase.h:1820
+
virtual int SetAdapterOriginUm(double newXUm, double newYUm)
Definition DeviceBase.h:1894
+
virtual int AddToXYStageSequence(double, double)
Definition DeviceBase.h:1992
+
virtual int SetYOrigin()
Definition DeviceBase.h:1967
+
double GetCachedXUm()
Definition DeviceBase.h:2011
+
virtual int SendXYStageSequence()
Definition DeviceBase.h:1997
+
virtual int SetRelativePositionSteps(long x, long y)
Definition DeviceBase.h:1947
+
virtual int SetRelativePositionUm(double dx, double dy)
Definition DeviceBase.h:1866
+
virtual int ClearXYStageSequence()
Definition DeviceBase.h:1987
+
virtual int SetXOrigin()
Definition DeviceBase.h:1962
+
Definition DeviceBase.h:2165
+
virtual unsigned GetNumberOfInstalledDevices()
Definition DeviceBase.h:2183
+
virtual int DetectInstalledDevices()
Definition DeviceBase.h:2177
+
virtual void ClearInstalledDevices()
Definition DeviceBase.h:2195
+
virtual MM::Device * GetInstalledDevice(int devIdx)
Definition DeviceBase.h:2189
+
Definition Property.h:107
+
+
+
Definition MMDevice.h:332
virtual int GetBinning() const =0
-
Definition: MMDevice.h:1314
+
Definition MMDevice.h:1314
virtual int OnMagnifierChanged(const Device *caller)=0
-
virtual Device * GetDevice(const Device *caller, const char *label)=0
virtual int OnStagePositionChanged(const Device *caller, double pos)=0
virtual void GetLoadedDeviceOfType(const Device *caller, MM::DeviceType devType, char *pDeviceName, const unsigned int deviceIterator)=0
Get the names of currently loaded devices of a given type.
virtual int OnExposureChanged(const Device *caller, double newExposure)=0
virtual int LogMessage(const Device *caller, const char *msg, bool debugOnly) const =0
virtual int OnXYStagePositionChanged(const Device *caller, double xPos, double yPos)=0
+
virtual Device * GetDevice(const Device *caller, const char *label)=0
virtual int OnPropertyChanged(const Device *caller, const char *propName, const char *propValue)=0
virtual int OnSLMExposureChanged(const Device *caller, double newExposure)=0
-
Definition: MMDevice.h:225
-
Definition: MMDevice.h:1259
-
Definition: MMDevice.h:91
-
Definition: Property.h:38
-
Definition: Property.h:435
-
Definition: Property.h:143
-
Definition: DeviceThreads.h:34
-
Definition: DeviceThreads.h:158
-
Definition: DeviceThreads.h:95
-
+
Definition MMDevice.h:225
+
Definition MMDevice.h:1259
+
+
+
Definition Property.h:435
+
Definition Property.h:143
+
Definition DeviceThreads.h:34
+
Definition DeviceThreads.h:158
+
Definition DeviceThreads.h:95
+
1.9.1
+Generated by 
Public Types inherited from 