Yosokumo Namespace Reference

Classes

class  Base64
 Provides methods for converting bytes sequences to Base64 character strings and vice versa. More...
class  Block
 A base class for EmptyBlock, CellBlock, PredictorBlock, and SpecimenBlock. More...
class  Catalog
 An index to all the studies on which a given user has a role. More...
class  Cell
 Represents a Value with an associated key or name. More...
class  CellBlock
 Represents a block of Cells. More...
class  Credentials
 Specifies credentials (user id and key) for Yosokumo authentication. More...
class  DigestRequest
 Provides a method to digest (using HMAC) and encode (using Base64) an input message. More...
class  EmptyBlock
 Represents an empty block, i.e., a block containing no Predictors and no Specimens. More...
class  EmptyValue
 Represents no value or an unknown value. More...
class  IntegerValue
 Represents a signed integer value. More...
class  Message
 A text message with a type indicating if the message is information or an error. More...
class  NaturalValue
 Represents an unsigned integer value. More...
class  Panel
 Contains various data items associated with a study, e.g., creation time. More...
class  Predictor
 A column of values, an independent variable. More...
class  PredictorBlock
 Represents a block of Predictors. More...
class  Privilege
class  RealValue
 Represents a floating-point value. More...
class  Role
 A set of privileges granted to a particular user for a particular study. More...
class  Roster
 For each study, a list of users that have a role on the study. More...
class  ServiceException
 Encapsulates all exceptions which can be thrown by the Yosokumo Service. More...
class  SpecialValue
 Represents an unsigned integer value. More...
class  Specimen
 A row of values. More...
class  SpecimenBlock
 A block of Specimen*. More...
class  Study
 A container for all resources associated with an analytic project. More...
class  Value
 A base class for value classes which store specific primitive data types, e.g., IntegerValue and RealValue. More...
class  YosokumoDIF
 Defines methods which transform bytes obtained from HTTP requests into Yosokumo C++ objects (such as Catalog and Study) and vice versa. More...
class  YosokumoProtobuf
 Implements all functionality for transforming HTTP entity bytes in Google Protocol Buffer form into Yosokumo C++ objects (e.g., Catalog and Study) and vice versa. More...
class  YosokumoRequest
 Implements all HTTP requests to the Yosokumo web service. More...

Functions

std::ostream & operator<< (std::ostream &os, Predictor &p)
 Output stream insertion operator.
std::stringstream & operator<< (std::stringstream &s, Predictor &p)
 String stream insertion operator.
static std::string & ltrim (std::string &s)
 String utility functions.
static std::string & rtrim (std::string &s)
 Trim right end of a string.
static std::string & trim (std::string &s)
 Trim both ends of a string.
static bool endsWith (const std::string &fullString, const std::string &ending)
 Test if a string ends with another string.
static bool startsWith (const std::string &fullString, const std::string &start)
 Test if a string starts with another string.

Function Documentation

static bool Yosokumo::endsWith ( const std::string &  fullString,
const std::string &  ending 
) [inline, static]

Test if a string ends with another string.

Parameters:
fullString the string whose ending is to be tested.
ending the string to compare against the end of fullString.
Returns:
true means that fullString ends with the ending string. false means that fullString doesn't end with the ending string.

Definition at line 78 of file StringUtil.h.

static std::string& Yosokumo::ltrim ( std::string &  s  )  [inline, static]

String utility functions.

ltrim, rtrim, and trim come from http://stackoverflow.com/questions/216823/whats-the-best-way-to-trim-stdstring

endswith comes from http://stackoverflow.com/questions/874134/find-if-string-endswith-another-string-in-c

startswith comes from http://stackoverflow.com/questions/8095088/how-to-check-string-start-in-c Trim left end of a string.

Parameters:
s the string to trim.
Returns:
the input string with all leading whitespace removed from the left end.

Definition at line 33 of file StringUtil.h.

Referenced by trim().

std::stringstream & Yosokumo::operator<< ( std::stringstream &  s,
Predictor p 
)

String stream insertion operator.

Parameters:
s the string stream.
p the Predictor to insert in the stream.
Returns:
the string stream.

Definition at line 148 of file Predictor.cpp.

References Yosokumo::Predictor::toString().

std::ostream & Yosokumo::operator<< ( std::ostream &  os,
Predictor p 
)

Output stream insertion operator.

Parameters:
os the output stream.
p the Predictor to insert in the stream.
Returns:
the output stream.

Definition at line 142 of file Predictor.cpp.

References Yosokumo::Predictor::toString().

static std::string& Yosokumo::rtrim ( std::string &  s  )  [inline, static]

Trim right end of a string.

Parameters:
s the string to trim.
Returns:
the input string with all trailing whitespace removed from the right end.

Definition at line 48 of file StringUtil.h.

Referenced by trim().

static bool Yosokumo::startsWith ( const std::string &  fullString,
const std::string &  start 
) [inline, static]

Test if a string starts with another string.

Parameters:
fullString the string whose start is to be tested.
start the string to compare against the start of fullString.
Returns:
true means that fullString starts with the ending string. false means that fullString doesn't start with the ending string.

Definition at line 98 of file StringUtil.h.

Referenced by Yosokumo::YosokumoRequest::normalizeResourceUri().

static std::string& Yosokumo::trim ( std::string &  s  )  [inline, static]

Trim both ends of a string.

Parameters:
s the string to trim.
Returns:
the input string with all leading whitespace removed from the left end, and all trailing whitespace removed from the right end.

Definition at line 64 of file StringUtil.h.

References ltrim(), and rtrim().

Referenced by Yosokumo::YosokumoProtobuf::makeMessageFromProtobufMessage().

Generated on Mon May 13 09:19:11 2013 for C++ Yosokumo API by  doxygen 1.6.3