Flow123d  master-f44eb46
Classes | Enumerations | Functions
Input::Type Namespace Reference

Classes

class  Attribute
 Class with static methods provided common attributes of Input::Type objects. More...
 
class  Abstract
 Class for declaration of polymorphic Record. More...
 
class  AdHocAbstract
 Class for declaration of polymorphic Record. More...
 
class  TypeBase
 Base of classes for declaring structure of the input data. More...
 
class  Array
 Class for declaration of inputs sequences. More...
 
class  Scalar
 Base of all scalar types. More...
 
class  Bool
 Class for declaration of the input of type Bool. More...
 
class  Integer
 Class for declaration of the integral input data. More...
 
class  Double
 Class for declaration of the input data that are floating point numbers. More...
 
class  String
 Class for declaration of the input data that are in string format. More...
 
class  FileName
 Class for declaration of the input data that are file names. More...
 
class  Parameter
 Class for representing parametric types in IST. More...
 
class  Instance
 Helper class that stores data of generic types. More...
 
struct  RevNumData
 Stores version of program and other base data of application. More...
 
class  OutputBase
 Base abstract class for output description of the Input::Type tree. More...
 
class  OutputText
 Class for create text documentation. More...
 
class  OutputJSONMachine
 Class for create JSON machine readable documentation. More...
 
class  Default
 Class Input::Type::Default specifies default value of keys of a Input::Type::Record. More...
 
class  Record
 Record type proxy class. More...
 
class  Selection
 Template for classes storing finite set of named values. More...
 
class  Tuple
 Tuple type proxy class. More...
 

Enumerations

enum  FinishStatus {
  none_ , in_perform_ , regular_ , generic_ ,
  delete_
}
 

Functions

std::ostream & operator<< (std::ostream &stream, const TypeBase &type)
 For convenience we provide also redirection operator for output documentation of Input:Type classes. More...
 
 ARRAY_CONSTRUCT (String)
 
 ARRAY_CONSTRUCT (Integer)
 
 ARRAY_CONSTRUCT (Double)
 
 ARRAY_CONSTRUCT (Bool)
 
 ARRAY_CONSTRUCT (FileName)
 
 ARRAY_CONSTRUCT (Selection)
 
 ARRAY_CONSTRUCT (Array)
 
 ARRAY_CONSTRUCT (Record)
 
 ARRAY_CONSTRUCT (Tuple)
 
 ARRAY_CONSTRUCT (Abstract)
 
 ARRAY_CONSTRUCT (Parameter)
 
 ARRAY_CONSTRUCT (Instance)
 
 TYPEDEF_ERR_INFO (EI_KeyName, const string)
 
 TYPEDEF_ERR_INFO (EI_DefaultStr, const string)
 
 TYPEDEF_ERR_INFO (EI_TypeName, const string)
 
 TYPEDEF_ERR_INFO (EI_Desc, const string)
 
 DECLARE_EXCEPTION (ExcWrongDefaultJSON,<< "Consistency Error: Not valid JSON of Default value "<< EI_DefaultStr::qval<< " of type "<< EI_TypeName::qval<< ";\n"<< "During declaration of the key: "<< EI_KeyName::qval)
 
 DECLARE_EXCEPTION (ExcWrongDefault,<< "Consistency Error: "<< EI_Desc::val<< "Default value "<< EI_DefaultStr::qval<< " do not match type: "<< EI_TypeName::qval<< ";\n"<< "During declaration of the key: "<< EI_KeyName::qval)
 
 DECLARE_EXCEPTION (ExcUnknownDescendant,<< "Unknown descendant of TypeBase class, name: "<< EI_TypeName::qval)
 
 TYPEDEF_ERR_INFO (EI_Object, std::string)
 
 TYPEDEF_ERR_INFO (EI_ParameterList, std::string)
 
 DECLARE_EXCEPTION (ExcParamaterNotSubsituted,<< "No input type substitution for input type parameter "<< EI_Object::qval<< " found during creation of instance with parameter list: "<< EI_ParameterList::val<< ".")
 
 DECLARE_EXCEPTION (ExcParamaterInIst,<< "Parameter "<< EI_Object::qval<< " appears in the IST. Check where Instance is missing.")
 
 DECLARE_EXCEPTION (ExcGenericWithoutInstance,<< "Root of generic subtree "<< EI_Object::qval<< " used without Instance.\n Used in type: "<< EI_TypeName::qval)
 
std::string print_attributes (TypeBase::attribute_map attribute_map)
 
std::ostream & operator<< (std::ostream &stream, OutputText type_output)
 Redirect text output to stream. More...
 
std::ostream & operator<< (std::ostream &stream, OutputJSONMachine type_output)
 Redirect machine readable output to stream. More...
 
 RECORD_DECLARE_KEY (String)
 
 RECORD_DECLARE_KEY (Integer)
 
 RECORD_DECLARE_KEY (Double)
 
 RECORD_DECLARE_KEY (Bool)
 
 RECORD_DECLARE_KEY (FileName)
 
 RECORD_DECLARE_KEY (Selection)
 
 RECORD_DECLARE_KEY (Array)
 
 RECORD_DECLARE_KEY (Record)
 
 RECORD_DECLARE_KEY (Abstract)
 
 RECORD_DECLARE_KEY (AdHocAbstract)
 
 RECORD_DECLARE_KEY (Parameter)
 
 RECORD_DECLARE_KEY (Instance)
 
 RECORD_DECLARE_KEY (Tuple)
 
 TUPLE_DECLARE_KEY (String)
 
 TUPLE_DECLARE_KEY (Integer)
 
 TUPLE_DECLARE_KEY (Double)
 
 TUPLE_DECLARE_KEY (Bool)
 
 TUPLE_DECLARE_KEY (FileName)
 
 TUPLE_DECLARE_KEY (Selection)
 
 TUPLE_DECLARE_KEY (Array)
 
 TUPLE_DECLARE_KEY (Record)
 
 TUPLE_DECLARE_KEY (Abstract)
 
 TUPLE_DECLARE_KEY (AdHocAbstract)
 
 TUPLE_DECLARE_KEY (Parameter)
 
 TUPLE_DECLARE_KEY (Instance)
 
 TUPLE_DECLARE_KEY (Tuple)
 

Enumeration Type Documentation

◆ FinishStatus

FinishStatus manages finish of elements in IST.

Specifies:

  • finish status of IST elements
  • type of executing finish
Enumerator
none_ 
in_perform_ 
regular_ 
generic_ 
delete_ 

Definition at line 74 of file type_base.hh.

Function Documentation

◆ ARRAY_CONSTRUCT() [1/12]

Input::Type::ARRAY_CONSTRUCT ( Abstract  )

◆ ARRAY_CONSTRUCT() [2/12]

Input::Type::ARRAY_CONSTRUCT ( Array  )

◆ ARRAY_CONSTRUCT() [3/12]

Input::Type::ARRAY_CONSTRUCT ( Bool  )

◆ ARRAY_CONSTRUCT() [4/12]

Input::Type::ARRAY_CONSTRUCT ( Double  )

◆ ARRAY_CONSTRUCT() [5/12]

Input::Type::ARRAY_CONSTRUCT ( FileName  )

◆ ARRAY_CONSTRUCT() [6/12]

Input::Type::ARRAY_CONSTRUCT ( Instance  )

◆ ARRAY_CONSTRUCT() [7/12]

Input::Type::ARRAY_CONSTRUCT ( Integer  )

◆ ARRAY_CONSTRUCT() [8/12]

Input::Type::ARRAY_CONSTRUCT ( Parameter  )

◆ ARRAY_CONSTRUCT() [9/12]

Input::Type::ARRAY_CONSTRUCT ( Record  )

◆ ARRAY_CONSTRUCT() [10/12]

Input::Type::ARRAY_CONSTRUCT ( Selection  )

◆ ARRAY_CONSTRUCT() [11/12]

Input::Type::ARRAY_CONSTRUCT ( String  )

◆ ARRAY_CONSTRUCT() [12/12]

Input::Type::ARRAY_CONSTRUCT ( Tuple  )

◆ DECLARE_EXCEPTION() [1/6]

Input::Type::DECLARE_EXCEPTION ( ExcGenericWithoutInstance  ,
<< "Root of generic subtree "<< EI_Object::qval<< " used without Instance.\n Used in type: "<< EI_TypeName::qval   
)

◆ DECLARE_EXCEPTION() [2/6]

Input::Type::DECLARE_EXCEPTION ( ExcParamaterInIst  ,
<< "Parameter "<< EI_Object::qval<< " appears in the IST. Check where Instance is missing."   
)

◆ DECLARE_EXCEPTION() [3/6]

Input::Type::DECLARE_EXCEPTION ( ExcParamaterNotSubsituted  ,
<< "No input type substitution for input type parameter "<< EI_Object::qval<< " found during creation of instance with parameter list: "<< EI_ParameterList::val<< "."   
)

◆ DECLARE_EXCEPTION() [4/6]

Input::Type::DECLARE_EXCEPTION ( ExcUnknownDescendant  ,
<< "Unknown descendant of TypeBase  class,
name:"<< EI_TypeName::qval   
)

◆ DECLARE_EXCEPTION() [5/6]

Input::Type::DECLARE_EXCEPTION ( ExcWrongDefault  ,
<< "Consistency Error: "<< EI_Desc::val<< "Default value "<< EI_DefaultStr::qval<< " do not match type: "<< EI_TypeName::qval<< ";\n"<< "During declaration of the key: "<< EI_KeyName::qval   
)

◆ DECLARE_EXCEPTION() [6/6]

Input::Type::DECLARE_EXCEPTION ( ExcWrongDefaultJSON  ,
<< "Consistency Error: Not valid JSON of Default value "<< EI_DefaultStr::qval<< " of type "<< EI_TypeName::qval<< ";\n"<< "During declaration of the key: "<< EI_KeyName::qval   
)

◆ operator<<() [1/3]

std::ostream & Input::Type::operator<< ( std::ostream &  stream,
const TypeBase type 
)

For convenience we provide also redirection operator for output documentation of Input:Type classes.

Definition at line 239 of file type_base.cc.

◆ operator<<() [2/3]

std::ostream & Input::Type::operator<< ( std::ostream &  stream,
OutputJSONMachine  type_output 
)

Redirect machine readable output to stream.

Definition at line 872 of file type_output.cc.

◆ operator<<() [3/3]

std::ostream & Input::Type::operator<< ( std::ostream &  stream,
OutputText  type_output 
)

Redirect text output to stream.

Definition at line 867 of file type_output.cc.

◆ print_attributes()

std::string Input::Type::print_attributes ( TypeBase::attribute_map  attribute_map)

Definition at line 527 of file type_output.cc.

Here is the caller graph for this function:

◆ RECORD_DECLARE_KEY() [1/13]

Input::Type::RECORD_DECLARE_KEY ( Abstract  )

◆ RECORD_DECLARE_KEY() [2/13]

Input::Type::RECORD_DECLARE_KEY ( AdHocAbstract  )

◆ RECORD_DECLARE_KEY() [3/13]

Input::Type::RECORD_DECLARE_KEY ( Array  )

◆ RECORD_DECLARE_KEY() [4/13]

Input::Type::RECORD_DECLARE_KEY ( Bool  )

◆ RECORD_DECLARE_KEY() [5/13]

Input::Type::RECORD_DECLARE_KEY ( Double  )

◆ RECORD_DECLARE_KEY() [6/13]

Input::Type::RECORD_DECLARE_KEY ( FileName  )

◆ RECORD_DECLARE_KEY() [7/13]

Input::Type::RECORD_DECLARE_KEY ( Instance  )

◆ RECORD_DECLARE_KEY() [8/13]

Input::Type::RECORD_DECLARE_KEY ( Integer  )

◆ RECORD_DECLARE_KEY() [9/13]

Input::Type::RECORD_DECLARE_KEY ( Parameter  )

◆ RECORD_DECLARE_KEY() [10/13]

Input::Type::RECORD_DECLARE_KEY ( Record  )

◆ RECORD_DECLARE_KEY() [11/13]

Input::Type::RECORD_DECLARE_KEY ( Selection  )

◆ RECORD_DECLARE_KEY() [12/13]

Input::Type::RECORD_DECLARE_KEY ( String  )

◆ RECORD_DECLARE_KEY() [13/13]

Input::Type::RECORD_DECLARE_KEY ( Tuple  )

◆ TUPLE_DECLARE_KEY() [1/13]

Input::Type::TUPLE_DECLARE_KEY ( Abstract  )

◆ TUPLE_DECLARE_KEY() [2/13]

Input::Type::TUPLE_DECLARE_KEY ( AdHocAbstract  )

◆ TUPLE_DECLARE_KEY() [3/13]

Input::Type::TUPLE_DECLARE_KEY ( Array  )

◆ TUPLE_DECLARE_KEY() [4/13]

Input::Type::TUPLE_DECLARE_KEY ( Bool  )

◆ TUPLE_DECLARE_KEY() [5/13]

Input::Type::TUPLE_DECLARE_KEY ( Double  )

◆ TUPLE_DECLARE_KEY() [6/13]

Input::Type::TUPLE_DECLARE_KEY ( FileName  )

◆ TUPLE_DECLARE_KEY() [7/13]

Input::Type::TUPLE_DECLARE_KEY ( Instance  )

◆ TUPLE_DECLARE_KEY() [8/13]

Input::Type::TUPLE_DECLARE_KEY ( Integer  )

◆ TUPLE_DECLARE_KEY() [9/13]

Input::Type::TUPLE_DECLARE_KEY ( Parameter  )

◆ TUPLE_DECLARE_KEY() [10/13]

Input::Type::TUPLE_DECLARE_KEY ( Record  )

◆ TUPLE_DECLARE_KEY() [11/13]

Input::Type::TUPLE_DECLARE_KEY ( Selection  )

◆ TUPLE_DECLARE_KEY() [12/13]

Input::Type::TUPLE_DECLARE_KEY ( String  )

◆ TUPLE_DECLARE_KEY() [13/13]

Input::Type::TUPLE_DECLARE_KEY ( Tuple  )

◆ TYPEDEF_ERR_INFO() [1/6]

Input::Type::TYPEDEF_ERR_INFO ( EI_DefaultStr  ,
const  string 
)

◆ TYPEDEF_ERR_INFO() [2/6]

Input::Type::TYPEDEF_ERR_INFO ( EI_Desc  ,
const  string 
)

◆ TYPEDEF_ERR_INFO() [3/6]

Input::Type::TYPEDEF_ERR_INFO ( EI_KeyName  ,
const  string 
)

Declaration of common exceptions and error info types.

◆ TYPEDEF_ERR_INFO() [4/6]

Input::Type::TYPEDEF_ERR_INFO ( EI_Object  ,
std::string   
)

◆ TYPEDEF_ERR_INFO() [5/6]

Input::Type::TYPEDEF_ERR_INFO ( EI_ParameterList  ,
std::string   
)

◆ TYPEDEF_ERR_INFO() [6/6]

Input::Type::TYPEDEF_ERR_INFO ( EI_TypeName  ,
const  string 
)