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

#include <param_base.hh>

Inheritance diagram for param:
Inheritance graph

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 22 of file param_base.hh.

Constructor & Destructor Documentation

param ( )

Definition at line 23 of file param_base.cc.

param ( const param orig)

Definition at line 27 of file param_base.cc.

~param ( )
virtual

Definition at line 31 of file param_base.cc.

Member Function Documentation

param_array & as_array ( )
inline

Definition at line 52 of file param_base_impl.hh.

const param_array & as_array ( ) const
inline

Definition at line 70 of file param_base_impl.hh.

param_node & as_node ( )
inline

Definition at line 58 of file param_base_impl.hh.

const param_node & as_node ( ) const
inline

Definition at line 76 of file param_base_impl.hh.

param_value & as_value ( )
inline

Definition at line 46 of file param_base_impl.hh.

const param_value & as_value ( ) const
inline

Definition at line 64 of file param_base_impl.hh.

param * clone ( ) const
inlinevirtual

Reimplemented in param_node, param_array, and param_value.

Definition at line 20 of file param_base_impl.hh.

bool has_subset ( const param a_subset) const
virtual

Reimplemented in param_node, param_array, and param_value.

Definition at line 35 of file param_base.cc.

bool is_array ( ) const
inlinevirtual

Reimplemented in param_array.

Definition at line 36 of file param_base_impl.hh.

bool is_node ( ) const
inlinevirtual

Reimplemented in param_node.

Definition at line 41 of file param_base_impl.hh.

bool is_null ( ) const
inlinevirtual

Reimplemented in param_node, param_array, and param_value.

Definition at line 26 of file param_base_impl.hh.

bool is_value ( ) const
inlinevirtual

Reimplemented in param_value.

Definition at line 31 of file param_base_impl.hh.

const param_value & operator() ( ) const
inline

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

Definition at line 82 of file param_base_impl.hh.

param_value & operator() ( )
inline

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

Definition at line 87 of file param_base_impl.hh.

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

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

Definition at line 92 of file param_base_impl.hh.

param & operator[] ( unsigned  a_index)
inline

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

Definition at line 97 of file param_base_impl.hh.

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

Assumes that the parameter is a node, and returns a reference to the param corresponding to a_name. Throws a scarab::error if a_name is not present.

Definition at line 102 of file param_base_impl.hh.

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

Assumes that the parameter is a node, and returns a reference to the param corresponding to a_name. Throws a scarab::error if a_name is not present.

Definition at line 107 of file param_base_impl.hh.

std::string to_string ( ) const
inlinevirtual

Reimplemented in param_node, param_array, and param_value.

Definition at line 112 of file param_base_impl.hh.

Member Data Documentation

SCARAB_API unsigned s_indent_level = 0
static

Definition at line 67 of file param_base.hh.


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