Yosokumo::YosokumoProtobuf Class Reference

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...

#include <YosokumoProtobuf.h>

Inheritance diagram for Yosokumo::YosokumoProtobuf:
Inheritance graph
[legend]
Collaboration diagram for Yosokumo::YosokumoProtobuf:
Collaboration graph
[legend]

List of all members.

Public Member Functions

std::string getContentType ()
 Return a content type string for use in Accept and Content-Type HTTP header lines.
bool makeCatalogFromBytes (const std::vector< uint8_t > &catalogAsBytes, Catalog &catalog)
 Make a Yosokumo Catalog object out of the bytes of an HTTP Entity.
bool makeBytesFromCatalog (const Catalog &catalog, std::vector< uint8_t > &catalogAsBytes)
 Make the bytes for an HTTP Entity out of a Yosokumo Catalog object.
bool makeStudyFromBytes (const std::vector< uint8_t > &studyAsBytes, Study &study)
 Make a Yosokumo Study object out of the bytes of an HTTP Entity.
bool makeBytesFromStudy (const Study &study, std::vector< uint8_t > &studyAsBytes)
 Make the bytes for an HTTP Entity out of a Yosokumo Study object.
bool makeStudyNameFromBytes (const std::vector< uint8_t > &studyNameAsBytes, std::string &name)
 Make a Yosokumo Study name out of the bytes of an HTTP Entity.
bool makeBytesFromStudyName (const std::string &name, std::vector< uint8_t > &studyNameAsBytes)
 Make the bytes for an HTTP Entity out of a Yosokumo Study name.
bool makeStudyStatusFromBytes (const std::vector< uint8_t > &studyStatusAsBytes, Study::Status &status)
 Make a Yosokumo Study status out of the bytes of an HTTP Entity.
bool makeBytesFromStudyStatus (const Study::Status status, std::vector< uint8_t > &studyStatusAsBytes)
 Make the bytes for an HTTP Entity out of a Yosokumo Study status.
bool makeStudyVisibilityFromBytes (const std::vector< uint8_t > &studyVisibilityAsBytes, Study::Visibility &visibility)
 Make a Yosokumo Study visibility out of the bytes of an HTTP Entity.
bool makeBytesFromStudyVisibility (const Study::Visibility visibility, std::vector< uint8_t > &studyVisibilityBytes)
 Make the bytes for an HTTP Entity out of a Yosokumo Study visibility.
bool makePanelFromBytes (const std::vector< uint8_t > &panelAsBytes, Panel &panel)
 Make a Yosokumo Panel object out of the bytes of an HTTP Entity.
bool makeBytesFromPanel (const Panel &panel, std::vector< uint8_t > &panelAsBytes)
 Make the bytes for an HTTP Entity out of a Yosokumo Panel object.
bool makeRoleFromBytes (const std::vector< uint8_t > &roleAsBytes, Role &role)
 Make a Yosokumo Role object out of the bytes of an HTTP Entity.
bool makeBytesFromRole (const Role &role, std::vector< uint8_t > &roleAsBytes)
 Make the bytes for an HTTP Entity out of a Yosokumo Role object.
bool makeRosterFromBytes (const std::vector< uint8_t > &rosterAsBytes, Roster &roster)
 Make a Yosokumo Roster object out of the bytes of an HTTP Entity.
bool makeBytesFromRoster (const Roster &roster, std::vector< uint8_t > &rosterAsBytes)
 Make the bytes for an HTTP Entity out of a Yosokumo Roster object.
bool makePredictorFromBytes (const std::vector< uint8_t > &predictorAsBytes, Predictor &predictor)
 Make a Yosokumo Predictor object out of the bytes of an HTTP Entity.
bool makeBytesFromPredictor (const Predictor &predictor, std::vector< uint8_t > &predictorAsBytes)
 Make the bytes for an HTTP Entity out of a Yosokumo Predictor object.
bool makeCellFromBytes (const std::vector< uint8_t > &cellAsBytes, Cell &cell)
 Make a Yosokumo Cell object out of the bytes of an HTTP Entity.
bool makeBytesFromCell (const Cell &cell, std::vector< uint8_t > &cellAsBytes)
 Make the bytes for an HTTP Entity out of a Yosokumo Cell object.
bool makeSpecimenFromBytes (const std::vector< uint8_t > &specimenAsBytes, Specimen &specimen)
 Make a Yosokumo Specimen object out of the bytes of an HTTP Entity.
bool makeBytesFromSpecimen (const Specimen &specimen, std::vector< uint8_t > &specimenAsBytes)
 Make the bytes for an HTTP Entity out of a Yosokumo Specimen object.
bool makeBlockFromBytes (const std::vector< uint8_t > &blockAsBytes, Block &block)
 Make a Yosokumo Block object out of the bytes of an HTTP Entity.
bool makeBytesFromBlock (const Block &block, std::vector< uint8_t > &blockAsBytes)
 Make the bytes for an HTTP Entity out of a Yosokumo Block object.
bool makeMessageFromBytes (const std::vector< uint8_t > &messageAsBytes, Message &message)
 Make a Yosokumo Message object out of the bytes of an HTTP Entity.
bool makeBytesFromMessage (const Message &message, std::vector< uint8_t > &messageAsBytes)
 Make the bytes for an HTTP Entity out of a Yosokumo Message object.

Private Member Functions

bool makeProtobufCatalogFromBytes (const std::vector< uint8_t > &catalogAsBytes, ProtoBuf::Catalog &protoCatalog)
bool makeCatalogFromProtobufCatalog (const ProtoBuf::Catalog &protoCatalog, Catalog &catalog)
bool makeProtobufCatalogFromCatalog (const Catalog &catalog, ProtoBuf::Catalog &protoCatalog)
bool makeBytesFromProtobufCatalog (const ProtoBuf::Catalog &protoCatalog, std::vector< uint8_t > &catalogAsBytes)
bool makeProtobufStudyFromBytes (const std::vector< uint8_t > &studyAsBytes, ProtoBuf::Study &protoStudy)
bool makeStudyFromProtobufStudy (const ProtoBuf::Study &protoStudy, Study &study)
bool makeProtobufStudyFromStudy (const Study &study, ProtoBuf::Study &protoStudy)
bool makeBytesFromProtobufStudy (const ProtoBuf::Study &protoStudy, std::vector< uint8_t > &studyAsBytes)
bool makeProtobufStudyNameControlFromBytes (const std::vector< uint8_t > &studyNameAsBytes, ProtoBuf::Panel_StudyNameControl &protoNameControl)
bool makeStudyNameFromProtobufStudyNameControl (const ProtoBuf::Panel_StudyNameControl &protoNameControl, std::string &name)
bool makeProtobufStudyNameControlFromName (const std::string &name, ProtoBuf::Panel_StudyNameControl &protoNameControl)
bool makeBytesFromProtobufStudyNameControl (const ProtoBuf::Panel_StudyNameControl &protoNameControl, std::vector< uint8_t > &studyNameAsBytes)
bool makeProtobufStudyStatusControlFromBytes (const std::vector< uint8_t > &studyStatusAsBytes, ProtoBuf::Panel_StatusControl &protoStatusControl)
bool makeStudyStatusFromProtobufStudyStatusControl (const ProtoBuf::Panel_StatusControl &protoStatusControl, Study::Status &status)
bool makeProtobufStudyStatusControlFromStatus (const Study::Status status, ProtoBuf::Panel_StatusControl &protoStatusControl)
bool makeBytesFromProtobufStudyStatusControl (const ProtoBuf::Panel_StatusControl &protoStatusControl, std::vector< uint8_t > &studyStatusAsBytes)
bool makeProtobufStudyVisibilityControlFromBytes (const std::vector< uint8_t > &studyVisibilityAsBytes, ProtoBuf::Panel_VisibilityControl &protoVisibilityControl)
bool makeStudyVisibilityFromProtobufStudyVisibilityControl (const ProtoBuf::Panel_VisibilityControl &protoVisibilityControl, Study::Visibility &visibility)
bool makeProtobufStudyVisibilityControlFromVisibility (const Study::Visibility visibility, ProtoBuf::Panel_VisibilityControl &protoVisibilityControl)
bool makeBytesFromProtobufStudyVisibilityControl (const ProtoBuf::Panel_VisibilityControl &protoVisibilityControl, std::vector< uint8_t > &studyVisibilityBytes)
bool makeProtobufPanelFromBytes (const std::vector< uint8_t > &panelAsBytes, ProtoBuf::Panel &protoPanel)
bool makePanelFromProtobufPanel (const ProtoBuf::Panel &protoPanel, Panel &panel)
bool makeProtobufPanelFromPanel (const Panel &panel, ProtoBuf::Panel &protoPanel)
bool makeBytesFromProtobufPanel (const ProtoBuf::Panel &protoPanel, std::vector< uint8_t > &panelAsBytes)
bool makeProtobufRoleFromBytes (const std::vector< uint8_t > &roleAsBytes, ProtoBuf::Role &protoRole)
bool makeRoleFromProtobufRole (const ProtoBuf::Role &protoRole, Role &role)
bool makeProtobufRoleFromRole (const Role &role, ProtoBuf::Role &protoRole)
bool makeBytesFromProtobufRole (const ProtoBuf::Role &protoRole, std::vector< uint8_t > &roleAsBytes)
bool makeProtobufRosterFromBytes (const std::vector< uint8_t > &rosterAsBytes, ProtoBuf::Roster &protoRoster)
bool makeRosterFromProtobufRoster (const ProtoBuf::Roster &protoRoster, Roster &roster)
bool makeProtobufRosterFromRoster (const Roster &roster, ProtoBuf::Roster &protoRoster)
bool makeBytesFromProtobufRoster (const ProtoBuf::Roster &protoRoster, std::vector< uint8_t > &rosterAsBytes)
bool makeProtobufPredictorFromBytes (const std::vector< uint8_t > &predictorAsBytes, ProtoBuf::Predictor &protoPredictor)
bool makePredictorFromProtobufPredictor (const ProtoBuf::Predictor &protoPredictor, Predictor &predictor)
bool makeProtobufPredictorFromPredictor (const Predictor &predictor, ProtoBuf::Predictor &protoPredictor)
bool makeBytesFromProtobufPredictor (const ProtoBuf::Predictor &protoPredictor, std::vector< uint8_t > &predictorAsBytes)
bool makeProtobufCellFromBytes (const std::vector< uint8_t > &cellAsBytes, ProtoBuf::Cell &protoCell)
bool makeCellFromProtobufCell (const ProtoBuf::Cell &protoCell, Cell &cell)
bool makeProtobufCellFromCell (const Cell &cell, ProtoBuf::Cell &protoCell)
bool makeBytesFromProtobufCell (const ProtoBuf::Cell &protoCell, std::vector< uint8_t > &cellAsBytes)
bool makeProtobufSpecimenFromBytes (const std::vector< uint8_t > &specimenAsBytes, ProtoBuf::Specimen &protoSpecimen)
bool makeSpecimenFromProtobufSpecimen (const ProtoBuf::Specimen &protoSpecimen, Specimen &specimen)
bool makeProtobufSpecimenFromSpecimen (const Specimen &specimen, ProtoBuf::Specimen &protoSpecimen)
bool makeBytesFromProtobufSpecimen (const ProtoBuf::Specimen &protoSpecimen, std::vector< uint8_t > &specimenAsBytes)
bool makeProtobufBlockFromBytes (const std::vector< uint8_t > &blockAsBytes, ProtoBuf::Block &protoBlock)
bool makeBlockFromProtobufBlock (const ProtoBuf::Block &protoBlock, Block &block)
bool makeProtobufBlockFromBlock (const Block &block, ProtoBuf::Block &protoBlock)
bool makeBytesFromProtobufBlock (const ProtoBuf::Block &protoBlock, std::vector< uint8_t > &blockAsBytes)
bool makeProtobufMessageFromBytes (const std::vector< uint8_t > &messageAsBytes, ProtoBuf::Message &protoMessage)
bool makeMessageFromProtobufMessage (const ProtoBuf::Message &protoMessage, Message &m)
bool makeProtobufMessageFromMessage (const Message &message, ProtoBuf::Message &protoMessage)
bool makeBytesFromProtobufMessage (const ProtoBuf::Message &protoMessage, std::vector< uint8_t > &messageAsBytes)
bool protoTypeToType (ProtoBuf::Study_Type protoType, Study::Type &type)
bool typeToProtobufType (Study::Type type, ProtoBuf::Study_Type &protoType)
bool protoStatusToStatus (ProtoBuf::Study_Status protoStatus, Study::Status &status)
bool statusToProtobufStatus (Study::Status status, ProtoBuf::Study_Status &protoStatus)
bool protoVisibilityToVisibility (ProtoBuf::Study_Visibility protoVisibility, Study::Visibility &visibility)
bool visibilityToProtobufVisibility (Study::Visibility visibility, ProtoBuf::Study_Visibility &protoVisibility)
bool protoTypeToType (ProtoBuf::Message_Type protoType, Message::Type &type)
bool typeToProtobufType (Message::Type type, ProtoBuf::Message_Type &protoType)
bool protoStatusToStatus (ProtoBuf::Predictor_Status protoStatus, Predictor::Status &status)
bool statusToProtobufStatus (Predictor::Status status, ProtoBuf::Predictor_Status &protoStatus)
bool protoTypeToType (ProtoBuf::Predictor_Type protoType, Predictor::Type &type)
bool typeToProtobufType (Predictor::Type type, ProtoBuf::Predictor_Type &protoType)
bool protoLevelToLevel (ProtoBuf::Predictor_Level protoLevel, Predictor::Level &level)
bool levelToProtobufLevel (Predictor::Level level, ProtoBuf::Predictor_Level &protoLevel)
bool protoStatusToStatus (ProtoBuf::Specimen_Status protoStatus, Specimen::Status &status)
bool statusToProtobufStatus (Specimen::Status status, ProtoBuf::Specimen_Status &protoStatus)

Detailed Description

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.

In general there are six functions for each Yosokumo class, illustrated here for Study:

Converting from HTTP entity bytes to Study:

   public  bool makeStudyFromBytes(
                    const std::vector<uint8_t> &studyAsBytes, 
                    Study &study)
   private bool makeProtobufStudyFromBytes(
                    const std::vector<uint8_t> &studyAsBytes,
                    ProtoBuf::Study &protoStudy);
   private bool makeStudyFromProtobufStudy(
                    const ProtoBuf::Study &protoStudy,
                    Study &study);
 

Converting from Study to HTTP entity bytes:

   public  bool makeBytesFromStudy(
                    const Study &study,
                    std::vector<uint8_t> &studyAsBytes)
   private bool makeProtobufStudyFromStudy(
                    const Study &study,
                    ProtoBuf::Study &protoStudy)
   private bool makeBytesFromProtobufStudy(
                    const ProtoBuf::Study &protoStudy,
                    std::vector<uint8_t> &studyAsBytes)
 

Note how Google Protocol Buffer objects are used as the intermediaries between HTTP entity bytes and Yosokumo objects. Here is another view of the transformations done by the functions shown above:

    makeStudyFromBytes:
      vector<uint8_t> -> makeProtobufStudyFromBytes -> ProtoBuf.Study
      ProtoBuf.Study  -> makeStudyFromProtobufStudy -> Study
    makeBytesFromStudy:
      Study          -> makeProtobufStudyFromStudy -> ProtoBuf.Study
      ProtoBuf.Study -> makeBytesFromProtobufStudy -> vector<uint8_t>
 

Definition at line 54 of file YosokumoProtobuf.h.


Member Function Documentation

std::string YosokumoProtobuf::getContentType (  )  [virtual]

Return a content type string for use in Accept and Content-Type HTTP header lines.

For example, "application/yosokumo+protobuf".

Returns:
a content type string for use in Accept and other HTTP headers.

Implements Yosokumo::YosokumoDIF.

Definition at line 20 of file YosokumoProtobuf.cpp.

bool YosokumoProtobuf::levelToProtobufLevel ( Predictor::Level  level,
ProtoBuf::Predictor_Level &  protoLevel 
) [private]
bool YosokumoProtobuf::makeBlockFromBytes ( const std::vector< uint8_t > &  blockAsBytes,
Block block 
) [virtual]

Make a Yosokumo Block object out of the bytes of an HTTP Entity.

Parameters:
blockAsBytes a block as bytes from an HTTP Entity.
block the output block created from the bytes.
Returns:
true means everything worked out fine. false means there was a problem; the output block may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 1350 of file YosokumoProtobuf.cpp.

References makeBlockFromProtobufBlock(), and makeProtobufBlockFromBytes().

bool YosokumoProtobuf::makeBlockFromProtobufBlock ( const ProtoBuf::Block &  protoBlock,
Block block 
) [private]
bool YosokumoProtobuf::makeBytesFromBlock ( const Block block,
std::vector< uint8_t > &  blockAsBytes 
) [virtual]

Make the bytes for an HTTP Entity out of a Yosokumo Block object.

Parameters:
block a Yosokumo Block object.
blockAsBytes the output bytes created from the block.
Returns:
true means everything worked out fine. false means there was a problem; the output bytes may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 1464 of file YosokumoProtobuf.cpp.

References makeBytesFromProtobufBlock(), and makeProtobufBlockFromBlock().

bool YosokumoProtobuf::makeBytesFromCatalog ( const Catalog catalog,
std::vector< uint8_t > &  catalogAsBytes 
) [virtual]

Make the bytes for an HTTP Entity out of a Yosokumo Catalog object.

Parameters:
catalog a Yosokumo Catalog object.
catalogAsBytes the output bytes created from the catalog.
Returns:
true means everything worked out fine. false means there was a problem; the output bytes may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 103 of file YosokumoProtobuf.cpp.

References makeBytesFromProtobufCatalog(), and makeProtobufCatalogFromCatalog().

bool YosokumoProtobuf::makeBytesFromCell ( const Cell cell,
std::vector< uint8_t > &  cellAsBytes 
) [virtual]

Make the bytes for an HTTP Entity out of a Yosokumo Cell object.

Parameters:
cell a Yosokumo Cell object.
cellAsBytes the output bytes created from the cell.
Returns:
true means everything worked out fine. false means there was a problem; the output bytes may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 1139 of file YosokumoProtobuf.cpp.

References makeBytesFromProtobufCell(), and makeProtobufCellFromCell().

bool YosokumoProtobuf::makeBytesFromMessage ( const Message message,
std::vector< uint8_t > &  messageAsBytes 
) [virtual]

Make the bytes for an HTTP Entity out of a Yosokumo Message object.

Parameters:
message a Yosokumo Message object.
messageAsBytes the output bytes created from the message.
Returns:
true means everything worked out fine. false means there was a problem; the output bytes may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 1612 of file YosokumoProtobuf.cpp.

References makeBytesFromProtobufMessage(), and makeProtobufMessageFromMessage().

bool YosokumoProtobuf::makeBytesFromPanel ( const Panel panel,
std::vector< uint8_t > &  panelAsBytes 
) [virtual]

Make the bytes for an HTTP Entity out of a Yosokumo Panel object.

Parameters:
panel a Yosokumo Panel object.
panelAsBytes the output bytes created from the panel.
Returns:
true means everything worked out fine. false means there was a problem; the output bytes may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 610 of file YosokumoProtobuf.cpp.

References makeBytesFromProtobufPanel(), and makeProtobufPanelFromPanel().

bool YosokumoProtobuf::makeBytesFromPredictor ( const Predictor predictor,
std::vector< uint8_t > &  predictorAsBytes 
) [virtual]

Make the bytes for an HTTP Entity out of a Yosokumo Predictor object.

Parameters:
predictor a Yosokumo Predictor object.
predictorAsBytes the output bytes created from the predictor.
Returns:
true means everything worked out fine. false means there was a problem; the output bytes may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 1004 of file YosokumoProtobuf.cpp.

References makeBytesFromProtobufPredictor(), and makeProtobufPredictorFromPredictor().

bool YosokumoProtobuf::makeBytesFromProtobufBlock ( const ProtoBuf::Block &  protoBlock,
std::vector< uint8_t > &  blockAsBytes 
) [private]

Definition at line 1527 of file YosokumoProtobuf.cpp.

Referenced by makeBytesFromBlock().

bool YosokumoProtobuf::makeBytesFromProtobufCatalog ( const ProtoBuf::Catalog &  protoCatalog,
std::vector< uint8_t > &  catalogAsBytes 
) [private]

Definition at line 139 of file YosokumoProtobuf.cpp.

Referenced by makeBytesFromCatalog().

bool YosokumoProtobuf::makeBytesFromProtobufCell ( const ProtoBuf::Cell &  protoCell,
std::vector< uint8_t > &  cellAsBytes 
) [private]

Definition at line 1177 of file YosokumoProtobuf.cpp.

Referenced by makeBytesFromCell().

bool YosokumoProtobuf::makeBytesFromProtobufMessage ( const ProtoBuf::Message &  protoMessage,
std::vector< uint8_t > &  messageAsBytes 
) [private]

Definition at line 1639 of file YosokumoProtobuf.cpp.

Referenced by makeBytesFromMessage().

bool YosokumoProtobuf::makeBytesFromProtobufPanel ( const ProtoBuf::Panel &  protoPanel,
std::vector< uint8_t > &  panelAsBytes 
) [private]

Definition at line 664 of file YosokumoProtobuf.cpp.

Referenced by makeBytesFromPanel().

bool YosokumoProtobuf::makeBytesFromProtobufPredictor ( const ProtoBuf::Predictor &  protoPredictor,
std::vector< uint8_t > &  predictorAsBytes 
) [private]

Definition at line 1041 of file YosokumoProtobuf.cpp.

Referenced by makeBytesFromPredictor().

bool YosokumoProtobuf::makeBytesFromProtobufRole ( const ProtoBuf::Role &  protoRole,
std::vector< uint8_t > &  roleAsBytes 
) [private]

Definition at line 800 of file YosokumoProtobuf.cpp.

Referenced by makeBytesFromRole().

bool YosokumoProtobuf::makeBytesFromProtobufRoster ( const ProtoBuf::Roster &  protoRoster,
std::vector< uint8_t > &  rosterAsBytes 
) [private]

Definition at line 923 of file YosokumoProtobuf.cpp.

Referenced by makeBytesFromRoster().

bool YosokumoProtobuf::makeBytesFromProtobufSpecimen ( const ProtoBuf::Specimen &  protoSpecimen,
std::vector< uint8_t > &  specimenAsBytes 
) [private]

Definition at line 1336 of file YosokumoProtobuf.cpp.

Referenced by makeBytesFromSpecimen().

bool YosokumoProtobuf::makeBytesFromProtobufStudy ( const ProtoBuf::Study &  protoStudy,
std::vector< uint8_t > &  studyAsBytes 
) [private]

Definition at line 268 of file YosokumoProtobuf.cpp.

Referenced by makeBytesFromStudy().

bool YosokumoProtobuf::makeBytesFromProtobufStudyNameControl ( const ProtoBuf::Panel_StudyNameControl &  protoNameControl,
std::vector< uint8_t > &  studyNameAsBytes 
) [private]

Definition at line 349 of file YosokumoProtobuf.cpp.

Referenced by makeBytesFromStudyName().

bool YosokumoProtobuf::makeBytesFromProtobufStudyStatusControl ( const ProtoBuf::Panel_StatusControl &  protoStatusControl,
std::vector< uint8_t > &  studyStatusAsBytes 
) [private]

Definition at line 436 of file YosokumoProtobuf.cpp.

Referenced by makeBytesFromStudyStatus().

bool YosokumoProtobuf::makeBytesFromProtobufStudyVisibilityControl ( const ProtoBuf::Panel_VisibilityControl &  protoVisibilityControl,
std::vector< uint8_t > &  studyVisibilityBytes 
) [private]

Definition at line 526 of file YosokumoProtobuf.cpp.

Referenced by makeBytesFromStudyVisibility().

bool YosokumoProtobuf::makeBytesFromRole ( const Role role,
std::vector< uint8_t > &  roleAsBytes 
) [virtual]

Make the bytes for an HTTP Entity out of a Yosokumo Role object.

Parameters:
role a Yosokumo Role object.
roleAsBytes the output bytes created from the role.
Returns:
true means everything worked out fine. false means there was a problem; the output bytes may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 752 of file YosokumoProtobuf.cpp.

References makeBytesFromProtobufRole(), and makeProtobufRoleFromRole().

bool YosokumoProtobuf::makeBytesFromRoster ( const Roster roster,
std::vector< uint8_t > &  rosterAsBytes 
) [virtual]

Make the bytes for an HTTP Entity out of a Yosokumo Roster object.

Parameters:
roster a Yosokumo Roster object.
rosterAsBytes the output bytes created from the roster.
Returns:
true means everything worked out fine. false means there was a problem; the output bytes may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 887 of file YosokumoProtobuf.cpp.

References makeBytesFromProtobufRoster(), and makeProtobufRosterFromRoster().

bool YosokumoProtobuf::makeBytesFromSpecimen ( const Specimen specimen,
std::vector< uint8_t > &  specimenAsBytes 
) [virtual]

Make the bytes for an HTTP Entity out of a Yosokumo Specimen object.

Parameters:
specimen a Yosokumo Specimen object.
specimenAsBytes the output bytes created from the specimen.
Returns:
true means everything worked out fine. false means there was a problem; the output bytes may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 1282 of file YosokumoProtobuf.cpp.

References makeBytesFromProtobufSpecimen(), and makeProtobufSpecimenFromSpecimen().

bool YosokumoProtobuf::makeBytesFromStudy ( const Study study,
std::vector< uint8_t > &  studyAsBytes 
) [virtual]

Make the bytes for an HTTP Entity out of a Yosokumo Study object.

Parameters:
study a Yosokumo Study object.
studyAsBytes the output bytes created from the study.
Returns:
true means everything worked out fine. false means there was a problem; the output bytes may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 230 of file YosokumoProtobuf.cpp.

References makeBytesFromProtobufStudy(), and makeProtobufStudyFromStudy().

bool YosokumoProtobuf::makeBytesFromStudyName ( const std::string &  name,
std::vector< uint8_t > &  studyNameAsBytes 
) [virtual]

Make the bytes for an HTTP Entity out of a Yosokumo Study name.

Parameters:
name a Yosokumo Study name.
studyNameAsBytes the output bytes created from the study name.
Returns:
true means everything worked out fine. false means there was a problem; the output bytes may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 329 of file YosokumoProtobuf.cpp.

References makeBytesFromProtobufStudyNameControl(), and makeProtobufStudyNameControlFromName().

bool YosokumoProtobuf::makeBytesFromStudyStatus ( const Study::Status  status,
std::vector< uint8_t > &  studyStatusAsBytes 
) [virtual]

Make the bytes for an HTTP Entity out of a Yosokumo Study status.

Parameters:
status a Yosokumo Study status.
studyStatusAsBytes the output bytes created from the study status.
Returns:
true means everything worked out fine. false means there was a problem; the output bytes may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 409 of file YosokumoProtobuf.cpp.

References makeBytesFromProtobufStudyStatusControl(), and makeProtobufStudyStatusControlFromStatus().

bool YosokumoProtobuf::makeBytesFromStudyVisibility ( const Study::Visibility  visibility,
std::vector< uint8_t > &  studyVisibilityAsBytes 
) [virtual]

Make the bytes for an HTTP Entity out of a Yosokumo Study visibility.

Parameters:
visibility a Yosokumo Study visibility.
studyVisibilityAsBytes the output bytes created from the study visibility.

Implements Yosokumo::YosokumoDIF.

Definition at line 498 of file YosokumoProtobuf.cpp.

References makeBytesFromProtobufStudyVisibilityControl(), and makeProtobufStudyVisibilityControlFromVisibility().

bool YosokumoProtobuf::makeCatalogFromBytes ( const std::vector< uint8_t > &  catalogAsBytes,
Catalog catalog 
) [virtual]

Make a Yosokumo Catalog object out of the bytes of an HTTP Entity.

Parameters:
catalogAsBytes a catalog as bytes from an HTTP Entity.
catalog the output catalog created from the bytes.
Returns:
true means everything worked out fine. false means there was a problem; the output catalog may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 27 of file YosokumoProtobuf.cpp.

References makeCatalogFromProtobufCatalog(), and makeProtobufCatalogFromBytes().

bool YosokumoProtobuf::makeCatalogFromProtobufCatalog ( const ProtoBuf::Catalog &  protoCatalog,
Catalog catalog 
) [private]
bool YosokumoProtobuf::makeCellFromBytes ( const std::vector< uint8_t > &  cellAsBytes,
Cell cell 
) [virtual]

Make a Yosokumo Cell object out of the bytes of an HTTP Entity.

Parameters:
cellAsBytes a cell as bytes from an HTTP Entity.
cell the output cell created from the bytes.
Returns:
true means everything worked out fine. false means there was a problem; the output cell may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 1054 of file YosokumoProtobuf.cpp.

References makeCellFromProtobufCell(), and makeProtobufCellFromBytes().

bool YosokumoProtobuf::makeCellFromProtobufCell ( const ProtoBuf::Cell &  protoCell,
Cell cell 
) [private]
bool YosokumoProtobuf::makeMessageFromBytes ( const std::vector< uint8_t > &  messageAsBytes,
Message message 
) [virtual]

Make a Yosokumo Message object out of the bytes of an HTTP Entity.

Parameters:
messageAsBytes a message as bytes from an HTTP Entity.
message the output message created from the bytes.

Implements Yosokumo::YosokumoDIF.

Definition at line 1542 of file YosokumoProtobuf.cpp.

References makeMessageFromProtobufMessage(), and makeProtobufMessageFromBytes().

bool YosokumoProtobuf::makeMessageFromProtobufMessage ( const ProtoBuf::Message &  protoMessage,
Message m 
) [private]
bool YosokumoProtobuf::makePanelFromBytes ( const std::vector< uint8_t > &  panelAsBytes,
Panel panel 
) [virtual]

Make a Yosokumo Panel object out of the bytes of an HTTP Entity.

Parameters:
panelAsBytes a panel as bytes from an HTTP Entity.
panel the output panel created from the bytes.
Returns:
true means everything worked out fine. false means there was a problem; the output panel may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 538 of file YosokumoProtobuf.cpp.

References makePanelFromProtobufPanel(), and makeProtobufPanelFromBytes().

bool YosokumoProtobuf::makePanelFromProtobufPanel ( const ProtoBuf::Panel &  protoPanel,
Panel panel 
) [private]
bool YosokumoProtobuf::makePredictorFromBytes ( const std::vector< uint8_t > &  predictorAsBytes,
Predictor predictor 
) [virtual]

Make a Yosokumo Predictor object out of the bytes of an HTTP Entity.

Parameters:
predictorAsBytes a predictor as bytes from an HTTP Entity.
predictor the output predictor created from the bytes.
Returns:
true means everything worked out fine. false means there was a problem; the output predictor may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 936 of file YosokumoProtobuf.cpp.

References makePredictorFromProtobufPredictor(), and makeProtobufPredictorFromBytes().

bool YosokumoProtobuf::makePredictorFromProtobufPredictor ( const ProtoBuf::Predictor &  protoPredictor,
Predictor predictor 
) [private]
bool YosokumoProtobuf::makeProtobufBlockFromBlock ( const Block block,
ProtoBuf::Block &  protoBlock 
) [private]
bool YosokumoProtobuf::makeProtobufBlockFromBytes ( const std::vector< uint8_t > &  blockAsBytes,
ProtoBuf::Block &  protoBlock 
) [private]

Definition at line 1363 of file YosokumoProtobuf.cpp.

References Yosokumo::YosokumoDIF::exception.

Referenced by makeBlockFromBytes().

bool YosokumoProtobuf::makeProtobufCatalogFromBytes ( const std::vector< uint8_t > &  catalogAsBytes,
ProtoBuf::Catalog &  protoCatalog 
) [private]

Definition at line 39 of file YosokumoProtobuf.cpp.

References Yosokumo::YosokumoDIF::exception.

Referenced by makeCatalogFromBytes().

bool YosokumoProtobuf::makeProtobufCatalogFromCatalog ( const Catalog catalog,
ProtoBuf::Catalog &  protoCatalog 
) [private]
bool YosokumoProtobuf::makeProtobufCellFromBytes ( const std::vector< uint8_t > &  cellAsBytes,
ProtoBuf::Cell &  protoCell 
) [private]

Definition at line 1067 of file YosokumoProtobuf.cpp.

References Yosokumo::YosokumoDIF::exception.

Referenced by makeCellFromBytes().

bool YosokumoProtobuf::makeProtobufCellFromCell ( const Cell cell,
ProtoBuf::Cell &  protoCell 
) [private]
bool YosokumoProtobuf::makeProtobufMessageFromBytes ( const std::vector< uint8_t > &  messageAsBytes,
ProtoBuf::Message &  protoMessage 
) [private]

Definition at line 1554 of file YosokumoProtobuf.cpp.

References Yosokumo::YosokumoDIF::exception.

Referenced by makeMessageFromBytes().

bool YosokumoProtobuf::makeProtobufMessageFromMessage ( const Message message,
ProtoBuf::Message &  protoMessage 
) [private]
bool YosokumoProtobuf::makeProtobufPanelFromBytes ( const std::vector< uint8_t > &  panelAsBytes,
ProtoBuf::Panel &  protoPanel 
) [private]

Definition at line 551 of file YosokumoProtobuf.cpp.

References Yosokumo::YosokumoDIF::exception.

Referenced by makePanelFromBytes().

bool YosokumoProtobuf::makeProtobufPanelFromPanel ( const Panel panel,
ProtoBuf::Panel &  protoPanel 
) [private]
bool YosokumoProtobuf::makeProtobufPredictorFromBytes ( const std::vector< uint8_t > &  predictorAsBytes,
ProtoBuf::Predictor &  protoPredictor 
) [private]

Definition at line 949 of file YosokumoProtobuf.cpp.

References Yosokumo::YosokumoDIF::exception.

Referenced by makePredictorFromBytes().

bool YosokumoProtobuf::makeProtobufPredictorFromPredictor ( const Predictor predictor,
ProtoBuf::Predictor &  protoPredictor 
) [private]
bool YosokumoProtobuf::makeProtobufRoleFromBytes ( const std::vector< uint8_t > &  roleAsBytes,
ProtoBuf::Role &  protoRole 
) [private]

Definition at line 691 of file YosokumoProtobuf.cpp.

References Yosokumo::YosokumoDIF::exception.

Referenced by makeRoleFromBytes().

bool YosokumoProtobuf::makeProtobufRoleFromRole ( const Role role,
ProtoBuf::Role &  protoRole 
) [private]
bool YosokumoProtobuf::makeProtobufRosterFromBytes ( const std::vector< uint8_t > &  rosterAsBytes,
ProtoBuf::Roster &  protoRoster 
) [private]

Definition at line 826 of file YosokumoProtobuf.cpp.

References Yosokumo::YosokumoDIF::exception.

Referenced by makeRosterFromBytes().

bool YosokumoProtobuf::makeProtobufRosterFromRoster ( const Roster roster,
ProtoBuf::Roster &  protoRoster 
) [private]
bool YosokumoProtobuf::makeProtobufSpecimenFromBytes ( const std::vector< uint8_t > &  specimenAsBytes,
ProtoBuf::Specimen &  protoSpecimen 
) [private]

Definition at line 1204 of file YosokumoProtobuf.cpp.

References Yosokumo::YosokumoDIF::exception.

Referenced by makeSpecimenFromBytes().

bool YosokumoProtobuf::makeProtobufSpecimenFromSpecimen ( const Specimen specimen,
ProtoBuf::Specimen &  protoSpecimen 
) [private]
bool YosokumoProtobuf::makeProtobufStudyFromBytes ( const std::vector< uint8_t > &  studyAsBytes,
ProtoBuf::Study &  protoStudy 
) [private]

Definition at line 166 of file YosokumoProtobuf.cpp.

References Yosokumo::YosokumoDIF::exception.

Referenced by makeStudyFromBytes().

bool YosokumoProtobuf::makeProtobufStudyFromStudy ( const Study study,
ProtoBuf::Study &  protoStudy 
) [private]
bool YosokumoProtobuf::makeProtobufStudyNameControlFromBytes ( const std::vector< uint8_t > &  studyNameAsBytes,
ProtoBuf::Panel_StudyNameControl &  protoNameControl 
) [private]

Definition at line 294 of file YosokumoProtobuf.cpp.

References Yosokumo::YosokumoDIF::exception.

Referenced by makeStudyNameFromBytes().

bool YosokumoProtobuf::makeProtobufStudyNameControlFromName ( const std::string &  name,
ProtoBuf::Panel_StudyNameControl &  protoNameControl 
) [private]

Definition at line 341 of file YosokumoProtobuf.cpp.

Referenced by makeBytesFromStudyName().

bool YosokumoProtobuf::makeProtobufStudyStatusControlFromBytes ( const std::vector< uint8_t > &  studyStatusAsBytes,
ProtoBuf::Panel_StatusControl &  protoStatusControl 
) [private]

Definition at line 374 of file YosokumoProtobuf.cpp.

References Yosokumo::YosokumoDIF::exception.

Referenced by makeStudyStatusFromBytes().

bool YosokumoProtobuf::makeProtobufStudyStatusControlFromStatus ( const Study::Status  status,
ProtoBuf::Panel_StatusControl &  protoStatusControl 
) [private]

Definition at line 422 of file YosokumoProtobuf.cpp.

References statusToProtobufStatus().

Referenced by makeBytesFromStudyStatus().

bool YosokumoProtobuf::makeProtobufStudyVisibilityControlFromBytes ( const std::vector< uint8_t > &  studyVisibilityAsBytes,
ProtoBuf::Panel_VisibilityControl &  protoVisibilityControl 
) [private]

Definition at line 461 of file YosokumoProtobuf.cpp.

References Yosokumo::YosokumoDIF::exception.

Referenced by makeStudyVisibilityFromBytes().

bool YosokumoProtobuf::makeProtobufStudyVisibilityControlFromVisibility ( const Study::Visibility  visibility,
ProtoBuf::Panel_VisibilityControl &  protoVisibilityControl 
) [private]

Definition at line 512 of file YosokumoProtobuf.cpp.

References visibilityToProtobufVisibility().

Referenced by makeBytesFromStudyVisibility().

bool YosokumoProtobuf::makeRoleFromBytes ( const std::vector< uint8_t > &  roleAsBytes,
Role role 
) [virtual]

Make a Yosokumo Role object out of the bytes of an HTTP Entity.

Parameters:
roleAsBytes a role as bytes from an HTTP Entity.
role the output role created from the bytes.
Returns:
true means everything worked out fine. false means there was a problem; the output role may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 678 of file YosokumoProtobuf.cpp.

References makeProtobufRoleFromBytes(), and makeRoleFromProtobufRole().

bool YosokumoProtobuf::makeRoleFromProtobufRole ( const ProtoBuf::Role &  protoRole,
Role role 
) [private]
bool YosokumoProtobuf::makeRosterFromBytes ( const std::vector< uint8_t > &  rosterAsBytes,
Roster roster 
) [virtual]

Make a Yosokumo Roster object out of the bytes of an HTTP Entity.

Parameters:
rosterAsBytes a roster as bytes from an HTTP Entity.
roster the output roster created from the bytes.
Returns:
true means everything worked out fine. false means there was a problem; the output roster may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 813 of file YosokumoProtobuf.cpp.

References makeProtobufRosterFromBytes(), and makeRosterFromProtobufRoster().

bool YosokumoProtobuf::makeRosterFromProtobufRoster ( const ProtoBuf::Roster &  protoRoster,
Roster roster 
) [private]
bool YosokumoProtobuf::makeSpecimenFromBytes ( const std::vector< uint8_t > &  specimenAsBytes,
Specimen specimen 
) [virtual]

Make a Yosokumo Specimen object out of the bytes of an HTTP Entity.

Parameters:
specimenAsBytes a specimen as bytes from an HTTP Entity.
specimen the output specimen created from the bytes.
Returns:
true means everything worked out fine. false means there was a problem; the output specimen may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 1191 of file YosokumoProtobuf.cpp.

References makeProtobufSpecimenFromBytes(), and makeSpecimenFromProtobufSpecimen().

bool YosokumoProtobuf::makeSpecimenFromProtobufSpecimen ( const ProtoBuf::Specimen &  protoSpecimen,
Specimen specimen 
) [private]
bool YosokumoProtobuf::makeStudyFromBytes ( const std::vector< uint8_t > &  studyAsBytes,
Study study 
) [virtual]

Make a Yosokumo Study object out of the bytes of an HTTP Entity.

Parameters:
studyAsBytes a study as bytes from an HTTP Entity.
study the output study created from the bytes.
Returns:
true means everything worked out fine. false means there was a problem; the output study may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 153 of file YosokumoProtobuf.cpp.

References makeProtobufStudyFromBytes(), and makeStudyFromProtobufStudy().

bool YosokumoProtobuf::makeStudyFromProtobufStudy ( const ProtoBuf::Study &  protoStudy,
Study study 
) [private]
bool YosokumoProtobuf::makeStudyNameFromBytes ( const std::vector< uint8_t > &  studyNameAsBytes,
std::string &  name 
) [virtual]

Make a Yosokumo Study name out of the bytes of an HTTP Entity.

Parameters:
studyNameAsBytes a study name as bytes from an HTTP Entity.
name the output study name created from the bytes.
Returns:
true means everything worked out fine. false means there was a problem; the output study name may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 281 of file YosokumoProtobuf.cpp.

References makeProtobufStudyNameControlFromBytes(), and makeStudyNameFromProtobufStudyNameControl().

bool YosokumoProtobuf::makeStudyNameFromProtobufStudyNameControl ( const ProtoBuf::Panel_StudyNameControl &  protoNameControl,
std::string &  name 
) [private]

Definition at line 319 of file YosokumoProtobuf.cpp.

Referenced by makeStudyNameFromBytes().

bool YosokumoProtobuf::makeStudyStatusFromBytes ( const std::vector< uint8_t > &  studyStatusAsBytes,
Study::Status status 
) [virtual]

Make a Yosokumo Study status out of the bytes of an HTTP Entity.

Parameters:
studyStatusAsBytes a study status as bytes from an HTTP Entity.
status the output study status created from the bytes.
Returns:
true means everything worked out fine. false means there was a problem; the output study status may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 360 of file YosokumoProtobuf.cpp.

References makeProtobufStudyStatusControlFromBytes(), and makeStudyStatusFromProtobufStudyStatusControl().

bool YosokumoProtobuf::makeStudyStatusFromProtobufStudyStatusControl ( const ProtoBuf::Panel_StatusControl &  protoStatusControl,
Study::Status status 
) [private]

Definition at line 399 of file YosokumoProtobuf.cpp.

References protoStatusToStatus().

Referenced by makeStudyStatusFromBytes().

bool YosokumoProtobuf::makeStudyVisibilityFromBytes ( const std::vector< uint8_t > &  studyVisibilityAsBytes,
Study::Visibility visibility 
) [virtual]

Make a Yosokumo Study visibility out of the bytes of an HTTP Entity.

Parameters:
studyVisibilityAsBytes a study visibility as bytes from an HTTP Entity.
visibility the output study visibility created from the bytes.
Returns:
true means everything worked out fine. false means there was a problem; the output study visibility may be incomplete. Call getException() for details.

Implements Yosokumo::YosokumoDIF.

Definition at line 447 of file YosokumoProtobuf.cpp.

References makeProtobufStudyVisibilityControlFromBytes(), and makeStudyVisibilityFromProtobufStudyVisibilityControl().

bool YosokumoProtobuf::makeStudyVisibilityFromProtobufStudyVisibilityControl ( const ProtoBuf::Panel_VisibilityControl &  protoVisibilityControl,
Study::Visibility visibility 
) [private]

Definition at line 487 of file YosokumoProtobuf.cpp.

References protoVisibilityToVisibility().

Referenced by makeStudyVisibilityFromBytes().

bool YosokumoProtobuf::protoLevelToLevel ( ProtoBuf::Predictor_Level  protoLevel,
Predictor::Level level 
) [private]
bool YosokumoProtobuf::protoStatusToStatus ( ProtoBuf::Specimen_Status  protoStatus,
Specimen::Status status 
) [private]
bool YosokumoProtobuf::protoStatusToStatus ( ProtoBuf::Predictor_Status  protoStatus,
Predictor::Status status 
) [private]
bool YosokumoProtobuf::protoStatusToStatus ( ProtoBuf::Study_Status  protoStatus,
Study::Status status 
) [private]
bool YosokumoProtobuf::protoTypeToType ( ProtoBuf::Predictor_Type  protoType,
Predictor::Type type 
) [private]
bool YosokumoProtobuf::protoTypeToType ( ProtoBuf::Message_Type  protoType,
Message::Type type 
) [private]
bool YosokumoProtobuf::protoTypeToType ( ProtoBuf::Study_Type  protoType,
Study::Type type 
) [private]
bool YosokumoProtobuf::protoVisibilityToVisibility ( ProtoBuf::Study_Visibility  protoVisibility,
Study::Visibility visibility 
) [private]
bool YosokumoProtobuf::statusToProtobufStatus ( Specimen::Status  status,
ProtoBuf::Specimen_Status &  protoStatus 
) [private]
bool YosokumoProtobuf::statusToProtobufStatus ( Predictor::Status  status,
ProtoBuf::Predictor_Status &  protoStatus 
) [private]
bool YosokumoProtobuf::statusToProtobufStatus ( Study::Status  status,
ProtoBuf::Study_Status &  protoStatus 
) [private]
bool YosokumoProtobuf::typeToProtobufType ( Predictor::Type  type,
ProtoBuf::Predictor_Type &  protoType 
) [private]
bool YosokumoProtobuf::typeToProtobufType ( Message::Type  type,
ProtoBuf::Message_Type &  protoType 
) [private]
bool YosokumoProtobuf::typeToProtobufType ( Study::Type  type,
ProtoBuf::Study_Type &  protoType 
) [private]
bool YosokumoProtobuf::visibilityToProtobufVisibility ( Study::Visibility  visibility,
ProtoBuf::Study_Visibility &  protoVisibility 
) [private]

The documentation for this class was generated from the following files:
Generated on Mon May 13 09:19:12 2013 for C++ Yosokumo API by  doxygen 1.6.3