D.5.5 Get_Locus_Assembled_Vector Procedure

The main documentation of the Get_Locus_Assembled_Vector Procedure contains additional explanation of this code listing.

  function Get_Locus_Assembled_Vector (AV) result(Locus_AV)

    ! Input variable.

    type(Assembled_Vector_type), intent(in) :: AV   ! Variable to be queried.

    ! Output variable.

    type(character,name_length) :: Locus_AV         ! Locus of AV.

    !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    ! Verify requirements.

    VERIFY(Valid_State(AV),5)      ! AV is valid.

    ! Set the value.

    Locus_AV = Locus(AV%Structure)

    ! Verify guarantees - none.

    return
  end function Get_Locus_Assembled_Vector