Package org.photonvision.vision.processes

Class PipelineManager

java.lang.Object

org.photonvision.vision.processes.PipelineManager

public class PipelineManager
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CAL_3D_INDEX
protected final Calibrate3dPipeline	calibration3dPipeline
static final int	DRIVERMODE_INDEX
protected final DriverModePipeline	driverModePipeline
static final Comparator<CVPipelineSettings>	PipelineSettingsIndexComparator
protected final List<CVPipelineSettings>	userPipelineSettings

Constructor Summary

Constructors

Constructor	Description
PipelineManager(CameraConfiguration config)

Method Summary

Modifier and Type	Method	Description
CVPipelineSettings	addPipeline(PipelineType type)
CVPipelineSettings	addPipeline(PipelineType type, String nickname)
void	changePipelineType(int newType)
int	duplicatePipeline(int index)	Duplicate a pipeline at a given index
CVPipeline	getCurrentPipeline()	Get the currently active pipeline.
int	getCurrentPipelineIndex()	Gets the index of the currently active pipeline
CVPipelineSettings	getCurrentPipelineSettings()	Get the currently active pipelines settings
boolean	getDriverMode()	Returns whether driver mode is active.
String	getPipelineNickname(int index)	Get the settings for a pipeline by index.
List<String>	getPipelineNicknames()	Gets a list of nicknames for all user pipelines
CVPipelineSettings	getPipelineSettings(int index)	Get the settings for a pipeline by index.
int	getRequestedIndex()	Grab the currently requested pipeline index.
int	removePipeline(int index)
void	renameCurrentPipeline(String newName)
void	setCalibrationMode(boolean wantsCalibration)	Enters or exits calibration mode based on the parameter.
void	setDriverMode(boolean state)	Enters or exits driver mode based on the parameter.
void	setIndex(int index)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DRIVERMODE_INDEX

public static final int DRIVERMODE_INDEX

See Also:

• Constant Field Values

CAL_3D_INDEX

public static final int CAL_3D_INDEX

See Also:

• Constant Field Values

userPipelineSettings

protected final List<CVPipelineSettings> userPipelineSettings

calibration3dPipeline

protected final Calibrate3dPipeline calibration3dPipeline

driverModePipeline

protected final DriverModePipeline driverModePipeline

PipelineSettingsIndexComparator

public static final Comparator<CVPipelineSettings> PipelineSettingsIndexComparator

Constructor Details

PipelineManager

public PipelineManager(CameraConfiguration config)

Method Details

getPipelineSettings

public CVPipelineSettings getPipelineSettings(int index)

Get the settings for a pipeline by index.

Parameters:

index - Index of pipeline whose settings need getting.

Returns:

The gotten settings of the pipeline whose index was provided.

getPipelineNickname

public String getPipelineNickname(int index)

Get the settings for a pipeline by index.

Parameters:

index - Index of pipeline whose nickname needs getting.

Returns:

the nickname of the pipeline whose index was provided.

getPipelineNicknames

public List<String> getPipelineNicknames()

Gets a list of nicknames for all user pipelines

Returns:

The list of nicknames for all user pipelines

getCurrentPipelineIndex

public int getCurrentPipelineIndex()

Gets the index of the currently active pipeline

Returns:

The index of the currently active pipeline

getCurrentPipeline

public CVPipeline getCurrentPipeline()

Get the currently active pipeline.

Returns:

The currently active pipeline.

getCurrentPipelineSettings

public CVPipelineSettings getCurrentPipelineSettings()

Get the currently active pipelines settings

Returns:

The currently active pipelines settings

getRequestedIndex

public int getRequestedIndex()

Grab the currently requested pipeline index. The VisionRunner may not have changed over to this pipeline yet.

setCalibrationMode

public void setCalibrationMode(boolean wantsCalibration)

Enters or exits calibration mode based on the parameter.

Exiting returns to the last used user pipeline.

Parameters:

wantsCalibration - True to enter calibration mode, false to exit calibration mode.

setDriverMode

public void setDriverMode(boolean state)

Enters or exits driver mode based on the parameter.

Exiting returns to the last used user pipeline.

Parameters:

state - True to enter driver mode, false to exit driver mode.

getDriverMode

public boolean getDriverMode()

Returns whether driver mode is active.

Returns:

Whether driver mode is active.

addPipeline

public CVPipelineSettings addPipeline(PipelineType type)

addPipeline

public CVPipelineSettings addPipeline(PipelineType type,
 String nickname)

setIndex

public void setIndex(int index)

removePipeline

public int removePipeline(int index)

renameCurrentPipeline

public void renameCurrentPipeline(String newName)

duplicatePipeline

public int duplicatePipeline(int index)

Duplicate a pipeline at a given index

Parameters:

index - the index of the target pipeline

Returns:

The new index

changePipelineType

public void changePipelineType(int newType)