This class represents a parameter of some type for the PipelineApplication. More...

#include <PipelineApplication.h>

Collaboration diagram for Isis::PipelineParameter:

Public Member Functions
	PipelineParameter (QString paramName)
	Construct the parameter with only a parameter name; affects all branches and is not a special value. More...

	PipelineParameter (QString paramName, QString value)
	Construct the parameter with a parameter name and value; affects all branches and is not special. More...

	PipelineParameter (int branch, QString paramName)
	Construct the parameter with only a parameter name; affects only the specified branch and is not a special value. More...

	PipelineParameter (int branch, QString paramName, QString paramValue)
	Construct the parameter with a parameter name and value; affects only the specified branch and is not a special value. More...

	PipelineParameter (QString paramName, PipelineApplication::CustomParameterValue special)
	Construct the parameter with a parameter name and special value; affects all branches. More...

	PipelineParameter (int branch, QString paramName, PipelineApplication::CustomParameterValue special)
	Construct the parameter with a parameter name and special value; affects only the specified branch. More...

bool	AppliesToBranch (int branch)
	Returns whether or not the specified branch is affected. More...

QString	Name ()
	Name of the parameter. More...

QString	Value ()
	Non-special value of the parameter. More...

bool	IsSpecial ()
	True if the parameter value is special. More...

PipelineApplication::CustomParameterValue	Special ()
	Special value of the parameter. More...

bool	AffectsAllBranches ()
	True if branch-independant. More...

Private Attributes
int	p_branch
	Branch this affects. More...

QString	p_paramName
	Parameter name. More...

QString	p_paramValue
	Parameter non-special value. More...

PipelineApplication::CustomParameterValue	p_special
	Parameter special value. More...

Detailed Description

This class represents a parameter of some type for the PipelineApplication.

This class simply helps to store multiple pieces of data and provide quick access to them, and should never be used outside of the PipelineApplication class.

Author: 2008-08-01 Steven Lambright

Definition at line 323 of file PipelineApplication.h.

Constructor & Destructor Documentation

◆ PipelineParameter() [1/6]

Isis::PipelineParameter::PipelineParameter ( QString paramName )

inline

Construct the parameter with only a parameter name; affects all branches and is not a special value.

Parameters

paramName Parameter name

Definition at line 331 of file PipelineApplication.h.

References p_branch, p_paramName, and p_special.

◆ PipelineParameter() [2/6]

Isis::PipelineParameter::PipelineParameter	(	QString	paramName,
		QString	value
	)

inline

Construct the parameter with a parameter name and value; affects all branches and is not special.

Parameters

paramName	Parameter name
value	Parameter value

Definition at line 345 of file PipelineApplication.h.

References p_branch, p_paramName, p_paramValue, and p_special.

◆ PipelineParameter() [3/6]

Isis::PipelineParameter::PipelineParameter	(	int	branch,
		QString	paramName
	)

inline

Construct the parameter with only a parameter name; affects only the specified branch and is not a special value.

Parameters

branch	Branch this parameter affects
paramName	Parameter name

Definition at line 360 of file PipelineApplication.h.

References p_branch, p_paramName, and p_special.

◆ PipelineParameter() [4/6]

Isis::PipelineParameter::PipelineParameter	(	int	branch,
		QString	paramName,
		QString	paramValue
	)

inline

Construct the parameter with a parameter name and value; affects only the specified branch and is not a special value.

Parameters

branch	Branch this parameter affects
paramName	Parameter name
paramValue	Special parameter value

Definition at line 375 of file PipelineApplication.h.

References p_branch, p_paramName, p_paramValue, and p_special.

◆ PipelineParameter() [5/6]

Isis::PipelineParameter::PipelineParameter	(	QString	paramName,
		PipelineApplication::CustomParameterValue	special
	)

inline

Construct the parameter with a parameter name and special value; affects all branches.

Parameters

paramName	Parameter name
special	Special value

Definition at line 390 of file PipelineApplication.h.

References p_branch, p_paramName, and p_special.

◆ PipelineParameter() [6/6]

Isis::PipelineParameter::PipelineParameter	(	int	branch,
		QString	paramName,
		PipelineApplication::CustomParameterValue	special
	)

inline

Construct the parameter with a parameter name and special value; affects only the specified branch.

Parameters

branch	Branch this parameter affects
paramName	Parameter name
special	Special parameter value

Definition at line 405 of file PipelineApplication.h.

References p_branch, p_paramName, and p_special.

Member Function Documentation

◆ AffectsAllBranches()

bool Isis::PipelineParameter::AffectsAllBranches ( )

inline

True if branch-independant.

Definition at line 440 of file PipelineApplication.h.

References p_branch.

◆ AppliesToBranch()

bool Isis::PipelineParameter::AppliesToBranch ( int branch )

inline

Returns whether or not the specified branch is affected.

Parameters

branch Branch to test

Returns: bool Whether or not the specified branch is affected.

Definition at line 419 of file PipelineApplication.h.

References p_branch.

◆ IsSpecial()

bool Isis::PipelineParameter::IsSpecial ( )

inline

True if the parameter value is special.

Definition at line 432 of file PipelineApplication.h.

References p_special.

Referenced by Isis::PipelineApplication::BuildParamString().

◆ Name()

QString Isis::PipelineParameter::Name ( )

inline

Name of the parameter.

Definition at line 424 of file PipelineApplication.h.

References p_paramName.

◆ Special()

PipelineApplication::CustomParameterValue Isis::PipelineParameter::Special ( )

inline

Special value of the parameter.

Definition at line 436 of file PipelineApplication.h.

References p_special.

Referenced by Isis::PipelineApplication::BuildParamString().

◆ Value()

QString Isis::PipelineParameter::Value ( )

inline

Non-special value of the parameter.

Definition at line 428 of file PipelineApplication.h.

References p_paramValue.

Member Data Documentation

◆ p_branch

int Isis::PipelineParameter::p_branch

private

Branch this affects.

Definition at line 445 of file PipelineApplication.h.

Referenced by AffectsAllBranches(), AppliesToBranch(), and PipelineParameter().

◆ p_paramName

QString Isis::PipelineParameter::p_paramName

private

Parameter name.

Definition at line 446 of file PipelineApplication.h.

Referenced by Name(), and PipelineParameter().

◆ p_paramValue

QString Isis::PipelineParameter::p_paramValue

private

Parameter non-special value.

Definition at line 447 of file PipelineApplication.h.

Referenced by PipelineParameter(), and Value().

◆ p_special

PipelineApplication::CustomParameterValue Isis::PipelineParameter::p_special

private

Parameter special value.

Definition at line 448 of file PipelineApplication.h.

Referenced by IsSpecial(), PipelineParameter(), and Special().

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

src/base/objs/Pipeline/PipelineApplication.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PipelineParameter() [1/6]

◆ PipelineParameter() [2/6]

◆ PipelineParameter() [3/6]

◆ PipelineParameter() [4/6]

◆ PipelineParameter() [5/6]

◆ PipelineParameter() [6/6]

Member Function Documentation

◆ AffectsAllBranches()

◆ AppliesToBranch()

◆ IsSpecial()

◆ Name()

◆ Special()

◆ Value()

Member Data Documentation

◆ p_branch

◆ p_paramName

◆ p_paramValue

◆ p_special