ldas-tools-frameAPI  2.5.1
Typedefs | Functions
FrameAPI::FrVect Namespace Reference

Typedefs

typedef FrameCPP::Common::Container< FrameCPP::FrVect > Container
 
typedef std::list< const Container *> FrVectList
 

Functions

void appendStructures (Container &Dest, const Container &Source)
 Append elements from another FrVect. More...
 
FrameCPP::FrVect * concat (const FrVectList &List)
 Concatinate multiple FrVect objects into a single object. More...
 
void copy (void *Dest, const Container &Source)
 Copy all data from a list of FrVect objects. More...
 
void * createVector (INT_2U Type, INT_4U Size)
 Create storage space appropriate for the FrVect data element. More...
 
INT_4U getSamples (Container::const_iterator Start, Container::const_iterator Stop)
 Get the number of data points over the specified range. More...
 

Typedef Documentation

◆ Container

typedef FrameCPP::Common::Container< FrameCPP::FrVect > FrameAPI::FrVect::Container

◆ FrVectList

typedef std::list< const Container* > FrameAPI::FrVect::FrVectList

Function Documentation

◆ appendStructures()

void FrameAPI::FrVect::appendStructures ( Container Dest,
const Container Source 
)

Append elements from another FrVect.

Parameters
[in,out]DestThe recipient of the appended container.
[in]SourceAnother container whose value is appended.

◆ concat()

FrameCPP::FrVect * FrameAPI::FrVect::concat ( const FrVectList List)

Concatinate multiple FrVect objects into a single object.

Parameters
[in]ListContainer of ordered FrVect objects to be concatinated.
Returns
New FrVect object containing the concatination results.

◆ copy()

void FrameAPI::FrVect::copy ( void *  Dest,
const Container Source 
)

Copy all data from a list of FrVect objects.

Parameters
[in]SourceA collection of FrVect objects containing data to be copied.
[out]DestA preallocated continuous segment of memory that is large enough to receive the data from each FrVect object.

◆ createVector()

void * FrameAPI::FrVect::createVector ( INT_2U  Type,
INT_4U  Size 
)

Create storage space appropriate for the FrVect data element.

Parameters
[in]TypeThe data type for the data storage element of the FrVect
[in]SizeThe size for the data storage element of the FrVect
Returns
A new array that is appropriate to use as teh data element of an FrVect object.

◆ getSamples()

INT_4U FrameAPI::FrVect::getSamples ( Container::const_iterator  Start,
Container::const_iterator  Stop 
)

Get the number of data points over the specified range.

Parameters
[in]StartThe first element of the range.
[in]StopThe last element of the range.
Returns
The number of samples contained within the specified range.