mirror of
https://git.gfz-potsdam.de/naaice/iphreeqc.git
synced 2025-12-16 00:28:23 +01:00
changed phrSetSelectedOutputStringOn
git-svn-id: svn://136.177.114.72/svn_GW/IPhreeqc/trunk@8636 1feff8c3-07ed-0310-ac33-dd36852eb9cd
This commit is contained in:
Scott R Charlton
parent
85ee774f20
commit
3313c79322
42
R/R.cpp
42
R/R.cpp
@ -203,14 +203,21 @@ setOutputStringOn(SEXP value)
|
||||
}
|
||||
|
||||
SEXP
|
||||
setSelectedOutputStringOn(SEXP value)
|
||||
setSelectedOutputStringOn(SEXP nuser, SEXP value)
|
||||
{
|
||||
SEXP ans = R_NilValue;
|
||||
// check args
|
||||
if (!isInteger(nuser) || length(nuser) != 1) {
|
||||
error("SetSelectedOutputStringOn:nuser must be a single integer\n");
|
||||
}
|
||||
if (!isLogical(value) || length(value) != 1) {
|
||||
error("SetSelectedOutputStringOn:value must either be \"TRUE\" or \"FALSE\"\n");
|
||||
}
|
||||
|
||||
int save = R::singleton().GetCurrentSelectedOutputUserNumber();
|
||||
R::singleton().SetCurrentSelectedOutputUserNumber(INTEGER(nuser)[0]);
|
||||
R::singleton().SetSelectedOutputStringOn(LOGICAL(value)[0]);
|
||||
R::singleton().SetCurrentSelectedOutputUserNumber(save);
|
||||
return(ans);
|
||||
}
|
||||
|
||||
@ -385,6 +392,39 @@ getSelectedOutputStrings(void)
|
||||
return ans;
|
||||
}
|
||||
|
||||
SEXP
|
||||
getSelectedOutputStringLst(void)
|
||||
{
|
||||
SEXP list;
|
||||
SEXP attr;
|
||||
|
||||
list = R_NilValue;
|
||||
|
||||
if (int n = R::singleton().GetSelectedOutputCount()) {
|
||||
SEXP so;
|
||||
char buffer[80];
|
||||
|
||||
PROTECT(list = allocVector(VECSXP, n));
|
||||
PROTECT(attr = allocVector(STRSXP, n));
|
||||
|
||||
int save = R::singleton().GetCurrentSelectedOutputUserNumber();
|
||||
for (int i = 0; i < n; ++i) {
|
||||
int d = R::singleton().GetNthSelectedOutputUserNumber(i);
|
||||
::sprintf(buffer, "n%d", d);
|
||||
SET_STRING_ELT(attr, i, mkChar(buffer));
|
||||
R::singleton().SetCurrentSelectedOutputUserNumber(d);
|
||||
PROTECT(so = getSelectedOutputStrings());
|
||||
SET_VECTOR_ELT(list, i, so);
|
||||
UNPROTECT(1);
|
||||
}
|
||||
R::singleton().SetCurrentSelectedOutputUserNumber(save);
|
||||
setAttrib(list, R_NamesSymbol, attr);
|
||||
|
||||
UNPROTECT(2);
|
||||
}
|
||||
return list;
|
||||
}
|
||||
|
||||
SEXP
|
||||
getWarningStrings(void)
|
||||
{
|
||||
|
||||
@ -661,38 +661,37 @@ function(value)
|
||||
|
||||
|
||||
|
||||
##' TODO
|
||||
##' Sets the selected output string on or off.
|
||||
##'
|
||||
##' %% ~~ A concise (1-5 lines) description of what the function does. ~~
|
||||
##' Sets the given selected output string switch on or off. This switch controls
|
||||
##' whether or not the data normally sent to the given selected output file are
|
||||
##' stored in a buffer for retrieval. The initial setting is off.
|
||||
##'
|
||||
##' %% ~~ If necessary, more details than the description above ~~
|
||||
##'
|
||||
##' @usage phrSetSelectedOutputStringOn(value)
|
||||
##' @param value %% ~~Describe \code{value} here~~
|
||||
##' @return %% ~Describe the value returned %% If it is a LIST, use %%
|
||||
##' \item{comp1 }{Description of 'comp1'} %% \item{comp2 }{Description of
|
||||
##' 'comp2'} %% ...
|
||||
##' @note %% ~~further notes~~
|
||||
##' @seealso %% ~~objects to See Also as \code{\link{help}}, ~~~
|
||||
##' @usage phrSetSelectedOutputStringOn(nuser, value)
|
||||
##' @param \code{nuser} The user number specified within the SELECTED_OUTPUT block.
|
||||
##' @param \code{value} If TRUE, captures the output defined by the SELECTED_OUTPUT
|
||||
##' keyword into a buffer.
|
||||
##' @return NULL
|
||||
##' @seealso \code{\link{phrGetSelectedOutputFileOn}},
|
||||
##' \code{\link{phrGetSelectedOutputStringOn}},
|
||||
##' \code{\link{phrGetSelectedOutputStrings}},
|
||||
##' \code{\link{phrGetSelectedOutputFileOn}}
|
||||
##' @references \url{http://wwwbrr.cr.usgs.gov/projects/GWC_coupled/phreeqc}
|
||||
##' @keywords interface
|
||||
##' @useDynLib phreeqc
|
||||
##' @export
|
||||
##' @examples
|
||||
##'
|
||||
##' ##---- Should be DIRECTLY executable !! ----
|
||||
##' ##-- ==> Define data, use random,
|
||||
##' ##-- or do help(data=index) for the standard data sets.
|
||||
##'
|
||||
##' ## The function is currently defined as
|
||||
##' function (value)
|
||||
##' {
|
||||
##' }
|
||||
##'
|
||||
##' phrLoadDatabaseString(phreeqc.dat)
|
||||
##' phrSetSelectedOutputStringOn(1, TRUE)
|
||||
##' if (is.null(phrRunString(ex2))) {
|
||||
##' cat(phrGetSelectedOutputStrings()$n1)
|
||||
##' }
|
||||
##'
|
||||
phrSetSelectedOutputStringOn =
|
||||
function(value)
|
||||
function(nuser, value)
|
||||
{
|
||||
invisible(.Call("setSelectedOutputStringOn", as.logical(value), PACKAGE=.packageName))
|
||||
invisible(.Call("setSelectedOutputStringOn", as.integer(nuser), as.logical(value), PACKAGE=.packageName))
|
||||
}
|
||||
|
||||
|
||||
@ -1143,11 +1142,11 @@ function()
|
||||
|
||||
|
||||
|
||||
##' Retrieves the string buffer containing phreeqc output.
|
||||
##' Retrieve standard phreeqc output.
|
||||
##'
|
||||
##' %% ~~ A concise (1-5 lines) description of what the function does. ~~
|
||||
##' Retrieves the phreeqc output as a character vector.
|
||||
##'
|
||||
##' %% ~~ If necessary, more details than the description above ~~
|
||||
##' A NULL value is returned when there is no selected-output.
|
||||
##'
|
||||
##' @usage phrGetOutputStrings()
|
||||
##' @return %% ~Describe the value returned %% If it is a LIST, use %%
|
||||
@ -1178,37 +1177,42 @@ function()
|
||||
|
||||
|
||||
|
||||
##' TODO
|
||||
##' Retrieve the current SELECTED_OUTPUT.
|
||||
##'
|
||||
##' %% ~~ A concise (1-5 lines) description of what the function does. ~~
|
||||
##'
|
||||
##' %% ~~ If necessary, more details than the description above ~~
|
||||
##' Returns the current SELECTED_OUTPUT as a character vector.
|
||||
##'
|
||||
##' Returns a named list containing the resultant selected output as character
|
||||
##' vectors. The names of each vector are creating by concatenating the letter
|
||||
##' 'n' and the user number of the selected output block.
|
||||
##'
|
||||
##' @usage phrGetSelectedOutputStrings()
|
||||
##' @return %% ~Describe the value returned %% If it is a LIST, use %%
|
||||
##' \item{comp1 }{Description of 'comp1'} %% \item{comp2 }{Description of
|
||||
##' 'comp2'} %% ...
|
||||
##' @note %% ~~further notes~~
|
||||
##' @seealso %% ~~objects to See Also as \code{\link{help}}, ~~~
|
||||
##' @return A character vector containing the current SELECTED_OUTPUT or
|
||||
##' NULL.
|
||||
##' @note \code{\link{phrSetSelectedOutputStringOn}} must have been set
|
||||
##' to TRUE in order to receive SELECTED_OUTPUT.
|
||||
##' @seealso \code{\link{phrGetSelectedOutputFileOn}},
|
||||
##' \code{\link{phrGetSelectedOutputFileOn}},
|
||||
##' \code{\link{phrGetSelectedOutputStringOn}},
|
||||
##' \code{\link{phrSetSelectedOutputFileOn}},
|
||||
##' \code{\link{phrSetSelectedOutputStringOn}}
|
||||
##' @references \url{http://wwwbrr.cr.usgs.gov/projects/GWC_coupled/phreeqc}
|
||||
##' @keywords interface
|
||||
##' @useDynLib phreeqc
|
||||
##' @export
|
||||
##' @examples
|
||||
##'
|
||||
##' ##---- Should be DIRECTLY executable !! ----
|
||||
##' ##-- ==> Define data, use random,
|
||||
##' ##-- or do help(data=index) for the standard data sets.
|
||||
##' # This example runs ex2 and displays the selected-output string.
|
||||
##' phrLoadDatabaseString(phreeqc.dat)
|
||||
##' phrSetSelectedOutputStringOn(1, TRUE)
|
||||
##'
|
||||
##' ## The function is currently defined as
|
||||
##' function ()
|
||||
##' {
|
||||
##' }
|
||||
##' if (is.null(phrRunString(ex2))) {
|
||||
##' cat(phrGetSelectedOutputStrings()$n1, sep="\n")
|
||||
##' }
|
||||
##'
|
||||
phrGetSelectedOutputStrings =
|
||||
function()
|
||||
{
|
||||
return(.Call("getSelectedOutputStrings", PACKAGE=.packageName))
|
||||
return(.Call("getSelectedOutputStringLst", PACKAGE=.packageName))
|
||||
}
|
||||
|
||||
|
||||
@ -1219,7 +1223,7 @@ function()
|
||||
##' generated during the last invocation of the following methods:
|
||||
##' \code{\link{phrAccumulateLine}}, \code{\link{phrLoadDatabase}},
|
||||
##' \code{\link{phrLoadDatabaseString}}, \code{\link{phrRunAccumulatedeadString}},
|
||||
##' \code{\link{phrRunFile}}, \code{\link{phrRunString}}
|
||||
##' \code{\link{phrRunFile}}, \code{\link{phrRunString}}.
|
||||
##'
|
||||
##' A NULL value is returned if there are no warnings.
|
||||
##'
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user