Class Spinnaker::Relay::SpinnakerRelay

ClassList > Relay > SpinnakerRelay

Spinnaker __Relay class that enables forwarding ofSpinnaker images from source to destination PC.

• #include <SpinnakerRelay.h>

Inherits the following classes: Spinnaker::Relay::ISpinnakerRelay

Public Functions

Type	Name
virtual void	AddSource (CameraPtr pCamera)
virtual void	Connect ()
virtual void	Disconnect ()
virtual ImagePtr	GetNextImage ()
virtual void	GetStatistics (RelayStatistics * statistics)
virtual bool	IsConnected ()
virtual bool	IsConnecting ()
virtual void	RegisterEventHandler (EventHandler & eventHandler)
virtual void	RemoveSource (CameraPtr pCamera)
virtual void	ResetStatistics ()
virtual void	SetConnectParameters (const ConnectParameters connectParam)
virtual void	SetNumBuffers (uint64_t numBuffers)
	SpinnakerRelay ()
	SpinnakerRelay (const SpinnakerRelay & processor)
virtual void	UnregisterEventHandler (EventHandler & eventHandler)
SpinnakerRelay &	operator= (const SpinnakerRelay & processor)
virtual	~SpinnakerRelay ()

Public Functions inherited from Spinnaker::Relay::ISpinnakerRelay

See Spinnaker::Relay::ISpinnakerRelay

Type	Name
virtual void	AddSource (CameraPtr pCamera) = 0
virtual void	Connect () = 0
virtual void	Disconnect () = 0
virtual ImagePtr	GetNextImage () = 0
virtual void	GetStatistics (RelayStatistics * statistics) = 0
virtual bool	IsConnected () = 0
virtual void	RegisterEventHandler (EventHandler & eventHandler) = 0
virtual void	RemoveSource (CameraPtr pCamera) = 0
virtual void	SetConnectParameters (const ConnectParameters connectParam) = 0
virtual void	SetNumBuffers (uint64_t numBuffers) = 0
virtual void	UnregisterEventHandler (EventHandler & eventHandler) = 0
virtual	~ISpinnakerRelay (void)

Protected Attributes inherited from Spinnaker::Relay::ISpinnakerRelay

See Spinnaker::Relay::ISpinnakerRelay

Type	Name
SpinnakerRelayData *	m_pSpinnakerRelayData

Protected Functions inherited from Spinnaker::Relay::ISpinnakerRelay

See Spinnaker::Relay::ISpinnakerRelay

Type	Name
	ISpinnakerRelay ()
	ISpinnakerRelay (const ISpinnakerRelay &)
ISpinnakerRelay &	operator= (const ISpinnakerRelay &)

Public Functions Documentation

function AddSource

virtual void Relay::SpinnakerRelay::AddSource (
    CameraPtr pCamera
) 

Adds a camera as a streaming source to the sender. Images from this camera will be relayed from the sender to the receiver.

Note that cameras may not be added to a receiver as a source. This must be called after SetConnectParameters() in order to set the role to sender.

Parameters:

• pCamera The camera to add as a source.

See also: RemoveSource()

Implements Spinnaker::Relay::ISpinnakerRelay::AddSource

---

function Connect

virtual void Relay::SpinnakerRelay::Connect () 

Initiates a Spinnaker Relay connection. This must be called from both the sender and receiver for the connection to be made.

Note that this must be called after SetConnectParameters() and SetNumBuffers() in order to set the role, other connect parameters, and buffer size.

See also: SetConnectParameters()

See also: SetNumBuffers()

See also: Disconnect()

Implements Spinnaker::Relay::ISpinnakerRelay::Connect

---

function Disconnect

virtual void Relay::SpinnakerRelay::Disconnect () 

Disconnects a Spinnaker Relay connection.

See also: Connect()

Implements Spinnaker::Relay::ISpinnakerRelay::Disconnect

---

function GetNextImage

virtual ImagePtr Relay::SpinnakerRelay::GetNextImage () 

Gets the next image that was received by the receiver.

See also: SetConnectParameters()

See also: Connect()

Returns:

pointer to an Image object

Implements Spinnaker::Relay::ISpinnakerRelay::GetNextImage

---

function GetStatistics

virtual void Relay::SpinnakerRelay::GetStatistics (
    RelayStatistics * statistics
) 

Returns a RelayStatistics struct containing statistics about the performance of the relay connection: e.g. frame rate, data rate, frame counts.

See also: struct RelayStatistics

Parameters:

• statistics A pointer to the struct that will store result

Implements Spinnaker::Relay::ISpinnakerRelay::GetStatistics

---

function IsConnected

virtual bool Relay::SpinnakerRelay::IsConnected () 

Returns a boolean value indicating if this relay is connected.

Returns:

Returns true if the relay is connected.

Implements Spinnaker::Relay::ISpinnakerRelay::IsConnected

---

function IsConnecting

virtual bool Relay::SpinnakerRelay::IsConnecting () 

Returns a boolean value indicating if the relay is currently attempting to connect.

If the relay is not explicitly disconnected using Disconnect(), it will automatically attempt to reconnect unless the connection is re-established or the timeout period specified in SetConnectParameters() expires.

See also: Disconnect()

See also: SetConnectParameters()

See also: struct ConnectParameters

Returns:

Returns true if the relay is attempting to connect.

---

function RegisterEventHandler

virtual void Relay::SpinnakerRelay::RegisterEventHandler (
    EventHandler & eventHandler
) 

Registers an image event handler for the receiver. The relay connect parameters must be set before registering an image event handler, and the role must be receiver.

See also: UnregisterEventHandler()

See also: ImageEventHandler

Parameters:

• eventHandler The event handler to register for the receiver

Implements Spinnaker::Relay::ISpinnakerRelay::RegisterEventHandler

---

function RemoveSource

virtual void Relay::SpinnakerRelay::RemoveSource (
    CameraPtr pCamera
) 

Removes a camera as a streaming source from the sender.

Parameters:

• pCamera The camera to remove as a source.

See also: AddSource()

Implements Spinnaker::Relay::ISpinnakerRelay::RemoveSource

---

function ResetStatistics

virtual void Relay::SpinnakerRelay::ResetStatistics () 

Resets the statistics about the performance of the relay connection: e.g. frame rate, data rate, frame counts. Counts are reset to zero and start timer is reset.

See also: GetStatistics()

---

function SetConnectParameters

virtual void Relay::SpinnakerRelay::SetConnectParameters (
    const ConnectParameters connectParam
) 

Sets relay connect parameters. Spinnaker Relay can operate in the sender or receiver roles.

Note that the connect parameters must be set first, before calling AddSource(), SetNumBuffers(), RegisterEventHandler(), or Connect().

See also: Connect()

See also: struct ConnectParameters

Parameters:

• connectParam Connect parameters to set

Implements Spinnaker::Relay::ISpinnakerRelay::SetConnectParameters

---

function SetNumBuffers

virtual void Relay::SpinnakerRelay::SetNumBuffers (
    uint64_t numBuffers
) 

Sets number of relay buffers.

Note that this must be called after SetConnectParameters().

See also: SetConnectParameters()

Parameters:

• numBuffers Number of relay buffers to set

Implements Spinnaker::Relay::ISpinnakerRelay::SetNumBuffers

---

function SpinnakerRelay [1/2]

Relay::SpinnakerRelay::SpinnakerRelay () 

Default constructor.

---

function SpinnakerRelay [2/2]

Relay::SpinnakerRelay::SpinnakerRelay (
    const SpinnakerRelay & processor
) 

Copy constructor

---

function UnregisterEventHandler

virtual void Relay::SpinnakerRelay::UnregisterEventHandler (
    EventHandler & eventHandler
) 

Unregisters an event handler from the receiver. Event handlers should be unregistered first before calling Disconnect().

See also: RegisterEventHandler()

Parameters:

• eventHandler The event handler to unregister from the receiver

Implements Spinnaker::Relay::ISpinnakerRelay::UnregisterEventHandler

---

function operator=

SpinnakerRelay & Relay::SpinnakerRelay::operator= (
    const SpinnakerRelay & processor
) 

Assignment operator.

---

function ~SpinnakerRelay

virtual Relay::SpinnakerRelay::~SpinnakerRelay () 

Default destructor.

---

---

The documentation for this class was generated from the following file C:/workspace/include/SpinnakerRelay.h