ldas-tools-framecpp  2.9.3
Public Member Functions | List of all members
FrameCPP::Common::Array< N, T > Class Template Reference

Storage class for array data streams of a frame. More...

#include <Array.hh>

Inherits std::vector< T >, std::vector< T >, and std::vector< T >.

Public Member Functions

cmn_streamsize_type Bytes (const StreamBase &Stream) const
 Number of bytes needed by the frame stream for this object. More...
 
cmn_streamsize_type bytes () const
 Number of bytes needed by the frame stream for this object. More...
 
bool operator== (const Array &RHS) const
 Compare the equality of two Array objects. More...
 

Detailed Description

template<typename N, typename T>
class FrameCPP::Common::Array< N, T >

Storage class for array data streams of a frame.

This template manages arrays intended to be part of a frame stream.

Template Parameters
NThe frame data type used to store the array size within the stream.
TThe element type to be used for storing the individual elements of the array.

Member Function Documentation

◆ bytes()

template<typename N , typename T >
cmn_streamsize_type FrameCPP::Common::Array< N, T >::bytes

Number of bytes needed by the frame stream for this object.

This member returns the number of bytes needed to store this object.

Returns
Number of bytes needed to store this object.

◆ Bytes()

template<typename N , typename T >
cmn_streamsize_type FrameCPP::Common::Array< N, T >::Bytes ( const StreamBase &  Stream) const

Number of bytes needed by the frame stream for this object.

This member returns the number of bytes needed to store this object to the specified stream.

Parameters
[in]StreamThe frame stream being used.
Returns
Number of bytes needed to store this object to the specified stream.

◆ operator==()

template<typename N , typename T >
bool FrameCPP::Common::Array< N, T >::operator== ( const Array< N, T > &  RHS) const

Compare the equality of two Array objects.

This member returns true if the two Array objects are equivelant.

Parameters
[in]RHSObject appearing on the right hand side of the equality operator.
Returns
True if the two objects are equal; false otherwise

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