SkipShortArray

This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Header:	STD.h
Namespace:	avl

If the input array has enough elements, then it is copied to the output; otherwise Nil is returned.

Applications: Secures against domain errors caused by arrays having too few elements, e.g. just before the FitSegmentToPoints filter is to be invoked.

Syntax

void avl::SkipShortArray
(
	const atl::Array<Type>& inArray,
	int inMinSize,
	atl::Conditional<atl::Array<Type> >& outBigEnoughArray,
	bool& outIsBigEnough
)

Parameters

Name	Type	Range	Default	Description
inArray	const Array<Type>&			Array that may have too few elements
inMinSize	int	0 -	2	Minimum number of elements
outBigEnoughArray	Conditional<Array<Type> >&			Array with at least inMinSize elements, or Nil
outIsBigEnough	bool&

Errors

List of possible exceptions:

Error type	Description
DomainError	inMinSize must be greater or equal 0 in SkipShortArray.