The Open FUSION Toolkit 1.0.0-6f445ef
An open-source framework for fusion and plasma science and engineering
Loading...
Searching...
No Matches
Public Member Functions | List of all members
xml_read_attribute Interface Reference

Detailed Description

Extract content of a given type from an attribute on an XML node.

Public Member Functions

subroutine xml_extractdataattribute_double (node, attr_name, output, output_shape, iostat)
 Parse a single double precision value from an XML attribute's content.
 
subroutine xml_extractdataattribute_double1d (node, attr_name, output, output_shape, iostat)
 Parse XML attribute content into a 1D array of double precision values.
 
subroutine xml_extractdataattribute_double2d (node, attr_name, output, output_shape, iostat)
 Parse XML attribute content into a 2D array of double precision values.
 
subroutine xml_extractdataattribute_int (node, attr_name, output, output_shape, iostat)
 Parse a single integer value from an XML attribute's content.
 
subroutine xml_extractdataattribute_int1d (node, attr_name, output, output_shape, iostat)
 Parse XML attribute content into a 1D array of integer values.
 
subroutine xml_extractdataattribute_int2d (node, attr_name, output, output_shape, iostat)
 Parse XML attribute content into a 2D array of integer values.
 
subroutine xml_extractdataattribute_logical (node, attr_name, output, output_shape, iostat)
 Parse a single logical value from an XML attribute's content.
 
subroutine xml_extractdataattribute_logical1d (node, attr_name, output, output_shape, iostat)
 Parse XML attribute content into a 1D array of logical values.
 
subroutine xml_extractdataattribute_logical2d (node, attr_name, output, output_shape, iostat)
 Parse XML attribute content into a 2D array of logical values.
 
subroutine xml_extractdataattribute_string (node, attr_name, output, iostat)
 Get content from an XML attribute as a string.
 

Member Function/Subroutine Documentation

◆ xml_extractdataattribute_double()

subroutine xml_extractdataattribute_double ( type(xml_node), intent(in)  node,
character(len=*), intent(in)  attr_name,
real(r8), intent(out)  output,
integer(i4), dimension(2), intent(out), optional  output_shape,
integer(i4), intent(out), optional  iostat 
)

Parse a single double precision value from an XML attribute's content.

Parameters
[in]nodeXML node
[in]attr_nameAttribute name
[out]outputOutput value
[out]output_shapeShape of the output array (ncols, nrows)
[out]iostatI/O status flag (0 on success)

◆ xml_extractdataattribute_double1d()

subroutine xml_extractdataattribute_double1d ( type(xml_node), intent(in)  node,
character(len=*), intent(in)  attr_name,
real(r8), dimension(:), intent(out), pointer  output,
integer(i4), dimension(2), intent(out), optional  output_shape,
integer(i4), intent(out), optional  iostat 
)

Parse XML attribute content into a 1D array of double precision values.

Parameters
[in]nodeXML node
[in]attr_nameAttribute name
[out]outputOutput array
[out]output_shapeShape of the output array (ncols, nrows)
[out]iostatI/O status flag (0 on success)

◆ xml_extractdataattribute_double2d()

subroutine xml_extractdataattribute_double2d ( type(xml_node), intent(in)  node,
character(len=*), intent(in)  attr_name,
real(r8), dimension(:,:), intent(out), pointer  output,
integer(i4), dimension(2), intent(out), optional  output_shape,
integer(i4), intent(out), optional  iostat 
)

Parse XML attribute content into a 2D array of double precision values.

Parameters
[in]nodeXML node
[in]attr_nameAttribute name
[out]outputOutput array
[out]output_shapeShape of the output array (ncols, nrows)
[out]iostatI/O status flag (0 on success)

◆ xml_extractdataattribute_int()

subroutine xml_extractdataattribute_int ( type(xml_node), intent(in)  node,
character(len=*), intent(in)  attr_name,
integer(i4), intent(out)  output,
integer(i4), dimension(2), intent(out), optional  output_shape,
integer(i4), intent(out), optional  iostat 
)

Parse a single integer value from an XML attribute's content.

Parameters
[in]nodeXML node
[in]attr_nameAttribute name
[out]outputOutput value
[out]output_shapeShape of the output array (ncols, nrows)
[out]iostatI/O status flag (0 on success)

◆ xml_extractdataattribute_int1d()

subroutine xml_extractdataattribute_int1d ( type(xml_node), intent(in)  node,
character(len=*), intent(in)  attr_name,
integer(i4), dimension(:), intent(out), pointer  output,
integer(i4), dimension(2), intent(out), optional  output_shape,
integer(i4), intent(out), optional  iostat 
)

Parse XML attribute content into a 1D array of integer values.

Parameters
[in]nodeXML node
[in]attr_nameAttribute name
[out]outputOutput array
[out]output_shapeShape of the output array (ncols, nrows)
[out]iostatI/O status flag (0 on success)

◆ xml_extractdataattribute_int2d()

subroutine xml_extractdataattribute_int2d ( type(xml_node), intent(in)  node,
character(len=*), intent(in)  attr_name,
integer(i4), dimension(:,:), intent(out), pointer  output,
integer(i4), dimension(2), intent(out), optional  output_shape,
integer(i4), intent(out), optional  iostat 
)

Parse XML attribute content into a 2D array of integer values.

Parameters
[in]nodeXML node
[in]attr_nameAttribute name
[out]outputOutput array
[out]output_shapeShape of the output array (ncols, nrows)
[out]iostatI/O status flag (0 on success)

◆ xml_extractdataattribute_logical()

subroutine xml_extractdataattribute_logical ( type(xml_node), intent(in)  node,
character(len=*), intent(in)  attr_name,
logical, intent(out)  output,
integer(i4), dimension(2), intent(out), optional  output_shape,
integer(i4), intent(out), optional  iostat 
)

Parse a single logical value from an XML attribute's content.

Parameters
[in]nodeXML node
[in]attr_nameAttribute name
[out]outputOutput value
[out]output_shapeShape of the output array (ncols, nrows)
[out]iostatI/O status flag (0 on success)

◆ xml_extractdataattribute_logical1d()

subroutine xml_extractdataattribute_logical1d ( type(xml_node), intent(in)  node,
character(len=*), intent(in)  attr_name,
logical, dimension(:), intent(out), pointer  output,
integer(i4), dimension(2), intent(out), optional  output_shape,
integer(i4), intent(out), optional  iostat 
)

Parse XML attribute content into a 1D array of logical values.

Parameters
[in]nodeXML node
[in]attr_nameAttribute name
[out]outputOutput array
[out]output_shapeShape of the output array (ncols, nrows)
[out]iostatI/O status flag (0 on success)

◆ xml_extractdataattribute_logical2d()

subroutine xml_extractdataattribute_logical2d ( type(xml_node), intent(in)  node,
character(len=*), intent(in)  attr_name,
logical, dimension(:,:), intent(out), pointer  output,
integer(i4), dimension(2), intent(out), optional  output_shape,
integer(i4), intent(out), optional  iostat 
)

Parse XML attribute content into a 2D array of logical values.

Parameters
[in]nodeXML node
[in]attr_nameAttribute name
[out]outputOutput array
[out]output_shapeShape of the output array (ncols, nrows)
[out]iostatI/O status flag (0 on success)

◆ xml_extractdataattribute_string()

subroutine xml_extractdataattribute_string ( type(xml_node), intent(in)  node,
character(len=*), intent(in)  attr_name,
character(len=:), intent(inout), allocatable  output,
integer(i4), intent(out), optional  iostat 
)

Get content from an XML attribute as a string.

Parameters
[in]nodeXML node
[in]attr_nameAttribute name
[in,out]outputOutput string
[out]iostatI/O status flag (0 on success)

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