Scarab
Project 8 C++ Utility Library
Public Member Functions | Static Public Attributes | List of all members
param Class Reference

#include <param.hh>

Inherited by param_array, param_node, and param_value.

Public Member Functions

 param ()
 
 param (const param &orig)
 
virtual ~param ()
 
virtual paramclone () const
 
virtual bool is_null () const
 
virtual bool is_value () const
 
virtual bool is_array () const
 
virtual bool is_node () const
 
virtual bool has_subset (const param &a_subset) const
 
param_valueas_value ()
 
param_arrayas_array ()
 
param_nodeas_node ()
 
const param_valueas_value () const
 
const param_arrayas_array () const
 
const param_nodeas_node () const
 
const param_valueoperator() () const
 Assumes that the parameter is a value, and returns a reference to itself. More...
 
param_valueoperator() ()
 Assumes that the parameter is a value, and returns a reference to itself. More...
 
const paramoperator[] (unsigned a_index) const
 
paramoperator[] (unsigned a_index)
 
const paramoperator[] (const std::string &a_name) const
 
paramoperator[] (const std::string &a_name)
 
virtual std::string to_string () const
 

Static Public Attributes

static unsigned s_indent_level = 0
 

Detailed Description

Definition at line 30 of file param.hh.

Constructor & Destructor Documentation

param ( )

Definition at line 25 of file param.cc.

param ( const param orig)

Definition at line 29 of file param.cc.

~param ( )
virtual

Definition at line 33 of file param.cc.

Member Function Documentation

param_array & as_array ( )
inline

Definition at line 431 of file param.hh.

const param_array & as_array ( ) const
inline

Definition at line 449 of file param.hh.

param_node & as_node ( )
inline

Definition at line 437 of file param.hh.

const param_node & as_node ( ) const
inline

Definition at line 455 of file param.hh.

param_value & as_value ( )
inline

Definition at line 425 of file param.hh.

const param_value & as_value ( ) const
inline

Definition at line 443 of file param.hh.

param * clone ( ) const
inlinevirtual

Reimplemented in param_node, param_array, and param_value.

Definition at line 399 of file param.hh.

bool has_subset ( const param a_subset) const
virtual

Reimplemented in param_node, param_array, and param_value.

Definition at line 37 of file param.cc.

bool is_array ( ) const
inlinevirtual

Reimplemented in param_array.

Definition at line 415 of file param.hh.

bool is_node ( ) const
inlinevirtual

Reimplemented in param_node.

Definition at line 420 of file param.hh.

bool is_null ( ) const
inlinevirtual

Reimplemented in param_node, param_array, and param_value.

Definition at line 405 of file param.hh.

bool is_value ( ) const
inlinevirtual

Reimplemented in param_value.

Definition at line 410 of file param.hh.

const param_value & operator() ( ) const
inline

Assumes that the parameter is a value, and returns a reference to itself.

Definition at line 461 of file param.hh.

param_value & operator() ( )
inline

Assumes that the parameter is a value, and returns a reference to itself.

Definition at line 466 of file param.hh.

const param & operator[] ( unsigned  a_index) const
inline

Assumes that the parameter is an array, and returns a reference to the KTParam at aIndex. Behavior is undefined if aIndex is out-of-range.

Definition at line 471 of file param.hh.

param & operator[] ( unsigned  a_index)
inline

Assumes that the parameter is an array, and returns a reference to the KTParam at aIndex. Behavior is undefined if aIndex is out-of-range.

Definition at line 476 of file param.hh.

const param & operator[] ( const std::string &  a_name) const
inline

Assumes that the parameter is a node, and returns a reference to the KTParam corresponding to aName. Throws an KTException if aName is not present.

Definition at line 481 of file param.hh.

param & operator[] ( const std::string &  a_name)
inline

Assumes that the parameter is a node, and returns a reference to the KTParam corresponding to aName. Adds a new Value if aName is not present.

Definition at line 486 of file param.hh.

std::string to_string ( ) const
inlinevirtual

Reimplemented in param_node, param_array, and param_value.

Definition at line 491 of file param.hh.

Member Data Documentation

SCARAB_API unsigned s_indent_level = 0
static

Definition at line 75 of file param.hh.


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