C++ SDK Documentation  24.2.0
Vertica::SessionParamWriterMap Class Reference

This class provides an interface for writing the Used defined session parameters. More...

Collaboration diagram for Vertica::SessionParamWriterMap:
Collaboration graph

Public Member Functions

 SessionParamWriterMap (VTAllocator *allocator=NULL)
 
void addUDSessionParamWriter (const std::string &nsp, ParamWriter &sessionParamWriter)
 Add a SessionParamWriter for a namespace. More...
 
bool containsNamespace (const std::string nsp) const
 Check if a SessionParamWriter for the Namespace exists in the map. More...
 
std::vector< std::string > getNamespaces () const
 Gets the names of all namespaces. More...
 
ParamWritergetUDSessionParamWriter (const std::string &nsp)
 Get a SessionParamWriter for a namespace. More...
 
const ParamWritergetUDSessionParamWriter (const std::string &nsp) const
 Get a SessionParamWriter for a namespace. More...
 
ParamWritergetUDSessionParamWriter ()
 Get a SessionParamWriter for a namespace library. More...
 
void setAllocator (VTAllocator *allocator)
 

Detailed Description

This class provides an interface for writing the Used defined session parameters.

Member Function Documentation

◆ addUDSessionParamWriter()

void Vertica::SessionParamWriterMap::addUDSessionParamWriter ( const std::string &  nsp,
ParamWriter sessionParamWriter 
)
inline

Add a SessionParamWriter for a namespace.

Parameters
Thenamespace and the ParamReader

Referenced by getUDSessionParamWriter().

◆ containsNamespace()

bool Vertica::SessionParamWriterMap::containsNamespace ( const std::string  nsp) const
inline

Check if a SessionParamWriter for the Namespace exists in the map.

Parameters
Thenamespace
Returns
true if the SessionParamWriter for the Namespace exists false otherwise

◆ getNamespaces()

std::vector<std::string> Vertica::SessionParamWriterMap::getNamespaces ( ) const
inline

Gets the names of all namespaces.

Returns
a vector of column namespaces

◆ getUDSessionParamWriter() [1/3]

ParamWriter& Vertica::SessionParamWriterMap::getUDSessionParamWriter ( const std::string &  nsp)
inline

Get a SessionParamWriter for a namespace.

Parameters
Thenamespace
Returns
The SessionParamWriter

◆ getUDSessionParamWriter() [2/3]

const ParamWriter& Vertica::SessionParamWriterMap::getUDSessionParamWriter ( const std::string &  nsp) const
inline

Get a SessionParamWriter for a namespace.

Parameters
Thenamespace
Returns
The SessionParamWriter

◆ getUDSessionParamWriter() [3/3]

ParamWriter& Vertica::SessionParamWriterMap::getUDSessionParamWriter ( )
inline

Get a SessionParamWriter for a namespace library.

Returns
The SessionParamWriter