Yosokumo::Panel Class Reference

Contains various data items associated with a study, e.g., creation time. More...

#include <Panel.h>

List of all members.

Public Member Functions

void setNameControlLocation (const std::string &nameControlLocation)
 Set the name control location.
std::string getNameControlLocation () const
 Return the name control location.
void setStatusControlLocation (const std::string &statusControlLocation)
 Set the status control location.
std::string getStatusControlLocation () const
 Return the status control location.
void setVisibilityControlLocation (const std::string &visibilityControlLocation)
 Set the visibility control location.
std::string getVisibilityControlLocation () const
 Return the visibility control location.
void setBlockCount (uint64_t blockCount)
 Set the block count.
uint64_t getBlockCount () const
 Return the block count.
void setCellCount (uint64_t cellCount)
 Set the cell count.
uint64_t getCellCount () const
 Return the cell count.
void setProspectCount (uint64_t prospectCount)
 Set the prospect count.
uint64_t getProspectCount () const
 Return the prospect count.
void setCreationTime (const std::string &creationTime)
 Set the creation time.
std::string getCreationTime () const
 Return the creation time.
void setLatestBlockTime (const std::string &latestBlockTime)
 Set the latest block time.
std::string getLatestBlockTime () const
 Return the latest block time.
void setLatestProspectTime (const std::string &latestProspectTime)
 Set the latest prospect time.
std::string getLatestProspectTime () const
 Return the latest prospect time.

Private Attributes

std::string nameControlLocation
std::string statusControlLocation
std::string visibilityControlLocation
uint64_t blockCount
uint64_t cellCount
uint64_t prospectCount
std::string creationTime
std::string latestBlockTime
std::string latestProspectTime

Detailed Description

Contains various data items associated with a study, e.g., creation time.

Author:
Roger House
Version:
0.9

Definition at line 18 of file Panel.h.

Member Function Documentation

uint64_t Panel::getBlockCount (  )  const

Return the block count.

Returns:
the number of posted blocks that have been accepted into the study table.

Definition at line 48 of file Panel.cpp.

References blockCount.

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

uint64_t Panel::getCellCount (  )  const

Return the cell count.

Returns:
the total number of cells contained in the blocks reported in the block count.

Definition at line 58 of file Panel.cpp.

References cellCount.

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

std::string Panel::getCreationTime (  )  const

Return the creation time.

Returns:
the UTC time the study was created.

Definition at line 78 of file Panel.cpp.

References creationTime.

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

std::string Panel::getLatestBlockTime (  )  const

Return the latest block time.

Returns:
the UTC time that the service accepted the most recent block into the study table.

Definition at line 88 of file Panel.cpp.

References latestBlockTime.

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

std::string Panel::getLatestProspectTime (  )  const

Return the latest prospect time.

Returns:
the UTC time of the most recent Post Model or Get Model request.

Definition at line 98 of file Panel.cpp.

References latestProspectTime.

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

std::string Panel::getNameControlLocation (  )  const

Return the name control location.

Returns:
the URI to use to change the name of the study.

Definition at line 15 of file Panel.cpp.

References nameControlLocation.

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

uint64_t Panel::getProspectCount (  )  const

Return the prospect count.

Returns:
the total number of specimens contained in all Post Model and Get Model requests for the study.

Definition at line 68 of file Panel.cpp.

References prospectCount.

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

std::string Panel::getStatusControlLocation (  )  const

Return the status control location.

Returns:
the URI to use to change the status of the study.

Definition at line 25 of file Panel.cpp.

References statusControlLocation.

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

std::string Panel::getVisibilityControlLocation (  )  const

Return the visibility control location.

Returns:
the URI to use to change the visibility of the study.

Definition at line 37 of file Panel.cpp.

References visibilityControlLocation.

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

void Panel::setBlockCount ( uint64_t  blockCount  ) 

Set the block count.

Parameters:
blockCount the number of posted blocks that have been accepted into the study table.

Definition at line 43 of file Panel.cpp.

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

void Panel::setCellCount ( uint64_t  cellCount  ) 

Set the cell count.

Parameters:
cellCount the total number of cells contained in the blocks reported in the block count.

Definition at line 53 of file Panel.cpp.

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

void Panel::setCreationTime ( const std::string &  creationTime  ) 

Set the creation time.

Parameters:
creationTime the UTC time the study was created.

Definition at line 73 of file Panel.cpp.

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

void Panel::setLatestBlockTime ( const std::string &  latestBlockTime  ) 

Set the latest block time.

Parameters:
latestBlockTime the UTC time that the service accepted the most recent block into the study table.

Definition at line 83 of file Panel.cpp.

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

void Panel::setLatestProspectTime ( const std::string &  latestProspectTime  ) 

Set the latest prospect time.

Parameters:
latestProspectTime the UTC time of the most recent Post Model or Get Model request.

Definition at line 93 of file Panel.cpp.

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

void Panel::setNameControlLocation ( const std::string &  nameControlLocation  ) 

Set the name control location.

Parameters:
nameControlLocation the URI to use to change the name of the study.

Definition at line 10 of file Panel.cpp.

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

void Panel::setProspectCount ( uint64_t  prospectCount  ) 

Set the prospect count.

Parameters:
prospectCount the total number of specimens contained in all Post Model and Get Model requests for the study.

Definition at line 63 of file Panel.cpp.

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

void Panel::setStatusControlLocation ( const std::string &  statusControlLocation  ) 

Set the status control location.

Parameters:
statusControlLocation the URI to use to change the status of the study.

Definition at line 20 of file Panel.cpp.

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

void Panel::setVisibilityControlLocation ( const std::string &  visibilityControlLocation  ) 

Set the visibility control location.

Parameters:
visibilityControlLocation the URI to use to change the visibility of the study.

Definition at line 31 of file Panel.cpp.

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

Member Data Documentation

uint64_t Yosokumo::Panel::blockCount [private]

Definition at line 24 of file Panel.h.

Referenced by getBlockCount().

uint64_t Yosokumo::Panel::cellCount [private]

Definition at line 25 of file Panel.h.

Referenced by getCellCount().

std::string Yosokumo::Panel::creationTime [private]

Definition at line 28 of file Panel.h.

Referenced by getCreationTime().

std::string Yosokumo::Panel::latestBlockTime [private]

Definition at line 29 of file Panel.h.

Referenced by getLatestBlockTime().

std::string Yosokumo::Panel::latestProspectTime [private]

Definition at line 30 of file Panel.h.

Referenced by getLatestProspectTime().

std::string Yosokumo::Panel::nameControlLocation [private]

Definition at line 20 of file Panel.h.

Referenced by getNameControlLocation().

uint64_t Yosokumo::Panel::prospectCount [private]

Definition at line 26 of file Panel.h.

Referenced by getProspectCount().

std::string Yosokumo::Panel::statusControlLocation [private]

Definition at line 21 of file Panel.h.

Referenced by getStatusControlLocation().

std::string Yosokumo::Panel::visibilityControlLocation [private]

Definition at line 22 of file Panel.h.

Referenced by getVisibilityControlLocation().

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