Yosokumo::EmptyBlock Class Reference

Represents an empty block, i.e., a block containing no Predictors and no Specimens. More...

#include <EmptyBlock.h>

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

List of all members.

Public Member Functions

 EmptyBlock ()
 Initializes a newly created EmptyBlock object with default attributes.
 EmptyBlock (std::string id)
 Initializes a newly created EmptyBlock object with a study identifier.
virtual ~EmptyBlock ()
 Destructor - destroy an EmptyBlock object.
virtual Type getType () const
 Return the empty block type.
virtual std::string toString ()
 Return the empty block as a string.

Private Member Functions

 EmptyBlock (const EmptyBlock &rhs)
 Copy constructor - NOT IMPLEMENTED.
EmptyBlockoperator= (const EmptyBlock &rhs)
 Assignment operator - NOT IMPLEMENTED.

Detailed Description

Represents an empty block, i.e., a block containing no Predictors and no Specimens.

An empty block can be used to test whether the requesting user has permission to post to the table or whether the study is 'running' and therefore accepting blocks into the table.

Definition at line 19 of file EmptyBlock.h.


Constructor & Destructor Documentation

EmptyBlock::EmptyBlock (  ) 

Initializes a newly created EmptyBlock object with default attributes.

Definition at line 7 of file EmptyBlock.cpp.

EmptyBlock::EmptyBlock ( std::string  id  ) 

Initializes a newly created EmptyBlock object with a study identifier.

Parameters:
id a study identifier for the block.

Definition at line 10 of file EmptyBlock.cpp.

EmptyBlock::~EmptyBlock (  )  [virtual]

Destructor - destroy an EmptyBlock object.

Definition at line 13 of file EmptyBlock.cpp.

Yosokumo::EmptyBlock::EmptyBlock ( const EmptyBlock rhs  )  [private]

Copy constructor - NOT IMPLEMENTED.


Member Function Documentation

Block::Type EmptyBlock::getType (  )  const [virtual]

Return the empty block type.

Returns:
the empty block type: Type.EMPTY.

Reimplemented from Yosokumo::Block.

Definition at line 16 of file EmptyBlock.cpp.

References Yosokumo::Block::EMPTY.

EmptyBlock& Yosokumo::EmptyBlock::operator= ( const EmptyBlock rhs  )  [private]

Assignment operator - NOT IMPLEMENTED.

std::string EmptyBlock::toString (  )  [virtual]

Return the empty block as a string.

Returns:
the empty block as a string.

Reimplemented from Yosokumo::Block.

Definition at line 21 of file EmptyBlock.cpp.


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