The class NCollection_Array1 represents unidimensional arrays of fixed size known at run time. The range of the index is user defined. An array1 can be constructed with a "C array". This functionality is useful to call methods expecting an Array1. It allows to carry the bounds inside the arrays. More...

#include <NCollection_Array1.hxx>

Data Structures
class	Iterator
	Implementation of the Iterator interface. More...

Public Types
typedef TheItemType	value_type
	STL-compliant typedef for value type. More...

typedef NCollection_StlIterator< std::random_access_iterator_tag, Iterator, TheItemType, false >	iterator
	Shorthand for a regular iterator type. More...

typedef NCollection_StlIterator< std::random_access_iterator_tag, Iterator, TheItemType, true >	const_iterator
	Shorthand for a constant iterator type. More...

Public Member Functions
iterator	begin () const
	Returns an iterator pointing to the first element in the array. More...

iterator	end () const
	Returns an iterator referring to the past-the-end element in the array. More...

const_iterator	cbegin () const
	Returns a const iterator pointing to the first element in the array. More...

const_iterator	cend () const
	Returns a const iterator referring to the past-the-end element in the array. More...

	NCollection_Array1 ()
	Empty constructor; should be used with caution. More...

	NCollection_Array1 (const Standard_Integer theLower, const Standard_Integer theUpper)
	Constructor. More...

	NCollection_Array1 (const NCollection_Array1 &theOther)
	Copy constructor. More...

	NCollection_Array1 (NCollection_Array1 &&theOther)
	Move constructor. More...

	NCollection_Array1 (const TheItemType &theBegin, const Standard_Integer theLower, const Standard_Integer theUpper)
	C array-based constructor. More...

void	Init (const TheItemType &theValue)
	Initialise the items with theValue. More...

Standard_Integer	Size (void) const
	Size query. More...

Standard_Integer	Length (void) const
	Length query (the same) More...

Standard_Boolean	IsEmpty () const
	Return TRUE if array has zero length. More...

Standard_Integer	Lower (void) const
	Lower bound. More...

Standard_Integer	Upper (void) const
	Upper bound. More...

Standard_Boolean	IsDeletable (void) const
	myDeletable flag More...

Standard_Boolean	IsAllocated (void) const
	IsAllocated flag - for naming compatibility. More...

NCollection_Array1 &	Assign (const NCollection_Array1 &theOther)
	Copies data of theOther array to this. This array should be pre-allocated and have the same length as theOther; otherwise exception Standard_DimensionMismatch is thrown. More...

NCollection_Array1 &	Move (NCollection_Array1 &theOther)
	Move assignment. This array will borrow all the data from theOther. The moved object will keep pointer to the memory buffer and range, but it will not free the buffer on destruction. More...

NCollection_Array1 &	operator= (const NCollection_Array1 &theOther)
	Assignment operator;. More...

NCollection_Array1 &	operator= (NCollection_Array1 &&theOther)
	Move assignment operator;. More...

const TheItemType &	First () const

TheItemType &	ChangeFirst ()

const TheItemType &	Last () const

TheItemType &	ChangeLast ()

const TheItemType &	Value (const Standard_Integer theIndex) const
	Constant value access. More...

const TheItemType &	operator() (const Standard_Integer theIndex) const
	operator() - alias to Value More...

const TheItemType &	operator[] (Standard_Integer theIndex) const
	operator[] - alias to Value More...

TheItemType &	ChangeValue (const Standard_Integer theIndex)
	Variable value access. More...

TheItemType &	operator() (const Standard_Integer theIndex)
	operator() - alias to ChangeValue More...

TheItemType &	operator[] (Standard_Integer theIndex)
	operator[] - alias to ChangeValue More...

void	SetValue (const Standard_Integer theIndex, const TheItemType &theItem)
	Set value. More...

void	Resize (const Standard_Integer theLower, const Standard_Integer theUpper, const Standard_Boolean theToCopyData)
	Resizes the array to specified bounds. No re-allocation will be done if length of array does not change, but existing values will not be discarded if theToCopyData set to FALSE. More...

	~NCollection_Array1 (void)
	Destructor - releases the memory. More...

Protected Attributes
Standard_Integer	myLowerBound

Standard_Integer	myUpperBound

Standard_Boolean	myDeletable
	Flag showing who allocated the array. More...

TheItemType *	myData
	Pointer to '0'th array item. More...

Detailed Description

template<class TheItemType>
class NCollection_Array1< TheItemType >

The class NCollection_Array1 represents unidimensional arrays of fixed size known at run time. The range of the index is user defined. An array1 can be constructed with a "C array". This functionality is useful to call methods expecting an Array1. It allows to carry the bounds inside the arrays.

Examples:

Item tab[100]; //  an example with a C array
NCollection_Array1<Item> ttab (tab[0], 1, 100);
NCollection_Array1<Item> tttab (ttab(10), 10, 20); // a slice of ttab

If you want to reindex an array from 1 to Length do:

NCollection_Array1<Item> tab1 (tab (tab.Lower()), 1, tab.Length());

Warning: Programs client of such a class must be independent of the range of the first element. Then, a C++ for loop must be written like this

for (i = A.Lower(); i <= A.Upper(); i++)

Member Typedef Documentation

◆ const_iterator

template<class TheItemType>

typedef NCollection_StlIterator<std::random_access_iterator_tag, Iterator, TheItemType, true> NCollection_Array1< TheItemType >::const_iterator

Shorthand for a constant iterator type.

◆ iterator

template<class TheItemType>

typedef NCollection_StlIterator<std::random_access_iterator_tag, Iterator, TheItemType, false> NCollection_Array1< TheItemType >::iterator

Shorthand for a regular iterator type.

◆ value_type

template<class TheItemType>

typedef TheItemType NCollection_Array1< TheItemType >::value_type

STL-compliant typedef for value type.

Constructor & Destructor Documentation

◆ NCollection_Array1() [1/5]

template<class TheItemType>

NCollection_Array1< TheItemType >::NCollection_Array1 ( )

inline

Empty constructor; should be used with caution.

See also: methods Resize() and Move().

◆ NCollection_Array1() [2/5]

template<class TheItemType>

NCollection_Array1< TheItemType >::NCollection_Array1	(	const Standard_Integer	theLower,
		const Standard_Integer	theUpper
	)

inline

Constructor.

◆ NCollection_Array1() [3/5]

template<class TheItemType>

NCollection_Array1< TheItemType >::NCollection_Array1 ( const NCollection_Array1< TheItemType > & theOther )

inline

Copy constructor.

◆ NCollection_Array1() [4/5]

template<class TheItemType>

NCollection_Array1< TheItemType >::NCollection_Array1 ( NCollection_Array1< TheItemType > && theOther )

inline

Move constructor.

◆ NCollection_Array1() [5/5]

template<class TheItemType>

NCollection_Array1< TheItemType >::NCollection_Array1	(	const TheItemType &	theBegin,
		const Standard_Integer	theLower,
		const Standard_Integer	theUpper
	)

inline

C array-based constructor.

Makes this array to use the buffer pointed by theBegin instead of allocating it dynamically. Argument theBegin should be a reference to the first element of the pre-allocated buffer (usually local C array buffer), with size at least theUpper - theLower + 1 items.

Warning: returning array object created using this constructor from function by value will result in undefined behavior if compiler performs return value optimization (this is likely to be true for all modern compilers in release mode). The same happens if array is copied using Move() function or move constructor and target object's lifespan is longer than that of the buffer.

◆ ~NCollection_Array1()

template<class TheItemType>

NCollection_Array1< TheItemType >::~NCollection_Array1 ( void )

inline

Destructor - releases the memory.

Member Function Documentation

◆ Assign()

template<class TheItemType>

NCollection_Array1& NCollection_Array1< TheItemType >::Assign ( const NCollection_Array1< TheItemType > & theOther )

inline

Copies data of theOther array to this. This array should be pre-allocated and have the same length as theOther; otherwise exception Standard_DimensionMismatch is thrown.

◆ begin()

template<class TheItemType>

iterator NCollection_Array1< TheItemType >::begin ( ) const

inline

Returns an iterator pointing to the first element in the array.

◆ cbegin()

template<class TheItemType>

const_iterator NCollection_Array1< TheItemType >::cbegin ( ) const

inline

Returns a const iterator pointing to the first element in the array.

◆ cend()

template<class TheItemType>

const_iterator NCollection_Array1< TheItemType >::cend ( ) const

inline

Returns a const iterator referring to the past-the-end element in the array.

◆ ChangeFirst()

template<class TheItemType>

TheItemType& NCollection_Array1< TheItemType >::ChangeFirst ( )

inline

Returns: first element

◆ ChangeLast()

template<class TheItemType>

TheItemType& NCollection_Array1< TheItemType >::ChangeLast ( )

inline

Returns: last element

◆ ChangeValue()

template<class TheItemType>

TheItemType& NCollection_Array1< TheItemType >::ChangeValue ( const Standard_Integer theIndex )

inline

Variable value access.

◆ end()

template<class TheItemType>

iterator NCollection_Array1< TheItemType >::end ( ) const

inline

Returns an iterator referring to the past-the-end element in the array.

◆ First()

template<class TheItemType>

const TheItemType& NCollection_Array1< TheItemType >::First ( ) const

inline

Returns: first element

◆ Init()

template<class TheItemType>

void NCollection_Array1< TheItemType >::Init ( const TheItemType & theValue )

inline

Initialise the items with theValue.

◆ IsAllocated()

template<class TheItemType>

Standard_Boolean NCollection_Array1< TheItemType >::IsAllocated ( void ) const

inline

IsAllocated flag - for naming compatibility.

◆ IsDeletable()

template<class TheItemType>

Standard_Boolean NCollection_Array1< TheItemType >::IsDeletable ( void ) const

inline

myDeletable flag

◆ IsEmpty()

template<class TheItemType>

Standard_Boolean NCollection_Array1< TheItemType >::IsEmpty ( ) const

inline

Return TRUE if array has zero length.

◆ Last()

template<class TheItemType>

const TheItemType& NCollection_Array1< TheItemType >::Last ( ) const

inline

Returns: last element

◆ Length()

template<class TheItemType>

Standard_Integer NCollection_Array1< TheItemType >::Length ( void ) const

inline

Length query (the same)

◆ Lower()

template<class TheItemType>

Standard_Integer NCollection_Array1< TheItemType >::Lower ( void ) const

inline

Lower bound.

◆ Move()

template<class TheItemType>

NCollection_Array1& NCollection_Array1< TheItemType >::Move ( NCollection_Array1< TheItemType > & theOther )

inline

Move assignment. This array will borrow all the data from theOther. The moved object will keep pointer to the memory buffer and range, but it will not free the buffer on destruction.

◆ operator()() [1/2]

template<class TheItemType>

const TheItemType& NCollection_Array1< TheItemType >::operator() ( const Standard_Integer theIndex ) const

inline

operator() - alias to Value

◆ operator()() [2/2]

template<class TheItemType>

TheItemType& NCollection_Array1< TheItemType >::operator() ( const Standard_Integer theIndex )

inline

operator() - alias to ChangeValue

◆ operator=() [1/2]

template<class TheItemType>

NCollection_Array1& NCollection_Array1< TheItemType >::operator= ( const NCollection_Array1< TheItemType > & theOther )

inline

Assignment operator;.

See also: Assign()

◆ operator=() [2/2]

template<class TheItemType>

NCollection_Array1& NCollection_Array1< TheItemType >::operator= ( NCollection_Array1< TheItemType > && theOther )

inline

Move assignment operator;.

See also: Move()

◆ operator[]() [1/2]

template<class TheItemType>

const TheItemType& NCollection_Array1< TheItemType >::operator[] ( Standard_Integer theIndex ) const

inline

operator[] - alias to Value

◆ operator[]() [2/2]

template<class TheItemType>

TheItemType& NCollection_Array1< TheItemType >::operator[] ( Standard_Integer theIndex )

inline

operator[] - alias to ChangeValue

◆ Resize()

template<class TheItemType>

void NCollection_Array1< TheItemType >::Resize	(	const Standard_Integer	theLower,
		const Standard_Integer	theUpper,
		const Standard_Boolean	theToCopyData
	)

inline

Resizes the array to specified bounds. No re-allocation will be done if length of array does not change, but existing values will not be discarded if theToCopyData set to FALSE.

Parameters

theLower	new lower bound of array
theUpper	new upper bound of array
theToCopyData	flag to copy existing data into new array

◆ SetValue()

template<class TheItemType>

void NCollection_Array1< TheItemType >::SetValue	(	const Standard_Integer	theIndex,
		const TheItemType &	theItem
	)

inline

Set value.

◆ Size()

template<class TheItemType>

Standard_Integer NCollection_Array1< TheItemType >::Size ( void ) const

inline

Size query.

◆ Upper()

template<class TheItemType>

Standard_Integer NCollection_Array1< TheItemType >::Upper ( void ) const

inline

Upper bound.

◆ Value()

template<class TheItemType>

const TheItemType& NCollection_Array1< TheItemType >::Value ( const Standard_Integer theIndex ) const

inline

Constant value access.

Field Documentation

◆ myData

template<class TheItemType>

TheItemType* NCollection_Array1< TheItemType >::myData

protected

Pointer to '0'th array item.

◆ myDeletable

template<class TheItemType>

Standard_Boolean NCollection_Array1< TheItemType >::myDeletable

protected

Flag showing who allocated the array.

◆ myLowerBound

template<class TheItemType>

Standard_Integer NCollection_Array1< TheItemType >::myLowerBound

protected

◆ myUpperBound

template<class TheItemType>

Standard_Integer NCollection_Array1< TheItemType >::myUpperBound

protected

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

NCollection_Array1.hxx

Data Structures

Public Types

Public Member Functions

Protected Attributes

Detailed Description

template<class TheItemType> class NCollection_Array1< TheItemType >

Member Typedef Documentation

◆ const_iterator

◆ iterator

◆ value_type

Constructor & Destructor Documentation

◆ NCollection_Array1() [1/5]

◆ NCollection_Array1() [2/5]

◆ NCollection_Array1() [3/5]

◆ NCollection_Array1() [4/5]

◆ NCollection_Array1() [5/5]

◆ ~NCollection_Array1()

Member Function Documentation

◆ Assign()

◆ begin()

◆ cbegin()

◆ cend()

◆ ChangeFirst()

◆ ChangeLast()

◆ ChangeValue()

◆ end()

◆ First()

◆ Init()

◆ IsAllocated()

◆ IsDeletable()

◆ IsEmpty()

◆ Last()

◆ Length()

◆ Lower()

◆ Move()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ Resize()

◆ SetValue()

◆ Size()

◆ Upper()

◆ Value()

Field Documentation

◆ myData

◆ myDeletable

◆ myLowerBound

◆ myUpperBound

template<class TheItemType>
class NCollection_Array1< TheItemType >