FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoVector Class Reference

#include <Vector.h>

Inherits FdoCollection< FdoVectorElement, FdoException >.

Inheritance diagram for FdoVector:

[legend]
List of all members.

Detailed Description

FdoVector is a one-dimensional collection of numbers.

Definition at line 99 of file Vector.h.


Public Member Functions

FDO_API_COMMON int Add (double value)
 Adds a number to the end of this vector.
FDO_API_COMMON void Append (const FdoVector *src)
 Appends the numbers from src to the end of this vector.
FDO_API_COMMON double GetValue (int index) const
 Gets the number in the vector at the specified index. Throws an invalid argument exception if the index is out of range.
FDO_API_COMMON FdoStringP ToString (FdoString *separator=L", ")
 Concatenates the numbers in this collection.

Static Public Member Functions

FDO_API_COMMON FdoVectorCreate (const FdoStringP &inString, FdoString *delimiters, bool bNullTokens=false)
 Creates a vector that is tokenize from a string. The vector contains an element for each token. Non-numberic tokens become 0.0.
FDO_API_COMMON FdoVectorCreate (const FdoVector *src)
 Creates a copy of a vector.
FDO_API_COMMON FdoVectorCreate (void)
 Constructs a new empty vector.

Protected Member Functions

virtual FDO_API_COMMON void Dispose ()
 
 FdoVector (const FdoStringP &inString, FdoString *delimiters, bool bNullTokens=false)
 FdoVector (const FdoVector *src)
 FdoVector (void)
 DOXYGEN-IGNORE
virtual ~FdoVector (void)

Constructor & Destructor Documentation

FdoVector::FdoVector void   )  [protected]
 

DOXYGEN-IGNORE

FdoVector::FdoVector const FdoVector src  )  [protected]
 

FdoVector::FdoVector const FdoStringP inString,
FdoString delimiters,
bool  bNullTokens = false
[protected]
 

virtual FdoVector::~FdoVector void   )  [protected, virtual]
 


Member Function Documentation

FDO_API_COMMON int FdoVector::Add double  value  ) 
 

Adds a number to the end of this vector.

Parameters:
value Input the source collection

FDO_API_COMMON void FdoVector::Append const FdoVector src  ) 
 

Appends the numbers from src to the end of this vector.

Parameters:
src Input the source collection

FDO_API_COMMON FdoVector* FdoVector::Create const FdoStringP inString,
FdoString delimiters,
bool  bNullTokens = false
[static]
 

Creates a vector that is tokenize from a string. The vector contains an element for each token. Non-numberic tokens become 0.0.

Parameters:
inString Input the string to tokenize.
delimiters Input list of single character token delimiters.
bNullTokens true: include zero-length tokens in the vector ( as 0.0 ). false: exclude zero-length tokens
Returns:
Returns FdoVector

FDO_API_COMMON FdoVector* FdoVector::Create const FdoVector src  )  [static]
 

Creates a copy of a vector.

Parameters:
src Input pointer to the source vector
Returns:
Returns FdoVector

FDO_API_COMMON FdoVector* FdoVector::Create void   )  [static]
 

Constructs a new empty vector.

Returns:
Returns FdoVector

virtual FDO_API_COMMON void FdoVector::Dispose  )  [inline, protected, virtual]
 

Implements FdoIDisposable.

Definition at line 187 of file Vector.h.

References FDO_API_COMMON.

FDO_API_COMMON double FdoVector::GetValue int  index  )  const
 

Gets the number in the vector at the specified index. Throws an invalid argument exception if the index is out of range.

Parameters:
index Input index
Returns:
Returns the number in the vector at the specified index

FDO_API_COMMON FdoStringP FdoVector::ToString FdoString separator = L", "  ) 
 

Concatenates the numbers in this collection.

Parameters:
separator Input separate each collection number with this separator string.
Returns:
Returns the concatenation of all numbers in this vector, separated by the given separator..

The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.