FARGOS/VISTA Object Management Environment Core  ..
FARGOS/VISTA Object Management Environment Core Table of Contents
OMEnlm Class Referencefinal

Public interface to an OME Native Language Message. More...

#include <OMEnlm.h>

+ Inheritance diagram for OMEnlm:

Public Member Functions

 OMEnlm (const OMEnlm &org)
 
 OMEnlm (const OMEstring &defaultMess, OMEarray *args=nullptr, const OMEtype *id=nullptr, const OMEstring *catName=nullptr, OMEarray *extra=nullptr)
 
 OMEnlm (const char *m)
 
OMEnlmoperator= (const OMEnlm &arg)
 
 ~OMEnlm ()
 
OMEstringencodeNLM (const class OMEencodeBuffer *bfr) const
 
bool operator== (const OMEnlm &arg) const
 
bool operator!= (const OMEnlm &arg) const
 
void getMessageInfo (OMEarray &list) const
 
const OMEtypeoperator[] (const OMEarray::ARRAY_SUBSCRIPT_t i) const
 
bool indexExists (const OMEarray::ARRAY_SUBSCRIPT_t i) const
 
OMEarray::ARRAY_SUBSCRIPT_t nextIndex (const OMEarray::ARRAY_SUBSCRIPT_t currentSubscript) const
 
uint_fast32_t elementCount () const
 
bool isEmpty () const
 
OMEnlmdeepCopy () const
 
template<typename STREAMTYPE >
STREAMTYPE & outputOnStream (STREAMTYPE &outputStream, int_fast16_t indent=0, uint8_t includeTypePrefix=OME_DEFAULT_COMPLEX_OUTPUT_MODE, const OMEstring *lang=nullptr) const
 Output an OMEnlm object to an output stream. More...
 
- Public Member Functions inherited from OMEreferenceToData< OMEnlmStorage >
void getUniqueReference ()
 Force unique reference to the data, which will trigger duplication if necessary (copy-on-write). More...
 
int_fast32_t totalReferences () const OME_ALWAYS_INLINE
 Get current reference total. More...
 

Static Public Member Functions

static OMEnlmdecodeNLM (uint32_t ver, const OMEstring *encodedData, size_t *offset)
 
template<typename STREAMTYPE >
static STREAMTYPE & outputFormattedData (STREAMTYPE &o, const class OMEtype &data, const class OMEtype &annotation, const char *fieldModifier, int modifierLen)
 

Private Member Functions

 OMEnlm (OMEnlmStorage *s)
 

Additional Inherited Members

- Protected Member Functions inherited from OMEreferenceToData< OMEnlmStorage >
void addReadOnlyReference () OME_ALWAYS_INLINE
 
void dropReference (OMEnlmStorage *newData=nullptr) OME_ALWAYS_INLINE
 
 OMEreferenceToData ()
 
 OMEreferenceToData (OMEnlmStorage *existingData) NONNULL_CLASS_PARAMETERS(2)
 
 OMEreferenceToData (const OMEreferenceToData< OMEnlmStorage > &org)
 
virtual ~OMEreferenceToData ()
 
- Protected Attributes inherited from OMEreferenceToData< OMEnlmStorage >
OMEnlmStoragedata
 

Detailed Description

Public interface to an OME Native Language Message.

Constructor & Destructor Documentation

◆ OMEnlm() [1/4]

OMEnlm::OMEnlm ( OMEnlmStorage s)
inlineexplicitprivate

References s.

Referenced by decodeNLM(), and OMEtype::operator=().

◆ OMEnlm() [2/4]

OMEnlm::OMEnlm ( const OMEnlm org)
inline

◆ OMEnlm() [3/4]

OMEnlm::OMEnlm ( const OMEstring defaultMess,
OMEarray args = nullptr,
const OMEtype id = nullptr,
const OMEstring catName = nullptr,
OMEarray extra = nullptr 
)
inlineexplicit

◆ OMEnlm() [4/4]

OMEnlm::OMEnlm ( const char *  m)
inlineexplicit

References s.

◆ ~OMEnlm()

OMEnlm::~OMEnlm ( )
inline

Member Function Documentation

◆ decodeNLM()

OMEnlm * OMEnlm::decodeNLM ( uint32_t  ver,
const OMEstring encodedData,
size_t *  offset 
)
static

◆ deepCopy()

OMEnlm* OMEnlm::deepCopy ( ) const
inline

◆ elementCount()

uint_fast32_t OMEnlm::elementCount ( ) const
inline

Referenced by elementCount().

◆ encodeNLM()

OMEstring* OMEnlm::encodeNLM ( const class OMEencodeBuffer bfr) const
inline

◆ getMessageInfo()

void OMEnlm::getMessageInfo ( OMEarray list) const
inline

Referenced by nlmInfo().

◆ indexExists()

bool OMEnlm::indexExists ( const OMEarray::ARRAY_SUBSCRIPT_t  i) const
inline

◆ isEmpty()

bool OMEnlm::isEmpty ( ) const
inline

Referenced by isEmpty().

◆ nextIndex()

OMEarray::ARRAY_SUBSCRIPT_t OMEnlm::nextIndex ( const OMEarray::ARRAY_SUBSCRIPT_t  currentSubscript) const
inline

◆ operator!=()

bool OMEnlm::operator!= ( const OMEnlm arg) const
inline

◆ operator=()

◆ operator==()

bool OMEnlm::operator== ( const OMEnlm arg) const
inline

◆ operator[]()

const OMEtype& OMEnlm::operator[] ( const OMEarray::ARRAY_SUBSCRIPT_t  i) const
inline

◆ outputOnStream()

template<typename STREAMTYPE >
STREAMTYPE& OMEnlm::outputOnStream ( STREAMTYPE &  outputStream,
int_fast16_t  indent = 0,
uint8_t  includeTypePrefix = OME_DEFAULT_COMPLEX_OUTPUT_MODE,
const OMEstring lang = nullptr 
) const
inline

Output an OMEnlm object to an output stream.

Parameters
outputStreamis a reference to an output stream.
indentspecifies the number of spaces to indent before beginning output. If negative, no indent is performed for the first line, but subsequent lines are indented based on the absolute value of indent.
includeTypePrefixis a mask of flags indicating if type names should prefix data elements, if strings should be enclosed in quotes, etc.
langis an optional argument that indicates the intended output language.

Referenced by operator<<().


The documentation for this class was generated from the following files:
Generated: Tue Jul 28 2020 16:03:27
Support Information