CMS 3D CMS Logo

Public Member Functions | Private Attributes

RandomEngineState Class Reference

#include <SimDataFormats/RandomEngine/interface/RandomEngineState.h>

List of all members.

Public Member Functions

void clearSeedVector ()
void clearStateVector ()
const std::string & getLabel () const
const std::vector< uint32_t > & getSeed () const
const std::vector< uint32_t > & getState () const
bool operator< (RandomEngineState const &rhs)
void push_back_seedVector (uint32_t v)
void push_back_stateVector (uint32_t v)
 RandomEngineState ()
void reserveSeedVector (std::vector< uint32_t >::size_type n)
void reserveStateVector (std::vector< uint32_t >::size_type n)
void setLabel (const std::string &value)
void setSeed (const std::vector< uint32_t > &value)
void setState (const std::vector< uint32_t > &value)
 ~RandomEngineState ()

Private Attributes

std::string label_
std::vector< uint32_t > seed_
std::vector< uint32_t > state_

Detailed Description

Description: Holds the state of a CLHEP random number engine and the label of the module it is associated with.

Usage: This should only be used by the Random Number Generator service.

Definition at line 28 of file RandomEngineState.h.


Constructor & Destructor Documentation

RandomEngineState::RandomEngineState ( )

Definition at line 17 of file RandomEngineState.cc.

{
}
RandomEngineState::~RandomEngineState ( )

Definition at line 21 of file RandomEngineState.cc.

{
}

Member Function Documentation

void RandomEngineState::clearSeedVector ( ) [inline]

Definition at line 44 of file RandomEngineState.h.

References seed_.

{ seed_.clear(); }
void RandomEngineState::clearStateVector ( ) [inline]

Definition at line 48 of file RandomEngineState.h.

References state_.

{ state_.clear(); }
const std::string& RandomEngineState::getLabel ( ) const [inline]

Definition at line 36 of file RandomEngineState.h.

References label_.

{ return label_; }
const std::vector<uint32_t>& RandomEngineState::getSeed ( ) const [inline]

Definition at line 38 of file RandomEngineState.h.

References seed_.

{ return seed_; }
const std::vector<uint32_t>& RandomEngineState::getState ( ) const [inline]

Definition at line 37 of file RandomEngineState.h.

References state_.

{ return state_; }
bool RandomEngineState::operator< ( RandomEngineState const &  rhs) [inline]

Definition at line 52 of file RandomEngineState.h.

References label_.

{ return label_ < rhs.label_; }
void RandomEngineState::push_back_seedVector ( uint32_t  v) [inline]

Definition at line 46 of file RandomEngineState.h.

References seed_.

{ seed_.push_back(v); }
void RandomEngineState::push_back_stateVector ( uint32_t  v) [inline]

Definition at line 50 of file RandomEngineState.h.

References state_.

{ state_.push_back(v); }
void RandomEngineState::reserveSeedVector ( std::vector< uint32_t >::size_type  n) [inline]

Definition at line 45 of file RandomEngineState.h.

References seed_.

{ seed_.reserve(n); }
void RandomEngineState::reserveStateVector ( std::vector< uint32_t >::size_type  n) [inline]

Definition at line 49 of file RandomEngineState.h.

References state_.

{ state_.reserve(n); }
void RandomEngineState::setLabel ( const std::string &  value) [inline]
void RandomEngineState::setSeed ( const std::vector< uint32_t > &  value) [inline]

Definition at line 42 of file RandomEngineState.h.

References seed_, and relativeConstraints::value.

{ seed_ = value; }
void RandomEngineState::setState ( const std::vector< uint32_t > &  value) [inline]

Definition at line 41 of file RandomEngineState.h.

References state_, and relativeConstraints::value.

{ state_ = value; }

Member Data Documentation

std::string RandomEngineState::label_ [private]

Definition at line 56 of file RandomEngineState.h.

Referenced by getLabel(), operator<(), and setLabel().

std::vector<uint32_t> RandomEngineState::seed_ [private]
std::vector<uint32_t> RandomEngineState::state_ [private]