Consolidate port name retrieval methods

bparks13 · bparks13 · commit 241b191483ef · 2025-06-30T16:37:06.000-04:00
diff --git a/Source/Devices/Bno055.cpp b/Source/Devices/Bno055.cpp
@@ -29,7 +29,7 @@ Bno055::Bno055(std::string name, std::string hubName, const oni_dev_idx_t device
 {
 	auto streamIdentifier = getStreamIdentifier();
 
-	std::string port = getPortNameFromIndex(deviceIdx);
+	std::string port = getPortName(deviceIdx);
 	StreamInfo eulerAngleStream = StreamInfo(
 		OnixDevice::createStreamName({ port, getHubName(), getName(), "Euler" }),
 		"Bosch Bno055 9-axis inertial measurement unit (IMU) Euler angle",
diff --git a/Source/Devices/Neuropixels1e.cpp b/Source/Devices/Neuropixels1e.cpp
@@ -79,7 +79,7 @@ void NeuropixelsV1eBackgroundUpdater::run()
 Neuropixels1e::Neuropixels1e(std::string name, std::string hubName, const oni_dev_idx_t deviceIdx_, std::shared_ptr<Onix1> ctx_) :
 	Neuropixels1(name, hubName, OnixDeviceType::NEUROPIXELSV1E, deviceIdx_, ctx_)
 {
-	std::string port = getPortNameFromIndex(getDeviceIdx());
+	std::string port = getPortName(getDeviceIdx());
 	StreamInfo apStream = StreamInfo(
 		OnixDevice::createStreamName({ port, getHubName(), getName(), STREAM_NAME_AP }),
 		"Neuropixels 1.0 AP band data stream",
diff --git a/Source/Devices/Neuropixels1f.cpp b/Source/Devices/Neuropixels1f.cpp
@@ -66,7 +66,7 @@ void NeuropixelsV1fBackgroundUpdater::run()
 Neuropixels1f::Neuropixels1f(std::string name, std::string hubName, const oni_dev_idx_t deviceIdx_, std::shared_ptr<Onix1> ctx_) :
 	Neuropixels1(name, hubName, OnixDeviceType::NEUROPIXELSV1F, deviceIdx_, ctx_)
 {
-	std::string port = getPortNameFromIndex(deviceIdx);
+	std::string port = getPortName(deviceIdx);
 	StreamInfo apStream = StreamInfo(
 		OnixDevice::createStreamName({ port, getHubName(), getName(), STREAM_NAME_AP }),
 		"Neuropixels 1.0 AP band data stream",
diff --git a/Source/Devices/Neuropixels2e.cpp b/Source/Devices/Neuropixels2e.cpp
@@ -43,7 +43,7 @@ Neuropixels2e::Neuropixels2e(std::string name, std::string hubName, const oni_de
 void Neuropixels2e::createDataStream(int n)
 {
 	StreamInfo apStream = StreamInfo(
-		OnixDevice::createStreamName({ getPortNameFromIndex(getDeviceIdx()), getHubName(), "Probe" + std::to_string(n) }),
+		OnixDevice::createStreamName({ getPortName(getDeviceIdx()), getHubName(), "Probe" + std::to_string(n) }),
 		"Neuropixels 2.0 data stream",
 		getStreamIdentifier(),
 		numberOfChannels,
diff --git a/Source/Devices/PolledBno055.cpp b/Source/Devices/PolledBno055.cpp
@@ -30,7 +30,7 @@ PolledBno055::PolledBno055(std::string name, std::string hubName, const oni_dev_
 {
 	auto streamIdentifier = getStreamIdentifier();
 
-	std::string port = getPortNameFromIndex(deviceIdx);
+	std::string port = getPortName(deviceIdx);
 	StreamInfo eulerAngleStream = StreamInfo(
 		OnixDevice::createStreamName({ port, getHubName(), getName(), "Euler" }),
 		"Bosch Bno055 9-axis inertial measurement unit (IMU) Euler angle",
diff --git a/Source/Onix1.cpp b/Source/Onix1.cpp
@@ -87,7 +87,7 @@ std::map<int, int> Onix1::getHubIds(device_map_t deviceTable) const
 
 	auto deviceIndices = getDeviceIndices(deviceTable);
 
-	auto offsets = OnixDevice::getUniqueOffsetsFromIndices(deviceIndices, false);
+	auto offsets = OnixDevice::getUniqueOffsets(deviceIndices, false);
 
 	for (int i = 0; i < offsets.size(); i++)
 	{
@@ -111,7 +111,7 @@ std::vector<int> Onix1::getDeviceIndices(device_map_t deviceMap, int hubIndex)
 
 	for (const auto& [idx, dev] : deviceMap)
 	{
-		if (dev.id != ONIX_NULL && (hubIndex == -1 || OnixDevice::getOffsetFromIndex(dev.idx) == hubIndex))
+		if (dev.id != ONIX_NULL && (hubIndex == -1 || OnixDevice::getOffset(dev.idx) == hubIndex))
 			deviceIndices.emplace_back(idx);
 	}
 
diff --git a/Source/OnixDevice.cpp b/Source/OnixDevice.cpp
@@ -173,28 +173,28 @@ std::string OnixDevice::getPortName(PortName port)
 	return getPortName(getPortOffset(port));
 }
 
-std::string OnixDevice::getPortNameFromIndex(oni_dev_idx_t index)
+std::string OnixDevice::getPortName(oni_dev_idx_t index)
 {
-	return getPortName(getOffsetFromIndex(index));
+	return getPortName(getOffset(index));
 }
 
 PortName OnixDevice::getPortFromIndex(oni_dev_idx_t index)
 {
 	return index & (1 << 8) ? PortName::PortA : PortName::PortB;
 }
 
-int OnixDevice::getOffsetFromIndex(oni_dev_idx_t index)
+int OnixDevice::getOffset(oni_dev_idx_t index)
 {
 	return index & 0x0000FF00;
 }
 
-std::vector<int> OnixDevice::getUniqueOffsetsFromIndices(std::vector<int> indices, bool ignoreBreakoutBoard)
+std::vector<int> OnixDevice::getUniqueOffsets(std::vector<int> indices, bool ignoreBreakoutBoard)
 {
 	std::set<int> offsets;
 
 	for (auto index : indices)
 	{
-		auto offset = getOffsetFromIndex(index);
+		auto offset = getOffset(index);
 
 		if (offset == HubAddressBreakoutBoard && ignoreBreakoutBoard) continue;
 
@@ -204,7 +204,19 @@ std::vector<int> OnixDevice::getUniqueOffsetsFromIndices(std::vector<int> indice
 	return std::vector<int>(offsets.begin(), offsets.end());
 }
 
-Array<PortName> OnixDevice::getUniquePortsFromIndices(std::vector<int> indices)
+std::vector<int> OnixDevice::getUniqueOffsets(OnixDeviceMap devices, bool ignoreBreakoutBoard)
+{
+	std::vector<int> indices;
+
+	for (const auto& [key, _] : devices) 
+	{ 
+		indices.emplace_back(key);
+	}
+
+	return getUniqueOffsets(indices, ignoreBreakoutBoard);
+}
+
+Array<PortName> OnixDevice::getUniquePorts(std::vector<int> indices)
 {
 	Array<PortName> ports;
 
diff --git a/Source/OnixDevice.h b/Source/OnixDevice.h
@@ -168,6 +168,7 @@ namespace OnixSourcePlugin
 		bool isEnabled() const { return enabled; }
 
 		void setEnabled(bool newState) { enabled = newState; }
+		oni_dev_idx_t getDeviceIdx(bool getPassthroughIndex = false);
 
 		virtual int configureDevice() { return -1; };
 
@@ -180,8 +181,6 @@ namespace OnixSourcePlugin
 		/** Given the sourceBuffers from OnixSource, add all streams for the current device to the array */
 		virtual void addSourceBuffers(OwnedArray<DataBuffer>& sourceBuffers) {};
 
-		oni_dev_idx_t getDeviceIdx(bool getPassthroughIndex = false);
-
 		/** Creates a stream name using the provided inputs, returning a string following the pattern: name[0]-name[1]-name[2]-etc., with all spaces removed */
 		static std::string createStreamName(std::vector<std::string> names);
 
@@ -199,11 +198,12 @@ namespace OnixSourcePlugin
 		static int getPortOffset(PortName port);
 		static std::string getPortName(int offset);
 		static std::string getPortName(PortName port);
-		static std::string getPortNameFromIndex(oni_dev_idx_t index);
+		static std::string getPortName(oni_dev_idx_t index);
 		static PortName getPortFromIndex(oni_dev_idx_t index);
-		static int getOffsetFromIndex(oni_dev_idx_t index);
-		static std::vector<int> getUniqueOffsetsFromIndices(std::vector<int> indices, bool ignoreBreakoutBoard = true);
-		static Array<PortName> getUniquePortsFromIndices(std::vector<int> indices);
+		static int getOffset(oni_dev_idx_t index);
+		static std::vector<int> getUniqueOffsets(std::vector<int> indices, bool ignoreBreakoutBoard = true);
+		static std::vector<int> getUniqueOffsets(OnixDeviceMap devices, bool ignoreBreakoutBoard = true);
+		static Array<PortName> getUniquePorts(std::vector<int> indices);
 
 		OnixDeviceType getDeviceType() const;
 
diff --git a/Source/OnixSource.cpp b/Source/OnixSource.cpp
@@ -404,7 +404,7 @@ bool OnixSource::initializeDevices(device_map_t deviceTable, bool updateStreamIn
 				polledBno->setBnoAxisMap(PolledBno055::Bno055AxisMap::YZX);
 				polledBno->setBnoAxisSign((uint32_t)(PolledBno055::Bno055AxisSign::MirrorX) | (uint32_t)(PolledBno055::Bno055AxisSign::MirrorY));
 
-				hubNames.insert({ PortController::getOffsetFromIndex(polledBno->getDeviceIdx()), NEUROPIXELSV2E_HEADSTAGE_NAME });
+				hubNames.insert({ PortController::getOffset(polledBno->getDeviceIdx()), NEUROPIXELSV2E_HEADSTAGE_NAME });
 			}
 			else if (hsid == 0xFFFFFFFF || hsid == ONIX_HUB_HSNP1ET || hsid == ONIX_HUB_HSNP1EH)
 			{
@@ -437,7 +437,7 @@ bool OnixSource::initializeDevices(device_map_t deviceTable, bool updateStreamIn
 				polledBno->setBnoAxisMap(PolledBno055::Bno055AxisMap::YZX);
 				polledBno->setBnoAxisSign((uint32_t)(PolledBno055::Bno055AxisSign::MirrorX) | (uint32_t)(PolledBno055::Bno055AxisSign::MirrorZ));
 
-				hubNames.insert({ PortController::getOffsetFromIndex(polledBno->getDeviceIdx()), NEUROPIXELSV1E_HEADSTAGE_NAME });
+				hubNames.insert({ PortController::getOffset(polledBno->getDeviceIdx()), NEUROPIXELSV1E_HEADSTAGE_NAME });
 			}
 		}
 	}
@@ -555,11 +555,11 @@ OnixDeviceVector OnixSource::getEnabledDataSources()
 OnixDeviceVector OnixSource::getDataSourcesFromOffset(int offset)
 {
 	OnixDeviceVector devices{};
-	offset = PortController::getOffsetFromIndex(offset);
+	offset = PortController::getOffset(offset);
 
 	for (const auto& source : sources)
 	{
-		if (PortController::getOffsetFromIndex(source->getDeviceIdx()) == offset)
+		if (PortController::getOffset(source->getDeviceIdx()) == offset)
 			devices.emplace_back(source);
 	}
 
@@ -770,7 +770,7 @@ void OnixSource::updateSettings(OwnedArray<ContinuousChannel>* continuousChannel
 				deviceInfos->add(new DeviceInfo(deviceSettings));
 
 				DataStream::Settings dataStreamSettings{
-					OnixDevice::createStreamName({OnixDevice::getPortNameFromIndex(source->getDeviceIdx()), source->getHubName(), source->getName()}),
+					OnixDevice::createStreamName({OnixDevice::getPortName(source->getDeviceIdx()), source->getHubName(), source->getName()}),
 					"Continuous data from a Bno055 9-axis IMU",
 					source->getStreamIdentifier(),
 					source->streamInfos[0].getSampleRate()

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ Bno055::Bno055(std::string name, std::string hubName, const oni_dev_idx_t device`
`29`	`29`	`{`
`30`	`30`	`auto streamIdentifier = getStreamIdentifier();`
`31`	`31`
`32`		`- std::string port = getPortNameFromIndex(deviceIdx);`
	`32`	`+ std::string port = getPortName(deviceIdx);`
`33`	`33`	`StreamInfo eulerAngleStream = StreamInfo(`
`34`	`34`	`OnixDevice::createStreamName({ port, getHubName(), getName(), "Euler" }),`
`35`	`35`	`"Bosch Bno055 9-axis inertial measurement unit (IMU) Euler angle",`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ void NeuropixelsV1eBackgroundUpdater::run()`
`79`	`79`	`Neuropixels1e::Neuropixels1e(std::string name, std::string hubName, const oni_dev_idx_t deviceIdx_, std::shared_ptr<Onix1> ctx_) :`
`80`	`80`	`Neuropixels1(name, hubName, OnixDeviceType::NEUROPIXELSV1E, deviceIdx_, ctx_)`
`81`	`81`	`{`
`82`		`- std::string port = getPortNameFromIndex(getDeviceIdx());`
	`82`	`+ std::string port = getPortName(getDeviceIdx());`
`83`	`83`	`StreamInfo apStream = StreamInfo(`
`84`	`84`	`OnixDevice::createStreamName({ port, getHubName(), getName(), STREAM_NAME_AP }),`
`85`	`85`	`"Neuropixels 1.0 AP band data stream",`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ void NeuropixelsV1fBackgroundUpdater::run()`
`66`	`66`	`Neuropixels1f::Neuropixels1f(std::string name, std::string hubName, const oni_dev_idx_t deviceIdx_, std::shared_ptr<Onix1> ctx_) :`
`67`	`67`	`Neuropixels1(name, hubName, OnixDeviceType::NEUROPIXELSV1F, deviceIdx_, ctx_)`
`68`	`68`	`{`
`69`		`- std::string port = getPortNameFromIndex(deviceIdx);`
	`69`	`+ std::string port = getPortName(deviceIdx);`
`70`	`70`	`StreamInfo apStream = StreamInfo(`
`71`	`71`	`OnixDevice::createStreamName({ port, getHubName(), getName(), STREAM_NAME_AP }),`
`72`	`72`	`"Neuropixels 1.0 AP band data stream",`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ Neuropixels2e::Neuropixels2e(std::string name, std::string hubName, const oni_de`
`43`	`43`	`void Neuropixels2e::createDataStream(int n)`
`44`	`44`	`{`
`45`	`45`	`StreamInfo apStream = StreamInfo(`
`46`		`- OnixDevice::createStreamName({ getPortNameFromIndex(getDeviceIdx()), getHubName(), "Probe" + std::to_string(n) }),`
	`46`	`+ OnixDevice::createStreamName({ getPortName(getDeviceIdx()), getHubName(), "Probe" + std::to_string(n) }),`
`47`	`47`	`"Neuropixels 2.0 data stream",`
`48`	`48`	`getStreamIdentifier(),`
`49`	`49`	`numberOfChannels,`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ PolledBno055::PolledBno055(std::string name, std::string hubName, const oni_dev_`
`30`	`30`	`{`
`31`	`31`	`auto streamIdentifier = getStreamIdentifier();`
`32`	`32`
`33`		`- std::string port = getPortNameFromIndex(deviceIdx);`
	`33`	`+ std::string port = getPortName(deviceIdx);`
`34`	`34`	`StreamInfo eulerAngleStream = StreamInfo(`
`35`	`35`	`OnixDevice::createStreamName({ port, getHubName(), getName(), "Euler" }),`
`36`	`36`	`"Bosch Bno055 9-axis inertial measurement unit (IMU) Euler angle",`
Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ std::map<int, int> Onix1::getHubIds(device_map_t deviceTable) const`
`87`	`87`
`88`	`88`	`auto deviceIndices = getDeviceIndices(deviceTable);`
`89`	`89`
`90`		`- auto offsets = OnixDevice::getUniqueOffsetsFromIndices(deviceIndices, false);`
	`90`	`+ auto offsets = OnixDevice::getUniqueOffsets(deviceIndices, false);`
`91`	`91`
`92`	`92`	`for (int i = 0; i < offsets.size(); i++)`
`93`	`93`	`{`
`@@ -111,7 +111,7 @@ std::vector<int> Onix1::getDeviceIndices(device_map_t deviceMap, int hubIndex)`
`111`	`111`
`112`	`112`	`for (const auto& [idx, dev] : deviceMap)`
`113`	`113`	`{`
`114`		`- if (dev.id != ONIX_NULL && (hubIndex == -1 \|\| OnixDevice::getOffsetFromIndex(dev.idx) == hubIndex))`
	`114`	`+ if (dev.id != ONIX_NULL && (hubIndex == -1 \|\| OnixDevice::getOffset(dev.idx) == hubIndex))`
`115`	`115`	`deviceIndices.emplace_back(idx);`
`116`	`116`	`}`
`117`	`117`
Original file line number	Diff line number	Diff line change
`@@ -173,28 +173,28 @@ std::string OnixDevice::getPortName(PortName port)`
`173`	`173`	`return getPortName(getPortOffset(port));`
`174`	`174`	`}`
`175`	`175`
`176`		`-std::string OnixDevice::getPortNameFromIndex(oni_dev_idx_t index)`
	`176`	`+std::string OnixDevice::getPortName(oni_dev_idx_t index)`
`177`	`177`	`{`
`178`		`- return getPortName(getOffsetFromIndex(index));`
	`178`	`+ return getPortName(getOffset(index));`
`179`	`179`	`}`
`180`	`180`
`181`	`181`	`PortName OnixDevice::getPortFromIndex(oni_dev_idx_t index)`
`182`	`182`	`{`
`183`	`183`	`return index & (1 << 8) ? PortName::PortA : PortName::PortB;`
`184`	`184`	`}`
`185`	`185`
`186`		`-int OnixDevice::getOffsetFromIndex(oni_dev_idx_t index)`
	`186`	`+int OnixDevice::getOffset(oni_dev_idx_t index)`
`187`	`187`	`{`
`188`	`188`	`return index & 0x0000FF00;`
`189`	`189`	`}`
`190`	`190`
`191`		`-std::vector<int> OnixDevice::getUniqueOffsetsFromIndices(std::vector<int> indices, bool ignoreBreakoutBoard)`
	`191`	`+std::vector<int> OnixDevice::getUniqueOffsets(std::vector<int> indices, bool ignoreBreakoutBoard)`
`192`	`192`	`{`
`193`	`193`	`std::set<int> offsets;`
`194`	`194`
`195`	`195`	`for (auto index : indices)`
`196`	`196`	`{`
`197`		`- auto offset = getOffsetFromIndex(index);`
	`197`	`+ auto offset = getOffset(index);`
`198`	`198`
`199`	`199`	`if (offset == HubAddressBreakoutBoard && ignoreBreakoutBoard) continue;`
`200`	`200`
`@@ -204,7 +204,19 @@ std::vector<int> OnixDevice::getUniqueOffsetsFromIndices(std::vector<int> indice`
`204`	`204`	`return std::vector<int>(offsets.begin(), offsets.end());`
`205`	`205`	`}`
`206`	`206`
`207`		`-Array<PortName> OnixDevice::getUniquePortsFromIndices(std::vector<int> indices)`
	`207`	`+std::vector<int> OnixDevice::getUniqueOffsets(OnixDeviceMap devices, bool ignoreBreakoutBoard)`
	`208`	`+{`
	`209`	`+ std::vector<int> indices;`
	`210`	`+`
	`211`	`+ for (const auto& [key, _] : devices)`
	`212`	`+ {`
	`213`	`+ indices.emplace_back(key);`
	`214`	`+ }`
	`215`	`+`
	`216`	`+ return getUniqueOffsets(indices, ignoreBreakoutBoard);`
	`217`	`+}`
	`218`	`+`
	`219`	`+Array<PortName> OnixDevice::getUniquePorts(std::vector<int> indices)`
`208`	`220`	`{`
`209`	`221`	`Array<PortName> ports;`
`210`	`222`
Original file line number	Diff line number	Diff line change
`@@ -404,7 +404,7 @@ bool OnixSource::initializeDevices(device_map_t deviceTable, bool updateStreamIn`
`404`	`404`	`polledBno->setBnoAxisMap(PolledBno055::Bno055AxisMap::YZX);`
`405`	`405`	`polledBno->setBnoAxisSign((uint32_t)(PolledBno055::Bno055AxisSign::MirrorX) \| (uint32_t)(PolledBno055::Bno055AxisSign::MirrorY));`
`406`	`406`
`407`		`- hubNames.insert({ PortController::getOffsetFromIndex(polledBno->getDeviceIdx()), NEUROPIXELSV2E_HEADSTAGE_NAME });`
	`407`	`+ hubNames.insert({ PortController::getOffset(polledBno->getDeviceIdx()), NEUROPIXELSV2E_HEADSTAGE_NAME });`
`408`	`408`	`}`
`409`	`409`	`else if (hsid == 0xFFFFFFFF \|\| hsid == ONIX_HUB_HSNP1ET \|\| hsid == ONIX_HUB_HSNP1EH)`
`410`	`410`	`{`
`@@ -437,7 +437,7 @@ bool OnixSource::initializeDevices(device_map_t deviceTable, bool updateStreamIn`
`437`	`437`	`polledBno->setBnoAxisMap(PolledBno055::Bno055AxisMap::YZX);`
`438`	`438`	`polledBno->setBnoAxisSign((uint32_t)(PolledBno055::Bno055AxisSign::MirrorX) \| (uint32_t)(PolledBno055::Bno055AxisSign::MirrorZ));`
`439`	`439`
`440`		`- hubNames.insert({ PortController::getOffsetFromIndex(polledBno->getDeviceIdx()), NEUROPIXELSV1E_HEADSTAGE_NAME });`
	`440`	`+ hubNames.insert({ PortController::getOffset(polledBno->getDeviceIdx()), NEUROPIXELSV1E_HEADSTAGE_NAME });`
`441`	`441`	`}`
`442`	`442`	`}`
`443`	`443`	`}`
`@@ -555,11 +555,11 @@ OnixDeviceVector OnixSource::getEnabledDataSources()`
`555`	`555`	`OnixDeviceVector OnixSource::getDataSourcesFromOffset(int offset)`
`556`	`556`	`{`
`557`	`557`	`OnixDeviceVector devices{};`
`558`		`- offset = PortController::getOffsetFromIndex(offset);`
	`558`	`+ offset = PortController::getOffset(offset);`
`559`	`559`
`560`	`560`	`for (const auto& source : sources)`
`561`	`561`	`{`
`562`		`- if (PortController::getOffsetFromIndex(source->getDeviceIdx()) == offset)`
	`562`	`+ if (PortController::getOffset(source->getDeviceIdx()) == offset)`
`563`	`563`	`devices.emplace_back(source);`
`564`	`564`	`}`
`565`	`565`
`@@ -770,7 +770,7 @@ void OnixSource::updateSettings(OwnedArray<ContinuousChannel>* continuousChannel`
`770`	`770`	`deviceInfos->add(new DeviceInfo(deviceSettings));`
`771`	`771`
`772`	`772`	`DataStream::Settings dataStreamSettings{`
`773`		`- OnixDevice::createStreamName({OnixDevice::getPortNameFromIndex(source->getDeviceIdx()), source->getHubName(), source->getName()}),`
	`773`	`+ OnixDevice::createStreamName({OnixDevice::getPortName(source->getDeviceIdx()), source->getHubName(), source->getName()}),`
`774`	`774`	`"Continuous data from a Bno055 9-axis IMU",`
`775`	`775`	`source->getStreamIdentifier(),`
`776`	`776`	`source->streamInfos[0].getSampleRate()`