Mathematics CATMathSetOfLongs

Usage: you must use this class as is. You should never derive it.

public class CATMathSetOfLongs

Class to define a set of longs.

Constructor and Destructor Index


o CATMathSetOfLongs()
Constructs an empty CATMathSetOfLongs with no long.
o CATMathSetOfLongs(CATLONG32)
o CATMathSetOfLongs(CATLONG32,CATLONG32*)
o CATMathSetOfLongs(CATMathSetOfLongs&)
Copy constructor.
o ~CATMathSetOfLongs()
Destructor

Method Index


o AddElement(CATLONG32)
Adds one Element at the end of this CATMathSetOfLongs.
o AddSet(CATMathSetOfLongs&)
Concatenates two sets of longs .
o AddSet(CATMathSetOfLongs&,CATBoolean)
Concatenates two sets of longs.
o AutoInvert()
Inverts this CATMathSetOfLongs.
o Beginning()
Resets the iterator in order to read again this CATMathSetOfLongs.
o Find(CATLONG32,CATLONG32*)
Searches for the first occurence of an element in the collection.
o GetCurrentElement(CATLONG32&)
Reads the current element in this CATMathSetOfLongs.
o GetElement()
o GetElement(CATLONG32)
o GetElement(CATLONG32,CATLONG32&)
Reads a specific element in this CATMathSetOfLongs.
o GetElements()
Returns the array of longs.
o GetMaxNumberOfElements()
Returns the maximum number oflongs of this CATMathSetOfLongs.
o GetNumberOfElements()
Returns the number of valuated longs of this CATMathSetOfLongs.
o InsertElement(CATLONG32,CATLONG32)
o InsertNewElement(CATLONG32,CATLONG32)
Inserts an element in a specific position.
o Next()
Skips to the next element.
o Reset()
Resets this CATMathSetofLongs.
o Set(CATLONG32)
Modifies a set of longs of a given length.
o Set(CATLONG32,CATLONG32*)
Modifies a set of longs of a given length and initializes with given values.
o SetCurrentElement(CATLONG32)
Replaces the current element.
o SetElement(CATLONG32)
o SetElement(CATLONG32,CATLONG32)
o SetOneElement(CATLONG32,CATLONG32)
Replaces the element at a current index.
o Sort()
Sort a CATMathSetOfLongs by increasing.
o SwapElements(CATLONG32,CATLONG32)
Swap the two elements at the index ipos1 and ipos2.
o operator =(CATMathSetOfLongs&)
Assignment operator.

Constructor and Destructor


o CATMathSetOfLongs
public CATMathSetOfLongs()
Constructs an empty CATMathSetOfLongs with no long.
o CATMathSetOfLongs
public CATMathSetOfLongs( const NbElements)
Deprecated:
V5R20 Set Constructs a set of longs of a given length.
Parameters:
iNbElements
The number of longs of the set.
o CATMathSetOfLongs
public CATMathSetOfLongs( const iNbElements,
const iSet)
Deprecated:
V5R20 Set Constructs a set of longs of a given length and initializes with given values.
Parameters:
iNbElements
The number of longs of the set.
iSet
The array of values.
o CATMathSetOfLongs
public CATMathSetOfLongs( const copy)
Copy constructor.
o ~CATMathSetOfLongs
public ~CATMathSetOfLongs()
Destructor

Methods


o AddElement
public AddElement( const iElement)
Adds one Element at the end of this CATMathSetOfLongs.
Parameters:
iElement
The added element. this is reallocated if needed.
o AddSet
public AddSet( const iSet)
Concatenates two sets of longs .
Parameters:
iSet
The set to concatenate at the end of this. this is reallocated if needed.
o AddSet
public AddSet( const set,
iOption)
Concatenates two sets of longs.
Parameters:
iSet
The set to concatenate at the end of this. this is reallocated if needed.
iOption
if Option = 1, lastpoint and firstpoint are merged.
o AutoInvert
public AutoInvert()
Inverts this CATMathSetOfLongs.
o Beginning
public Beginning()
Resets the iterator in order to read again this CATMathSetOfLongs.
o Find
public Find( const iElement,
indice= 0)
Searches for the first occurence of an element in the collection.
Parameters:
iElement
The element.
Returns:
The result of the search, and the position of the element if asked.
Legal values: 1 if the element is found, 0 if nor found.
o GetCurrentElement
public GetCurrentElement( oElement)
Reads the current element in this CATMathSetOfLongs.
Returns:
E_FAIL if the current index is invalid, S_OK otherwise.
o GetElement
public GetElement()
Deprecated:
V5R20 GetCurrentElement Reads the current element in this CATMathSetOfLongs.
o GetElement
public GetElement( const iIndex)
Deprecated:
V5R20 GetElement Reads a specific element in this CATMathSetOfLongs.
Parameters:
iIndex
The index (0<= position < NumberOfElements) of the point to read.
o GetElement
public GetElement( const iIndex,
oElement)
Reads a specific element in this CATMathSetOfLongs.
Parameters:
iIndex
The index (0<= position < NumberOfElements) of the point to read.
Returns:
E_FAIL if the current index is invalid, S_OK otherwise.
o GetElements
public GetElements()
Returns the array of longs.
Returns:
The array of longs that you must deallocate after use.
o GetMaxNumberOfElements
public GetMaxNumberOfElements()
Returns the maximum number oflongs of this CATMathSetOfLongs.
Returns:
The maximum number of longs.
o GetNumberOfElements
public GetNumberOfElements()
Returns the number of valuated longs of this CATMathSetOfLongs.
Returns:
The number of valuated longs.
o InsertElement
public InsertElement( const iElement,
const iIndex)
Deprecated:
V5R20 InsertNewElement Inserts an element in a specific position.
this is reallocated if needed.
Parameters:
iElement
The new value of the current element.
iIndex
The index (0<= position < NumberOfElements) of the element.
o InsertNewElement
public InsertNewElement( const iElement,
const iIndex)
Inserts an element in a specific position.
this is reallocated if needed.
Parameters:
iElement
The new value of the current element.
iIndex
The index (0<= position < NumberOfElements) of the element.
Returns:
E_FAIL if the index is invalid, S_OK otherwise.
o Next
public Next()
Skips to the next element.
Returns:
Legal values: 0 if the iterator reaches the end of the set, 1 otherwise.
o Reset
public Reset()
Resets this CATMathSetofLongs.
The memory is not deleted and the class can be used again.
o Set
public Set( const NbElements)
Modifies a set of longs of a given length.
Parameters:
iNbElements
The number of longs of the set.
Returns:
E_FAIL if the number of longs is invalid, S_OK otherwise.
o Set
public Set( const iNbElements,
const iSet)
Modifies a set of longs of a given length and initializes with given values.
Parameters:
iNbElements
The number of longs of the set.
iSet
The array of values.
Returns:
E_FAIL if the number of longs is invalid, S_OK otherwise.
o SetCurrentElement
public SetCurrentElement( const iElement)
Replaces the current element.
Parameters:
iElement
The new value of the current element.
Returns:
E_FAIL if the current index is invalid, S_OK otherwise.
o SetElement
public SetElement( const iElement)
Deprecated:
V5R20 SetCurrentElement Replaces the current element.
Parameters:
iElement
The new value of the current element.
o SetElement
public SetElement( const iElement,
const iIndex)
Deprecated:
V5R20 SetOneElement Replaces the element at a current index.
Parameters:
iElement
The new value of the current element.
iIndex
The index (0<= position < NumberOfElements) of the element.
o SetOneElement
public SetOneElement( const iElement,
const iIndex)
Replaces the element at a current index.
Parameters:
iElement
The new value of the current element.
iIndex
The index (0<= position < NumberOfElements) of the element.
Returns:
E_FAIL if the index is invalid, S_OK otherwise.
o Sort
public Sort()
Sort a CATMathSetOfLongs by increasing.
o SwapElements
public SwapElements( const ipos1,
const ipos2)
Swap the two elements at the index ipos1 and ipos2.
o operator =
public operator =( const iElements)
Assignment operator.
Parameters:
iElements
The set of longs to assign.
This object is included in the file: CATMathSetOfLongs.h
If needed, your Imakefile.mk should include the module: CATMathematics

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.