Aws::Client::ParameterPath Class Reference

#include <parameter_reader.h>

Public Member Functions
std::string	get_resolved_path (char node_namespace_separator, char parameter_namespace_separator) const
const ParameterPath	operator+ (const std::string &addend) const
ParameterPath &	operator+= (const std::string &addend)
bool	operator== (const ParameterPath &other) const
	ParameterPath (const std::vector< std::string > &node_namespaces, const std::vector< std::string > &parameter_path_keys)
template<typename... Args>
	ParameterPath (Args...parameter_path_keys)

Private Member Functions
std::string	get_local_path (char parameter_namespace_separator) const
std::string	get_node_path (char node_namespace_separator) const

Private Attributes
std::vector< std::string >	node_namespaces_
std::vector< std::string >	parameter_path_keys_

Detailed Description

Definition at line 28 of file parameter_reader.h.

Constructor & Destructor Documentation

Aws::Client::ParameterPath::ParameterPath ( const std::vector< std::string > &  node_namespaces, const std::vector< std::string > &  parameter_path_keys  )

inlineexplicit

Definition at line 40 of file parameter_reader.h.

template<typename... Args>

Aws::Client::ParameterPath::ParameterPath ( Args...  parameter_path_keys )

inlineexplicit

Definition at line 51 of file parameter_reader.h.

Member Function Documentation

std::string Aws::Client::ParameterPath::get_local_path ( char  parameter_namespace_separator ) const

private

Note

Only applies if parameter_path_keys was specified during construction; otherwise, an empty string is returned.

Parameters

parameter_namespace_separator

Returns

string The parameter path including parameter namespaces but excluding node's namespaces.

Definition at line 46 of file parameter_path.cpp.

std::string Aws::Client::ParameterPath::get_node_path ( char  node_namespace_separator ) const

private

Note

Only applies if node_namespaces was specified during construction; otherwise, an empty string is returned.

Parameters

node_namespace_separator

Returns

string The parameter's whereabouts in the node namespace hierarchy.

Definition at line 33 of file parameter_path.cpp.

std::string Aws::Client::ParameterPath::get_resolved_path	(	char	node_namespace_separator,
		char	parameter_namespace_separator
	)		const

Resolves & returns the parameter's path. Supports two separate use cases:

1. A single, 'flat' string was provided upon construction. In this case, we return it as is.
2. Detailed lists of strings were specified for the parameter & node namespaces. In this case, we construct the resolved path using the provided separators.

   Parameters

   node_namespace_separator
   parameter_namespace_separator

   Returns

   string representing the full, resolved path of the parameter.

   Note

   If node_namespaces and parameter_path_keys are empty, an empty string would be returned.

Definition at line 22 of file parameter_path.cpp.

const ParameterPath Aws::Client::ParameterPath::operator+

(

const std::string &

addend

)

const

Appends string as another parameter path component (not nodename namespace component!)

Parameters

addend

new parameter path component

Returns

new ParameterPath object with the parameter path component appended

Definition at line 59 of file parameter_path.cpp.

ParameterPath & Aws::Client::ParameterPath::operator+=

(

const std::string &

addend

)

Appends string as another parameter path component (not nodename namespace component!)

Parameters

addend

new parameter path component

Returns

current ParameterPath object with the parameter path component appended

Definition at line 66 of file parameter_path.cpp.

bool Aws::Client::ParameterPath::operator== ( const ParameterPath &  other ) const

inline

Checks for equivalence between two ParameterPath objects

Parameters

addend

new parameter path component

Returns

current ParameterPath object with the parameter path component appended

Definition at line 73 of file parameter_reader.h.

Member Data Documentation

std::vector<std::string> Aws::Client::ParameterPath::node_namespaces_

private

Member variables to store the parameter's path in the namespace hierarchy. node_namespaces_ Node namespaces list. parameter_path_keys_ Parameter namespaces list.

Definition at line 112 of file parameter_reader.h.

std::vector<std::string> Aws::Client::ParameterPath::parameter_path_keys_

private

Definition at line 113 of file parameter_reader.h.

---

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

• parameter_reader.h
• parameter_path.cpp