MAST
Public Member Functions | Protected Attributes | List of all members
MAST::FunctionBase Class Reference

#include <function_base.h>

Inheritance diagram for MAST::FunctionBase:
Inheritance graph
[legend]

Public Member Functions

 FunctionBase (const std::string &nm, const bool is_field_func)
 initializes the parameter to the given name More...
 
 FunctionBase (const MAST::FunctionBase &f)
 Copy constructor. More...
 
virtual ~FunctionBase ()
 virtual destructor More...
 
const std::string & name () const
 returns the name of this function More...
 
virtual bool depends_on (const MAST::FunctionBase &f) const
 returns true if the function depends on the provided value More...
 
virtual bool is_shape_parameter () const
 
virtual void set_as_shape_parameter (bool f)
 
virtual bool is_topology_parameter () const
 
virtual void set_as_topology_parameter (bool f)
 

Protected Attributes

std::string _name
 name of this parameter More...
 
bool _is_field_func
 flag to store the nature of field function More...
 
bool _is_shape_parameter
 
bool _is_topology_parameter
 
std::set< const MAST::FunctionBase * > _functions
 set of functions that this function depends on More...
 

Detailed Description

Definition at line 35 of file function_base.h.

Constructor & Destructor Documentation

MAST::FunctionBase::FunctionBase ( const std::string &  nm,
const bool  is_field_func 
)

initializes the parameter to the given name

Definition at line 24 of file function_base.cpp.

MAST::FunctionBase::FunctionBase ( const MAST::FunctionBase &  f)

Copy constructor.

Definition at line 35 of file function_base.cpp.

virtual MAST::FunctionBase::~FunctionBase ( )
inlinevirtual

virtual destructor

Definition at line 54 of file function_base.h.

Member Function Documentation

virtual bool MAST::FunctionBase::depends_on ( const MAST::FunctionBase &  f) const
inlinevirtual

returns true if the function depends on the provided value

Reimplemented in MAST::Parameter.

Definition at line 68 of file function_base.h.

Here is the caller graph for this function:

virtual bool MAST::FunctionBase::is_shape_parameter ( ) const
inlinevirtual
Returns
true if the function is a shape parameter. False by default.

Definition at line 89 of file function_base.h.

Here is the caller graph for this function:

virtual bool MAST::FunctionBase::is_topology_parameter ( ) const
inlinevirtual
Returns
true if the function is a topology parameter. False by default.

Definition at line 97 of file function_base.h.

Here is the caller graph for this function:

const std::string& MAST::FunctionBase::name ( ) const
inline

returns the name of this function

Definition at line 60 of file function_base.h.

Here is the caller graph for this function:

virtual void MAST::FunctionBase::set_as_shape_parameter ( bool  f)
inlinevirtual

Definition at line 90 of file function_base.h.

virtual void MAST::FunctionBase::set_as_topology_parameter ( bool  f)
inlinevirtual

Definition at line 98 of file function_base.h.

Member Data Documentation

std::set<const MAST::FunctionBase*> MAST::FunctionBase::_functions
protected

set of functions that this function depends on

Definition at line 118 of file function_base.h.

bool MAST::FunctionBase::_is_field_func
protected

flag to store the nature of field function

Definition at line 110 of file function_base.h.

bool MAST::FunctionBase::_is_shape_parameter
protected

Definition at line 112 of file function_base.h.

bool MAST::FunctionBase::_is_topology_parameter
protected

Definition at line 113 of file function_base.h.

std::string MAST::FunctionBase::_name
protected

name of this parameter

Definition at line 105 of file function_base.h.

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