Isis::PipelineParameter Class Reference

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.
	PipelineParameter (QString paramName, QString value)
	Construct the parameter with a parameter name and value; affects all branches and is not special.
	PipelineParameter (int branch, QString paramName)
	Construct the parameter with only a parameter name; affects only the specified branch and is not a special value.
	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.
	PipelineParameter (QString paramName, PipelineApplication::CustomParameterValue special)
	Construct the parameter with a parameter name and special value; affects all branches.
	PipelineParameter (int branch, QString paramName, PipelineApplication::CustomParameterValue special)
	Construct the parameter with a parameter name and special value; affects only the specified branch.
bool	AppliesToBranch (int branch)
	Returns whether or not the specified branch is affected.
QString	Name ()
	Name of the parameter.
QString	Value ()
	Non-special value of the parameter.
bool	IsSpecial ()
	True if the parameter value is special.
PipelineApplication::CustomParameterValue	Special ()
	Special value of the parameter.
bool	AffectsAllBranches ()
	True if branch-independant.

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

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

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

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

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

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

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

Member Function Documentation

AffectsAllBranches()

bool Isis::PipelineParameter::AffectsAllBranches ( )

inline

True if branch-independant.

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.

IsSpecial()

bool Isis::PipelineParameter::IsSpecial ( )

inline

True if the parameter value is special.

Name()

QString Isis::PipelineParameter::Name ( )

inline

Name of the parameter.

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

Special()

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

inline

Special value of the parameter.

Value()

QString Isis::PipelineParameter::Value ( )

inline

Non-special value of the parameter.

---

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

• /Users/astamile/ISIS3/isis/src/base/objs/Pipeline/PipelineApplication.h