OSFI-Fortran  3.9.2
OpenSF Integration Library
osfi_confm::osfi_parameter Type Reference

Type that wraps the Parameter class in OSFI-C++. More...

Inheritance diagram for osfi_confm::osfi_parameter:

Public Member Functions

Procedure print => param_print
 Wraps Parameter::print, writing parameter details to the "info" channel.
 
Procedure getname => param_get_local_name
 
Procedure getlocalname => param_get_local_name
 Returns the local name of the parameter (last element of the path). Returns an empty string if invalid.
 
Procedure getpath => param_get_path
 Returns the full path of the parameter. Returns an empty string if invalid.
 
Procedure isleaf => param_is_leaf
 Wraps Parameter::isLeaf.
 
Procedure isarray => param_is_array
 Wraps Parameter::isArray.
 
Procedure getelementtype => param_get_eltype
 Wraps Parameter::getElementType.
 
Generic getdims => getnodedims, getrectdims
 Generic overload for Parameter::getDims() and Parameter::getDims(std::vector<int>).
 
Procedure getintvalue => param_getval_scalar_integer
 
Procedure getdoublevalue => param_getval_scalar_double
 
Procedure getbooleanvalue => param_getval_scalar_boolean
 
Procedure gettimevalue => param_getval_scalar_time
 
Procedure getstringvalue => param_getval_scalar_string
 
Procedure getfilevalue => param_getval_scalar_file
 
Generic getvectorint => getflatvectorint, getleafvectorint
 
Generic getvectordouble => getflatvectordouble, getleafvectordouble
 
Generic getvectorboolean => getflatvectorboolean, getleafvectorboolean
 
Generic getvectortime => getflatvectortime, getleafvectortime
 
Generic getvectorstring => getflatvectorstring, getleafvectorstring
 
Generic getvectorfile => getflatvectorfile, getleafvectorfile
 
Procedure getmatrixint => param_getval_matrix_integer
 
Procedure getmatrixdouble => param_getval_matrix_double
 
Procedure getmatrixboolean => param_getval_matrix_boolean
 
Procedure getmatrixtime => param_getval_matrix_time
 
Procedure getmatrixstring => param_getval_matrix_string
 
Procedure getmatrixfile => param_getval_matrix_file
 
Procedure getfileexist => param_get_fileexist
 

Detailed Description

Type that wraps the Parameter class in OSFI-C++.

Member Function/Subroutine Documentation

◆ getname()

Procedure osfi_confm::osfi_parameter::getname
Deprecated:
Ambiguous function, use getLocalName or getPath instead

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