Dtk_feat_pattern_dir Class Reference

Public Member Functions
	Dtk_feat_pattern_dir ()
int	get_direction (Dtk_feat_axis **)
	Returns the axis of direction for pattern feature. More...
int	get_instance_spacing_array (Dtk_tab< double > *)
	Returns the list of unequal spacing values ( available if get_is_equal_spacing returns DTK_FALSE) More...
int	get_is_equal_spacing (Dtk_bool *)
	Returns the boolean value to check if instances are equal spacing. More...
int	get_length (double *)
	Returns the length of the pattern, I.E, the distance between the first and the last occurrence. More...
int	get_nb_instances (int *)
	Returns Number of occurrences in this pattern direction (including the base feature to repeat) More...
int	get_reverse (Bool *)
	Returns the boolean value for the reverse status of the pattern direction. More...
int	get_spacing (double *)
	Returns the distance between two consecutive occurrences More...
	~Dtk_feat_pattern_dir ()

Data Fields
Dtk_feat_axis *	direction
Dtk_bool	isEqualSpacing
double	length
int	nb_instances
Bool	reverse
double	spacing
Dtk_tab< double >	tabInstanceSpacingValues

Constructor & Destructor Documentation

Dtk_feat_pattern_dir()

Dtk_feat_pattern_dir::Dtk_feat_pattern_dir

(

)

~Dtk_feat_pattern_dir()

Dtk_feat_pattern_dir::~Dtk_feat_pattern_dir

(

)

Member Function Documentation

get_direction()

int Dtk_feat_pattern_dir::get_direction

(

Dtk_feat_axis **

)

Returns the axis of direction for pattern feature.

Parameters

[in]	Pattern	Feature
	[in/out]
[out]	Dtk_feat_axis*

Returns

NOTOK if error, ISOK if ok

Remarks

get_instance_spacing_array()

int Dtk_feat_pattern_dir::get_instance_spacing_array

(

Dtk_tab< double > *

)

Returns the list of unequal spacing values ( available if get_is_equal_spacing returns DTK_FALSE)

Parameters

[in]	Pattern	Feature
	[in/out]
[out]	list	of double for spacing values

Returns

NOTOK if error, ISOK if ok

Remarks

get_is_equal_spacing()

int Dtk_feat_pattern_dir::get_is_equal_spacing

(

Dtk_bool *

)

Returns the boolean value to check if instances are equal spacing.

Parameters

[in]	Pattern	Feature
	[in/out]
[out]	Dtk_Bool

Returns

NOTOK if error, ISOK if ok

Remarks

get_length()

int Dtk_feat_pattern_dir::get_length

(

double *

)

Returns the length of the pattern, I.E, the distance between the first and the last occurrence.

Parameters

[in]	Pattern	Feature
	[in/out]
[out]	double

Returns

NOTOK if error, ISOK if ok

Remarks

For Circular pattern: The length is the total angle of the circular pattern. Total Angle = Spacing * (nb_instances - 1);

get_nb_instances()

int Dtk_feat_pattern_dir::get_nb_instances

(

int *

)

Returns Number of occurrences in this pattern direction (including the base feature to repeat)

Parameters

[in]	Pattern	Feature
	[in/out]
[out]	int

Returns

NOTOK if error, ISOK if ok

Remarks

get_reverse()

int Dtk_feat_pattern_dir::get_reverse

(

Bool *

)

Returns the boolean value for the reverse status of the pattern direction.

Parameters

[in]	Pattern	Feature
	[in/out]
[out]	Bool

Returns

NOTOK if error, ISOK if ok

Remarks

get_spacing()

int Dtk_feat_pattern_dir::get_spacing

(

double *

)

Returns the distance between two consecutive occurrences

Parameters

[in]	Pattern	Feature
	[in/out]
[out]	int

Returns

NOTOK if error, ISOK if ok

Remarks

Field Documentation

direction

Dtk_feat_axis* Dtk_feat_pattern_dir::direction

isEqualSpacing

Dtk_bool Dtk_feat_pattern_dir::isEqualSpacing

length

double Dtk_feat_pattern_dir::length

nb_instances

int Dtk_feat_pattern_dir::nb_instances

reverse

Bool Dtk_feat_pattern_dir::reverse

spacing

double Dtk_feat_pattern_dir::spacing

tabInstanceSpacingValues

Dtk_tab<double> Dtk_feat_pattern_dir::tabInstanceSpacingValues