NDEVR
API Documentation
RealSenseScannerFactory

Factory for discovering and connecting to RealSense 3D scanners. More...

Collaboration diagram for RealSenseScannerFactory:
[legend]

Public Member Functions

void addRemoteAddress (const String &remote)
 Adds a remote device address to the discovery list.
virtual Scanner3D * connectToScanner (QPointer< Connection > connection_to_try, DesignObjectLookup *lookup) const override
 Creates a scanner from an established connection.
virtual Buffer< QPointer< Connection > > possibleConnections (const HardwareSearchPathParameters &params) const override
 Returns all possible connections (local and remote).
virtual Buffer< QPointer< Connection > > possibleLocalConnections (const HardwareSearchPathParameters &params) const
 Returns connections to locally attached RealSense devices.
virtual Buffer< QPointer< Connection > > possibleRemoteConnections (const HardwareSearchPathParameters &params) const
 Returns connections to remotely discovered RealSense devices.
void setClient (RealSenseClient *client)
 Sets the RealSense client for remote connections.
void setServoAddress (String port)
 Sets the servo controller address for motorized scanning.

Static Public Member Functions

static RealSenseScannerConnectionCreateRemoteConnection (String ip_address, LogPtr raw_network_log=nullptr, LogPtr log=nullptr)
 Creates a connection to a remote RealSense device.
static RealSenseScannerFactoryDefault ()
 Returns the default factory singleton.
static RealSenseScannerFactorySetupDefault ()
 Sets up and returns the default factory singleton.

Protected Member Functions

 RealSenseScannerFactory ()
 Constructs the factory (protected; use SetupDefault()).
virtual ~RealSenseScannerFactory ()
 Destroys the factory.

Static Protected Member Functions

static rs2::context MainContext ()
 Returns the main RealSense context singleton.

Protected Attributes

RealSenseClientm_client
 The remote client for network-connected scanners.
Buffer< Stringm_remote_connections
 List of remote device addresses.
String m_servo_address
 The servo controller address.

Detailed Description

Factory for discovering and connecting to RealSense 3D scanners.

Discovers local USB-connected and remote network-connected RealSense devices and creates RealSenseScanner instances for them.

Definition at line 51 of file RealSenseScannerFactory.h.

Member Function Documentation

◆ addRemoteAddress()

void RealSenseScannerFactory::addRemoteAddress ( const String & remote)

Adds a remote device address to the discovery list.

Parameters
[in]remoteThe IP address of the remote device.

◆ connectToScanner()

virtual Scanner3D * RealSenseScannerFactory::connectToScanner ( QPointer< Connection > connection_to_try,
DesignObjectLookup * lookup ) const
overridevirtual

Creates a scanner from an established connection.

Parameters
[in]connection_to_tryThe connection to use.
[in]lookupThe design object lookup for scanner models.
Returns
A pointer to the created Scanner3D.

◆ CreateRemoteConnection()

RealSenseScannerConnection * RealSenseScannerFactory::CreateRemoteConnection ( String ip_address,
LogPtr raw_network_log = nullptr,
LogPtr log = nullptr )
static

Creates a connection to a remote RealSense device.

Parameters
[in]ip_addressThe IP address of the remote device.
[in]raw_network_logOptional raw network log.
[in]logOptional general log.
Returns
A pointer to the created connection.

◆ Default()

RealSenseScannerFactory * RealSenseScannerFactory::Default ( )
static

Returns the default factory singleton.

Returns
A pointer to the default factory.

References RealSenseScannerFactory().

◆ MainContext()

rs2::context RealSenseScannerFactory::MainContext ( )
staticprotected

Returns the main RealSense context singleton.

Returns
The main rs2::context.

◆ possibleConnections()

virtual Buffer< QPointer< Connection > > RealSenseScannerFactory::possibleConnections ( const HardwareSearchPathParameters & params) const
overridevirtual

Returns all possible connections (local and remote).

Parameters
[in]paramsSearch parameters for hardware discovery.
Returns
A buffer of discovered connection pointers.

◆ possibleLocalConnections()

virtual Buffer< QPointer< Connection > > RealSenseScannerFactory::possibleLocalConnections ( const HardwareSearchPathParameters & params) const
virtual

Returns connections to locally attached RealSense devices.

Parameters
[in]paramsSearch parameters for hardware discovery.
Returns
A buffer of local connection pointers.

◆ possibleRemoteConnections()

virtual Buffer< QPointer< Connection > > RealSenseScannerFactory::possibleRemoteConnections ( const HardwareSearchPathParameters & params) const
virtual

Returns connections to remotely discovered RealSense devices.

Parameters
[in]paramsSearch parameters for hardware discovery.
Returns
A buffer of remote connection pointers.

◆ setClient()

void RealSenseScannerFactory::setClient ( RealSenseClient * client)

Sets the RealSense client for remote connections.

Parameters
[in]clientThe client to use.

◆ setServoAddress()

void RealSenseScannerFactory::setServoAddress ( String port)

Sets the servo controller address for motorized scanning.

Parameters
[in]portThe serial port or address for the servo controller.

◆ SetupDefault()

RealSenseScannerFactory * RealSenseScannerFactory::SetupDefault ( )
static

Sets up and returns the default factory singleton.

Returns
A pointer to the default factory.

References RealSenseScannerFactory().


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