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.

Procedure	getdescription => param_get_description
	Wraps Parameter::getDescription.

Procedure	getmin => param_get_min_value
	Wraps Parameter::getMin.

Procedure	getmax => param_get_max_value
	Wraps Parameter::getMax.

Procedure	getunits => param_get_units
	Wraps Parameter::getUnits.

Procedure	getrawvalue => param_get_raw_value
	Wraps Parameter::getRawValue.

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

Public Member Functions inherited from osfi_base::osfi_handle
Procedure	isvalid => oh_isvalid
	Returns true if the handle is valid (not null). Calling any other methods on this instance while this function returns false is not allowed unless otherwise specified.

Additional Inherited Members
Public Attributes inherited from osfi_base::osfi_handle
type(c_ptr)	handle = C_NULL_PTR
	Handle to OSFI-C++ object managed by this instance.

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:

src/f90/OSFI_ConFM.f90

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function/Subroutine Documentation

◆ getname()