IGLib  1.7.2
The IGLib base library for development of numerical, technical and business applications.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
IG.Num.InputElementDefinitionDto Class Reference

DTO (data transfer object) for data input element definition. More...

+ Inheritance diagram for IG.Num.InputElementDefinitionDto:
+ Collaboration diagram for IG.Num.InputElementDefinitionDto:

Public Member Functions

 InputElementDefinitionDto ()
 
override InputElementDefinition CreateObject ()
 Creates and returns an object consistent with current contents of the vector. More...
 
- Public Member Functions inherited from IG.Num.InputOutputElementDefinitionDto< ElementType >
 InputOutputElementDefinitionDto ()
 
override ElementType CreateObject ()
 Creates and returns an object consistent with current DTO. More...
 

Public Attributes

bool DefaultValueDefined
 Flag indicating whether default value is defined for the input parameter described by the current eleemnt description. More...
 
double DefaultValue
 Default value for the output data element described by the current definition. More...
 
bool OptimizationIndexSpecified
 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. More...
 
int OptimizationIndex
 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. More...
 
double DiscretizationStep = 0.0
 Discretization step that is used in cases where parameter the input parameter has discrete values. Discretization starts at MinValue. More...
 
int NumSamplingPoints = 0
 Number of sampling points. More...
 
- Public Attributes inherited from IG.Num.InputOutputElementDefinitionDto< ElementType >
string Name
 Unique name of the data element described by the current definition. Considered a kind of variable name that distinguishes between data by short names. More...
 
string NameAlt
 Alternative name of the data element described by the current definition. More...
 
string Title
 A title describing what given data element represents. Titles can contain special characters and spaces, but should be shorter than descriptions. More...
 
string Description
 Describes the meaning of a data element used as part of input or output data. More...
 
bool IsInput
 Flag specifying whether a data element is input or output element. More...
 
bool ElementIndexSpecified = false
 Specifies whether element index is specified for the data element described by the current definition. More...
 
int ElementIndex = -1
 Specifies the index f the element described by the current definition, within the data vextor (either input or output). More...
 
bool BoundsDefined = false
 Flag indicating whethe minimal and maximal value are defined for the input data element described by the current definition. More...
 
double MinimalValue
 Minimal value for the output data element described by the current definition. More...
 
double MaximalValue
 Maximal value for the output data element described by the current definition. More...
 
bool TargetValueDefined = false
 Flag indicating whether target value is defined for the data element described by the current definition. More...
 
double TargetValue = 0.0
 Target value of the current element. Used for optimization. More...
 
bool ScalingLengthDefined = false
 Flag indicating whether scaling length is defined for the data element described by the current definition. More...
 
double ScalingLength = 0.0
 Scaling length, used for optimization and other tasks where scaling of input or output quantities is important. More...
 

Protected Member Functions

override void CopyFromPlain (InputOutputElementDefinition obj)
 
override void CopyToPlain (ref InputOutputElementDefinition obj)
 
- Protected Member Functions inherited from IG.Num.InputOutputElementDefinitionDto< ElementType >
override void CopyFromPlain (InputOutputElementDefinition obj)
 Copies data from the specified object to the current DTO (data transfer object). More...
 
override void CopyToPlain (ref InputOutputElementDefinition obj)
 Copies data from the current DTO to the specified object. More...
 

Detailed Description

DTO (data transfer object) for data input element definition.

$A Ifor Mar11;

Constructor & Destructor Documentation

IG.Num.InputElementDefinitionDto.InputElementDefinitionDto ( )
inline

Member Function Documentation

override InputElementDefinition IG.Num.InputElementDefinitionDto.CreateObject ( )
inline

Creates and returns an object consistent with current contents of the vector.

Member Data Documentation

bool IG.Num.InputElementDefinitionDto.DefaultValueDefined

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

double IG.Num.InputElementDefinitionDto.DefaultValue

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

bool IG.Num.InputElementDefinitionDto.OptimizationIndexSpecified

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.

int IG.Num.InputElementDefinitionDto.OptimizationIndex

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.

double IG.Num.InputElementDefinitionDto.DiscretizationStep = 0.0

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.

int IG.Num.InputElementDefinitionDto.NumSamplingPoints = 0

Number of sampling points.


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