OpenMAMA C++ API
Wombat::MamaFieldCacheFieldStringVector Class Reference

MamaFieldCacheField: String vector field. More...

#include <MamaFieldCacheFieldTypes.h>

Inheritance diagram for Wombat::MamaFieldCacheFieldStringVector:
Wombat::MamaFieldCacheFieldBase

Public Member Functions

void set (MamaFieldCacheField &field, const char **values, mama_size_t size)
 Set the values of a string vector field. More...
 
void get (const MamaFieldCacheField &field, const char **&values, mama_size_t &size) const
 Return the values of a string vector. More...
 
const char * get (const MamaFieldCacheField &field, mama_size_t index) const
 Return the value of a specific field of a string vector field. More...
 
- Public Member Functions inherited from Wombat::MamaFieldCacheFieldBase
virtual ~MamaFieldCacheFieldBase ()
 

Protected Member Functions

void checkType (const MamaFieldCacheField &field) const
 
- Protected Member Functions inherited from Wombat::MamaFieldCacheFieldBase
 MamaFieldCacheFieldBase ()
 

Detailed Description

MamaFieldCacheField: String vector field.

Member Function Documentation

§ set()

void Wombat::MamaFieldCacheFieldStringVector::set ( MamaFieldCacheField field,
const char **  values,
mama_size_t  size 
)

Set the values of a string vector field.

Parameters
fieldThe field to set the values to.
valuesThe new values of the field.
sizeThe number of fields in values.

Referenced by Wombat::setFieldValue().

§ get() [1/2]

void Wombat::MamaFieldCacheFieldStringVector::get ( const MamaFieldCacheField field,
const char **&  values,
mama_size_t size 
) const

Return the values of a string vector.

Parameters
fieldThe field to get the values from.
valuesA reference to the values to be returned.
sizeA reference to the size of the vector to be returned.

§ get() [2/2]

const char* Wombat::MamaFieldCacheFieldStringVector::get ( const MamaFieldCacheField field,
mama_size_t  index 
) const

Return the value of a specific field of a string vector field.

Parameters
fieldThe field to get the value from.
indexThe index of the element of the vector to get the value from.
Returns
The value of the field.

§ checkType()

void Wombat::MamaFieldCacheFieldStringVector::checkType ( const MamaFieldCacheField field) const
inlineprotected