Produced by IDL 7.1.1
Developer Documentation

./toolbox/io
key_value_parser__define.pro

Last modification date:
Wed Sep 28 13:27:14 2016

This class tries to make working with an array of key value pairs easier

Fields Summary
KEY_VALUE_STRINGS
pointer
pointer to string array of key-value pairs
KEY_VALUE_STRCT
pointer
poinrter to structure based of key_value_strings

Routine Summary  8 routines

procedure key_value_parser__define

This class tries to make working with key -value pairs easier

function KEY_VALUE_PARSER::init(key_value_strings)

private

Class Constructor

procedure KEY_VALUE_PARSER::cleanup

private

Class Destructor

procedure KEY_VALUE_PARSER::create_key_value_strct

Creates key-value structure based off the key-value string array

procedure KEY_VALUE_PARSER::list

Prints the contents of the key-value structure

function KEY_VALUE_PARSER::get_keys()

Retrieves the keys in use

function KEY_VALUE_PARSER::get_key_value(keyword)

Given the key, returns the value

function KEY_VALUE_PARSER::set_key_value(keyword, value)

Given the key, sets the value

Routine Details

key_value_parser__define

procedure key_value_parser__define

This class tries to make working with key -value pairs easier

KEY_VALUE_PARSER::init private

function KEY_VALUE_PARSER::init(key_value_strings)

Class Constructor

Parameters
key_value_strings
.

KEY_VALUE_PARSER::cleanup private

procedure KEY_VALUE_PARSER::cleanup

Class Destructor

KEY_VALUE_PARSER::create_key_value_strct

procedure KEY_VALUE_PARSER::create_key_value_strct

Creates key-value structure based off the key-value string array

KEY_VALUE_PARSER::list

procedure KEY_VALUE_PARSER::list

Prints the contents of the key-value structure

KEY_VALUE_PARSER::get_keys

function KEY_VALUE_PARSER::get_keys()

Retrieves the keys in use

Returns
string array of keys

KEY_VALUE_PARSER::get_key_value

function KEY_VALUE_PARSER::get_key_value(keyword)

Given the key, returns the value

Returns
string value, -1 if key not found

Parameters
keyword
.

KEY_VALUE_PARSER::set_key_value

function KEY_VALUE_PARSER::set_key_value(keyword, value)

Given the key, sets the value

Returns
0 if key not found, 1 value set

Parameters
keyword
.
value
.


Produced by IDLdoc 1.6 on Wed Sep 28 13:27:29 2016