IGLib 1.4
The IGLib base library for development of numerical, technical and business applications.

IG::Num::InputElementDefinition Class Reference

Input data element definition for vector functions, approximations, etc. More...

Inheritance diagram for IG::Num::InputElementDefinition:
Collaboration diagram for IG::Num::InputElementDefinition:

List of all members.

Public Member Functions

 InputElementDefinition (int elementIndex, string name, string title, string description)
 Constructor.
 InputElementDefinition (string name)
 Constructor. Element index is unknown, there is no element description.
 InputElementDefinition (string name, string title)
 Constructor. Element index is unknown.
 InputElementDefinition (string name, string title, string description)
 Constructor. Element index is unknown.
InputElementDefinition GetCopy ()
 Creates and returns a deep copy of the current input data element definition.
override string ToString ()

Static Public Member Functions

static void CopyPlain (InputElementDefinition original, InputElementDefinition copy)
 Copies data from one input data element definition to another.
static void Copy (InputElementDefinition original, ref InputElementDefinition copy)
 Copies data from one input data element definition to another.

Protected Attributes

bool _defaultValueDefined = false
double _defaultValue
bool _optimizationIndexDefined = false
int _optimizationIndex
double _discretizationStep = 0.0

Properties

virtual bool DefaultValueDefined [get, set]
 Flag indicating whether default value is defined for the input parameter described by the current eleemnt description.
virtual double DefaultValue [get, set]
 Default value for the output data element described by the current definition.
virtual bool OptimizationIndexSpecified [get, set]
 Flag indicating whether optimization parameter index is defined for the input parameter described by the current element description. This index tells which optimization parameter corresponds to the current sampled data input parameter.
virtual int OptimizationIndex [get, set]
 Optimization parameter index of the data element described by the current definition. This index tells which optimization parameter corresponds to the current sampled data input parameter.
virtual double DiscretizationStep [get, set]
 Discretization step that is used in cases where parameter the input parameter has discrete values. Discretization starts at MinValue.

Detailed Description

Input data element definition for vector functions, approximations, etc.

$A Igor Feb11;


Constructor & Destructor Documentation

IG::Num::InputElementDefinition::InputElementDefinition ( int  elementIndex,
string  name,
string  title,
string  description 
) [inline]

Constructor.

Parameters:
elementIndexIndex of the input or output data element specified by the current definision. If less than 0 is specified then it is considered that element index is not known or defined in the current context.
nameElement name. Should comply with conventions for valid variable names in languages C++, C# and Java.
titleShort descriptive title (like name, but can contain spaces and special characters).
descriptionElement description. Can be an arbvitrary string.
IG::Num::InputElementDefinition::InputElementDefinition ( string  name) [inline]

Constructor. Element index is unknown, there is no element description.

Parameters:
nameElement name. Should comply with conventions for valid variable names in languages C++, C# and Java.
IG::Num::InputElementDefinition::InputElementDefinition ( string  name,
string  title 
) [inline]

Constructor. Element index is unknown.

Parameters:
elementIndexIndex of the input or output data element specified by the current definision. If less than 0 is specified then it is considered that element index is not known or defined in the current context.
nameElement name. Should comply with conventions for valid variable names in languages C++, C# and Java.
titleShort descriptive title (like name, but can contain spaces and special characters).
IG::Num::InputElementDefinition::InputElementDefinition ( string  name,
string  title,
string  description 
) [inline]

Constructor. Element index is unknown.

Parameters:
elementIndexIndex of the input or output data element specified by the current definision. If less than 0 is specified then it is considered that element index is not known or defined in the current context.
nameElement name. Should comply with conventions for valid variable names in languages C++, C# and Java.
titleShort descriptive title (like name, but can contain spaces and special characters).
descriptionElement description. Can be an arbitrary string.

Member Function Documentation

InputElementDefinition IG::Num::InputElementDefinition::GetCopy ( ) [inline]

Creates and returns a deep copy of the current input data element definition.

Returns:
static void IG::Num::InputElementDefinition::CopyPlain ( InputElementDefinition  original,
InputElementDefinition  copy 
) [inline, static]

Copies data from one input data element definition to another.

Parameters:
originalSource object that data is copied from.
copyObject to which data is copied.

Operation is performed only if both sorce and destination objects are non-null.

static void IG::Num::InputElementDefinition::Copy ( InputElementDefinition  original,
ref InputElementDefinition  copy 
) [inline, static]

Copies data from one input data element definition to another.

Parameters:
originalSource object that data is copied from.
copyObject to which data is copied.

If original object is null then destination object is also set to null. If destination object is nul then it is allocated anew.

override string IG::Num::InputElementDefinition::ToString ( ) [inline]

Member Data Documentation


Property Documentation

virtual bool IG::Num::InputElementDefinition::DefaultValueDefined [get, set]

Flag indicating whether default value is defined for the input parameter described by the current eleemnt description.

virtual double IG::Num::InputElementDefinition::DefaultValue [get, set]

Default value for the output data element described by the current definition.

virtual bool IG::Num::InputElementDefinition::OptimizationIndexSpecified [get, set]

Flag indicating whether optimization parameter index is defined for the input parameter described by the current element description. This index tells which optimization parameter corresponds to the current sampled data input parameter.

virtual int IG::Num::InputElementDefinition::OptimizationIndex [get, set]

Optimization parameter index of the data element described by the current definition. This index tells which optimization parameter corresponds to the current sampled data input parameter.

virtual double IG::Num::InputElementDefinition::DiscretizationStep [get, set]

Discretization step that is used in cases where parameter the input parameter has discrete values. Discretization starts at MinValue.

This field was required by the Jozef Stefan optimization group.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties Events