Go::BoundaryFunctionInt Struct Reference
[Intersections]

This struct is a helper struct that bundles boundary information for an object of type ParamFunctionInt. More...

#include <BoundaryFunctionInt.h>

List of all members.

Public Member Functions
	BoundaryFunctionInt (boost::shared_ptr< ParamFunctionInt > bd_obj, int dir, double par)
	Constructor.
int	getDir ()
	Get the parameter direction that specifies the boundary.
double	getPar ()
	Get the value of the relevant parameter at the boundary.
boost::shared_ptr< ParamFunctionInt >	getObject ()
	Get the object which the boundary belongs to.
Public Attributes
boost::shared_ptr< ParamFunctionInt >	bd_obj_
int	pardir_
double	par_

---

Detailed Description

This struct is a helper struct that bundles boundary information for an object of type ParamFunctionInt.

Definition at line 52 of file BoundaryFunctionInt.h.

---

Constructor & Destructor Documentation

Go::BoundaryFunctionInt::BoundaryFunctionInt	(	boost::shared_ptr< ParamFunctionInt >	bd_obj,
		int	dir,
		double	par
	)			[inline]

Constructor.

Parameters:

	bd_obj	shared pointer to the object of interest
	dir	parameter direction that specifies the boundary
	par	the value of the relevant parameter at the boundary

Definition at line 63 of file BoundaryFunctionInt.h.

References bd_obj_, par_, and pardir_.

---

Member Function Documentation

int Go::BoundaryFunctionInt::getDir

(

)

[inline]

Get the parameter direction that specifies the boundary.

Returns:

the parameter direction

Definition at line 73 of file BoundaryFunctionInt.h.

References pardir_.

double Go::BoundaryFunctionInt::getPar

(

)

[inline]

Get the value of the relevant parameter at the boundary.

Returns:

the parameter value

Definition at line 78 of file BoundaryFunctionInt.h.

References par_.

boost::shared_ptr<ParamFunctionInt> Go::BoundaryFunctionInt::getObject

(

)

[inline]

Get the object which the boundary belongs to.

Returns:

shared pointer to the object

Definition at line 83 of file BoundaryFunctionInt.h.

References bd_obj_.

---

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

• BoundaryFunctionInt.h

---