Base Framework
Public Member Functions | List of all members
Sequence< TYPE > Class Template Reference

Sequence descriptor. More...

#include <base/string/FormatOutputStream.h>

Public Member Functions

 Sequence (const TYPE *_value, MemorySize _size) noexcept
 
 Sequence (const TYPE *_value, MemorySize _size, const Literal &_separator) noexcept
 
const TYPE * getValue () const noexcept
 
MemorySize getSize () const noexcept
 
const LiteralgetSeparator () const noexcept
 

Detailed Description

template<class TYPE>
class Sequence< TYPE >

Sequence descriptor.

This class describes a seqence of elements to be written to a format output stream.

class MyClass : public Object {
private:
char guid[16];
public:
void myMethod() noexcept
{
if (debugLevel >= VERY_VERBOSE) {
fout << HEX << ZEROPAD << NOPREFIX << Sequence<unsigned char>(guid, sizeof(guid), ":") << ENDL;
}
// do something
}
};
Version
1.0

Constructor & Destructor Documentation

◆ Sequence() [1/2]

template<class TYPE >
Sequence< TYPE >::Sequence ( const TYPE *  _value,
MemorySize  _size 
)
inlinenoexcept

Initializes sequence descriptor with no separator.

Parameters
valueThe beginning of the sequence.
sizeThe number of elements in the sequence.

◆ Sequence() [2/2]

template<class TYPE >
Sequence< TYPE >::Sequence ( const TYPE *  _value,
MemorySize  _size,
const Literal _separator 
)
inlinenoexcept

Initializes sequence descriptor.

Parameters
valueThe beginning of the sequence.
sizeThe number of elements in the sequence.
separatorThe separator to be written between elements.

Member Function Documentation

◆ getSeparator()

template<class TYPE >
const Literal& Sequence< TYPE >::getSeparator ( ) const
inlinenoexcept

Returns the separator to be used between elements.

◆ getSize()

template<class TYPE >
MemorySize Sequence< TYPE >::getSize ( ) const
inlinenoexcept

Returns the number of elements in the sequence.

◆ getValue()

template<class TYPE >
const TYPE* Sequence< TYPE >::getValue ( ) const
inlinenoexcept

Returns the beginning of the sequence.

Object
Object.
Definition: Object.h:28