OnixS C++ FIX Engine  4.2.0
API Documentation
StringRef Class Reference

#include <OnixS/FIXEngine/FIX/StringRef.h>

Public Types

typedef const char * ConstIterator
 

Public Member Functions

 StringRef ()
 
 StringRef (const char *chars, size_t size)
 
 StringRef (const StringRef &other)
 
 StringRef (const std::string &stdStr)
 
 StringRef (const char *cStr)
 
bool empty () const
 
const char * data () const
 
ConstIterator begin () const
 
ConstIterator end () const
 
size_t size () const
 
void reset ()
 
void reset (const char *chars, size_t size)
 
const char & operator[] (size_t index) const
 
const char & at (size_t index) const
 
template<typename NumericType >
bool toNumber (NumericType &number) const
 
void toString (std::string &str) const
 
std::string toString () const
 
bool operator== (const StringRef &other) const
 
bool operator!= (const StringRef &other) const
 
StringRefoperator= (const StringRef &other)
 
void swap (StringRef &other)
 

Friends

std::ostream & operator<< (std::ostream &out, const StringRef &ref)
 

Detailed Description

By default, OnixS::FIX::Message and OnixS::FIX::GroupInstance classes convert all values assigned to the fields into their text presentations and store textual data. This approach optimizes message reuse when same instance of message is used to update a few fields and is sent over FIX session multiple times. Also, when message comes from the network and is deserialized from its raw (tag=value) presentation, all field values in fact represent segments of text. To have access to textual values, StringRef class was added together with new access members (FieldSet::getStringRef()). If value is accessed using FieldSet::getStringRef() member, instance of StringRef class is returned. That instance holds reference to a read-only segment of text. An important aspect is that no memory is allocated and copied while accessing field values that way.

Definition at line 44 of file StringRef.h.

Member Typedef Documentation

typedef const char* ConstIterator

Immutable iterator over chars.

Definition at line 50 of file StringRef.h.

Constructor & Destructor Documentation

StringRef ( )
inline

Initializes blank instance.

Definition at line 53 of file StringRef.h.

StringRef ( const char *  chars,
size_t  size 
)
inline

Full initialization.

Definition at line 59 of file StringRef.h.

StringRef ( const StringRef other)
inline

Initializes as clone of other instance.

Data referenced by clone is not copied. Instead both instances will refer to same text segment.

Definition at line 70 of file StringRef.h.

StringRef ( const std::string &  stdStr)
inlineexplicit

Initializes instance from string content.

Definition at line 77 of file StringRef.h.

StringRef ( const char *  cStr)
inline

Initializes instance from zero-terminated string.

Definition at line 84 of file StringRef.h.

Member Function Documentation

const char& at ( size_t  index) const
inline

Definition at line 134 of file StringRef.h.

ConstIterator begin ( ) const
inline

STL-like begin().

Definition at line 100 of file StringRef.h.

const char* data ( ) const
inline

Read-only content.

Definition at line 95 of file StringRef.h.

bool empty ( ) const
inline

Indicates whether array of zero length.

Definition at line 90 of file StringRef.h.

ConstIterator end ( ) const
inline

STL-like end().

Definition at line 105 of file StringRef.h.

bool operator!= ( const StringRef other) const
inline

Compares with another instance.

Definition at line 178 of file StringRef.h.

StringRef& operator= ( const StringRef other)
inline

Reinitializes from another instance.

Definition at line 189 of file StringRef.h.

bool operator== ( const StringRef other) const
inline

Compares with another instance.

Definition at line 167 of file StringRef.h.

const char& operator[] ( size_t  index) const
inline

Definition at line 129 of file StringRef.h.

void reset ( )
inline

Resets reference to nothing.

Definition at line 115 of file StringRef.h.

void reset ( const char *  chars,
size_t  size 
)
inline

Updates data being referenced.

Definition at line 121 of file StringRef.h.

size_t size ( ) const
inline

Number of chars.

Definition at line 110 of file StringRef.h.

void swap ( StringRef other)
inline

Swaps content with other instance.

Definition at line 199 of file StringRef.h.

bool toNumber ( NumericType &  number) const
inline

Returns number if text is string representation of an integer.

Definition at line 148 of file StringRef.h.

void toString ( std::string &  str) const
inline

Definition at line 155 of file StringRef.h.

std::string toString ( ) const
inline

Definition at line 161 of file StringRef.h.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  out,
const StringRef ref 
)
friend

Definition at line 288 of file StringRef.h.


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