Dtk_pipe_fiber_segment Class Reference

Neutral Fiber Segment : composed of the Start, End, and Center points
or from a Spline Curve (in case of Elec3D Pipe) More...

Public Types
enum	SECTION_SET_POINT {   DTK_TOP_LEFT, DTK_TOP_CENTER, DTK_TOP_RIGHT, DTK_CENTER_LEFT,   DTK_CENTER_CENTER, DTK_CENTER_RIGHT, DTK_BOTTOM_LEFT, DTK_BOTTOM_CENTER,   DTK_BOTTOM_RIGHT }

Public Member Functions
	Dtk_pipe_fiber_segment ()
DtkErrorStatus	get_center_point (Dtk_pnt &centerPointOut) const
	Returns fiber Center Point More...
DtkErrorStatus	get_end_point (Dtk_pnt &endPointOut) const
	Returns fiber End Point More...
DtkErrorStatus	get_OrientationPlane (Dtk_PlaneSurfacePtr &outOrientationPlane) const
	Returns Orientation Plane. More...
DtkErrorStatus	get_section_set_point (SECTION_SET_POINT &outSectionSetPoint) const
	Returns pipe section set point More...
DtkErrorStatus	get_spline_curve (Dtk_CurvePtr &splineCurveOut) const
	Returns fiber Spline Curve More...
DtkErrorStatus	get_start_point (Dtk_pnt &startPointOut) const
	Returns fiber start Point More...
DtkErrorStatus	get_TurnRadius (double &outTurnRadius) const
	Returns Pipe Turn Radius value. More...
	~Dtk_pipe_fiber_segment ()

Data Fields
Dtk_PlaneSurfacePtr	_orientationPlane
SECTION_SET_POINT	_sectionSetPoint
double	_turnRadius
Dtk_pnt	centerPoint
Dtk_pnt	endPoint
Dtk_CurvePtr	splineCurve
Dtk_pnt	startPoint
DTK_PIPE_TYPE	typeOfSegment

Detailed Description

Neutral Fiber Segment : composed of the Start, End, and Center points
or from a Spline Curve (in case of Elec3D Pipe)

Member Enumeration Documentation

SECTION_SET_POINT

enum Dtk_pipe_fiber_segment::SECTION_SET_POINT

Enumerator
DTK_TOP_LEFT
DTK_TOP_CENTER
DTK_TOP_RIGHT
DTK_CENTER_LEFT
DTK_CENTER_CENTER
DTK_CENTER_RIGHT
DTK_BOTTOM_LEFT
DTK_BOTTOM_CENTER
DTK_BOTTOM_RIGHT

                 {
        DTK_TOP_LEFT,
        DTK_TOP_CENTER,
        DTK_TOP_RIGHT,
        DTK_CENTER_LEFT,
        DTK_CENTER_CENTER,
        DTK_CENTER_RIGHT,
        DTK_BOTTOM_LEFT,
        DTK_BOTTOM_CENTER,
        DTK_BOTTOM_RIGHT
    }SECTION_SET_POINT;

Constructor & Destructor Documentation

Dtk_pipe_fiber_segment()

Dtk_pipe_fiber_segment::Dtk_pipe_fiber_segment

(

)

~Dtk_pipe_fiber_segment()

Dtk_pipe_fiber_segment::~Dtk_pipe_fiber_segment

(

)

Member Function Documentation

get_center_point()

DtkErrorStatus Dtk_pipe_fiber_segment::get_center_point

(

Dtk_pnt &

centerPointOut

)

const

Returns fiber Center Point

Parameters

[in]	<br>
[out]	Dtk_pnt

Returns

NOTOK if error, ISOK if ok

Remarks

get_end_point()

DtkErrorStatus Dtk_pipe_fiber_segment::get_end_point

(

Dtk_pnt &

endPointOut

)

const

Returns fiber End Point

Parameters

[in]	<br>
[out]	Dtk_pnt

Returns

NOTOK if error, ISOK if ok

Remarks

get_OrientationPlane()

DtkErrorStatus Dtk_pipe_fiber_segment::get_OrientationPlane

(

Dtk_PlaneSurfacePtr &

outOrientationPlane

)

const

Returns Orientation Plane.

Parameters

[in]	<br>
[out]	double

Returns

dtkErrorUnspecified if error, dtkNoError if ok

Remarks

get_section_set_point()

DtkErrorStatus Dtk_pipe_fiber_segment::get_section_set_point

(

SECTION_SET_POINT &

outSectionSetPoint

)

const

Returns pipe section set point

Parameters

[in]	<br>
	[in/out]
[out]	SECTION_SET_POINT

Returns

dtkErrorUnspecified if error, dtkNoError if ok

Remarks

get_spline_curve()

DtkErrorStatus Dtk_pipe_fiber_segment::get_spline_curve

(

Dtk_CurvePtr &

splineCurveOut

)

const

Returns fiber Spline Curve

Parameters

[in]	<br>
[out]	Dtk_pnt

Returns

NOTOK if error, ISOK if ok

Remarks

get_start_point()

DtkErrorStatus Dtk_pipe_fiber_segment::get_start_point

(

Dtk_pnt &

startPointOut

)

const

Returns fiber start Point

Parameters

[in]	<br>
[out]	Dtk_pnt

Returns

NOTOK if error, ISOK if ok

Remarks

get_TurnRadius()

DtkErrorStatus Dtk_pipe_fiber_segment::get_TurnRadius

(

double &

outTurnRadius

)

const

Returns Pipe Turn Radius value.

Parameters

[in]	<br>
[out]	double

Returns

dtkErrorUnspecified if error, dtkNoError if ok

Remarks

Field Documentation

_orientationPlane

Dtk_PlaneSurfacePtr Dtk_pipe_fiber_segment::_orientationPlane

_sectionSetPoint

SECTION_SET_POINT Dtk_pipe_fiber_segment::_sectionSetPoint

_turnRadius

double Dtk_pipe_fiber_segment::_turnRadius

centerPoint

Dtk_pnt Dtk_pipe_fiber_segment::centerPoint

endPoint

Dtk_pnt Dtk_pipe_fiber_segment::endPoint

splineCurve

Dtk_CurvePtr Dtk_pipe_fiber_segment::splineCurve

startPoint

Dtk_pnt Dtk_pipe_fiber_segment::startPoint

typeOfSegment

DTK_PIPE_TYPE Dtk_pipe_fiber_segment::typeOfSegment