BitString Class Reference

#include <ocsBitString.hh>

List of all members.

Public Member Functions
	BitString (ifstream *InFile, RanNumGen *RNG2)
	BitString (BitString &oBitString)
	BitString (BitString &BitString1, BitString &BitString2, RanNumGen *RNG3)
BitString &	operator= (BitString &RHS_BitString)
	~BitString ()
void	DeleteMemory (void)
void	ReallocateMemory (void)
string	WriteTypeBitString (void)
int	GetStringLength (void)
int	GetNumChannels (void)
void	SetNumChannels (int value)
int	GetChannelPhysicalIndex (int ChannelArrayIndex)
int	GetChannelArrayIndex (int ChannelPhysicalIndex)
void	SetBit (int ChannelArrayIndex, int BitSlot, int BitValue)
int	GetBit (int ChannelArrayIndex, int BitSlot)
void	WriteBitString (void)
string	WriteBitString (int ChannelArrayIndex)
void	GetRandomString ()
void	SetAllZeros (int ChannelArrayIndex)
void	SetAllOnes (int ChannelArrayIndex)
void	SetSingleOne (int ChannelArrayIndex)
void	SetStringToSingleMarkPerChannel (void)
void	ReduceToSingleChannelBitString (int ChannelArrayIndex)
void	ReduceToSingleChannelBitString (BitString *SCBitString)
void	AddBitStringBM (BitString &BitString2)
string	ReadString (string ParameterName, ifstream *InFile)
void	SetRandomString (int ChannelArrayIndex)
void	SetPseudoRandomString (int ChannelArrayIndex)
void	SetUserDefined (ifstream *InFile)
void	AllocateBitStringArray (int NumChannels2)
void	ReleaseBitStringArray (void)
Private Attributes
typeBitString	TypeBitString
int	NumChannels
int	StringLength
int *	BitStringArray
RanNumGen *	RNG
int	DebugLevel
Friends
void	AddBitStrings (BitString *BitString1, BitString *BitString2, BitString *BitString3)

---

Constructor & Destructor Documentation

BitString::BitString	(	ifstream *	InFile,
		RanNumGen *	RNG2
	)

References ALL_ONES, ALL_ZEROS, BitStringArray, DebugLevel, GetRandomString(), LogFile, LOWER_AND_UPPER, LOWER_ONLY, NumChannels, PSEUDO_RANDOM, RANDOM_EQUAL_ZEROS_ONES, RANDOM_SIMPLE, ReadInt(), RNG, SetAllOnes(), SetAllZeros(), SetSingleOne(), SetUserDefined(), SINGLE_ONE, StringLength, TypeBitString, USER_DEFINED, WriteBitString(), and WriteTypeBitString().

BitString::BitString

(

BitString &

oBitString

)

References BitStringArray, DebugLevel, GetBit(), NumChannels, RNG, SetBit(), StringLength, and TypeBitString.

BitString::BitString	(	BitString &	BitString1,
		BitString &	BitString2,
		RanNumGen *	RNG3
	)

References BitStringArray, DebugLevel, GetBit(), GetStringLength(), NumChannels, RNG, SetBit(), StringLength, TypeBitString, and WriteBitString().

BitString::~BitString

(

)

References BitStringArray.

Referenced by OptSignal::~OptSignal().

---

Member Function Documentation

void BitString::AddBitStringBM

(

BitString &

BitString2

)

USE THE FOLLOWING WITH CAUTION. It was written for a specific application by Brian Marks

The following was written for a specific application by Brian Marks. USE WITH EXTREME CAUTION!

References AllocateBitStringArray(), DebugLevel, GetBit(), GetStringLength(), NumChannels, SetBit(), StringLength, and WriteBitString().

Referenced by OptSignal::AddSignalBM().

void BitString::AllocateBitStringArray

(

int

NumChannels2

)

References BitStringArray, NumChannels, and StringLength.

Referenced by AddBitStringBM(), and OptSignal::SetNumChannels().

void BitString::DeleteMemory

(

void

)

int BitString::GetBit	(	int	ChannelArrayIndex,
		int	BitSlot
	)

References BitStringArray, and StringLength.

Referenced by AddBitStringBM(), AddBitStrings(), BitString(), OptSignal::ComputeAverageChirpOfMarks(), ElecSignalStat::ComputeAveragePDFs(), GaussianReceiver::ComputeAveragePDFs(), ChiSquareReceiver::ComputeAveragePDFs(), OptSignal::ComputeAverageSigmaMarks(), ChiSquareReceiver::ComputeGaussianPDFsAndBER(), PulseEvolutionAnalyzer::ComputePulseEnergyStats(), OptSignal::EOM_GeneratePerfectRectBinaryElecData(), OptSignal::EOM_GenerateRaisedCosineBinaryElecData(), OptSignal::EOM_GenerateSmoothedRectBinaryElecDataArctanh(), OptSignal::EOM_GenerateSmoothedRectBinaryElecDataSuperGauss(), MachZehnder::GeneratePerfectRectBinaryElecData(), OptSignal::GenerateSignalStringGaussianOrSech(), OptSignal::GenerateSignalStringGaussianOrSechWithPhaseShift(), OptSignal::GenerateSignalStringQPSK_CW(), OptSignal::GenerateSignalStringQPSK_Gaussian(), OptSignal::GenerateSignalStringRaisedCosines(), OptSignal::GenerateSignalStringRaisedCosinesWithPhaseShift(), OptSignal::GenerateSignalStringRZGaussianPattern(), OptSignal::GenerateSignalStringUsingInputSequence(), ElecSignalStat::GetBit(), ElecSignalStat::GetBitFromString(), ElecFilter::GetClockRecoveryTime(), ElecSignalStat::GetMeanCurrentIsolatedBit0(), ElecSignalStat::GetMeanCurrentIsolatedBit1(), ElecSignalStat::GetTargetIndexTimeBestMinEyeOpening(), ElecSignalStat::GetTargetIndexTimeBestQ_Factor(), OptSignal::ImportOptSignal(), OptSignal::InitializeFirstOrderPMDSignal(), operator=(), PolarizBeamSplitter::PolarizSplitOptSignal(), PulseEvolutionAnalyzer::PulseEvolutionAnalyzer(), ReduceToSingleChannelBitString(), BeamSplitter::SplitOptSignalScalar(), ElecSignalStat::UpdateEqualizedPerformanceStatistics(), ElecSignalStat::UpdateMoments(), ElecSignalStat::UpdatePatternStats(), ElecSignalStat::UpdatePerformanceStatistics(), and WriteBitString().

int BitString::GetChannelArrayIndex

(

int

ChannelPhysicalIndex

)

References NumChannels.

Referenced by OptSignal::GetChannelArrayIndex().

int BitString::GetChannelPhysicalIndex

(

int

ChannelArrayIndex

)

References NumChannels.

Referenced by OptSignal::GetChannelPhysicalIndex(), and SetUserDefined().

int BitString::GetNumChannels

(

void

)

[inline]

Referenced by OptSignal::ConstructOptSignal().

void BitString::GetRandomString

(

void

)

References ALL_ONES, ALL_ZEROS, NumChannels, PSEUDO_RANDOM, RANDOM_EQUAL_ZEROS_ONES, RANDOM_SIMPLE, SetPseudoRandomString(), SetRandomString(), SINGLE_ONE, TypeBitString, and USER_DEFINED.

Referenced by BitString(), OptSignal::GenerateSignalStringQPSK_DPMZ_PM_NRZ(), OptSignal::GenerateSignalStringQPSK_SEQ_PM_NRZ(), and OptSignal::GetNewRandomSignalString().

int BitString::GetStringLength

(

void

)

[inline]

Referenced by AddBitStringBM(), OptSignal::AddSignalBM(), BitString(), OptSignal::ConstructOptSignal(), ElecSignalStat::InitElecSignalStat(), operator=(), and OptSignal::OptSignal().

BitString & BitString::operator=

(

BitString &

RHS_BitString

)

References DebugLevel, GetBit(), GetStringLength(), LogFile, NumChannels, RNG, SetBit(), StringLength, and TypeBitString.

string BitString::ReadString	(	string	ParameterName,
		ifstream *	InFile
	)

References LogFile.

Referenced by SetUserDefined().

void BitString::ReallocateMemory

(

void

)

void BitString::ReduceToSingleChannelBitString

(

int

ChannelArrayIndex

)

References GetBit(), SetBit(), and StringLength.

Referenced by OptDemuxer::ExtractChannel(), OptDemuxer::ExtractChannelCenterFreq(), OptDemuxer::PrepareToDemuxChannel(), and OptSignal::ReduceToSingleChannel().

void BitString::ReduceToSingleChannelBitString

(

BitString *

SCBitString

)

References GetBit(), SetBit(), and StringLength.

void BitString::ReleaseBitStringArray

(

void

)

[inline]

Referenced by OptSignal::SetNumChannels().

void BitString::SetAllOnes

(

int

ChannelArrayIndex

)

References SetBit(), and StringLength.

Referenced by BitString().

void BitString::SetAllZeros

(

int

ChannelArrayIndex

)

References SetBit(), and StringLength.

Referenced by BitString(), and SetSingleOne().

void BitString::SetBit	(	int	ChannelArrayIndex,
		int	BitSlot,
		int	BitValue
	)

References BitStringArray, and StringLength.

Referenced by AddBitStringBM(), AddBitStrings(), BitString(), OptSignal::ImportOptSignal(), operator=(), PolarizBeamSplitter::PolarizSplitOptSignal(), ReduceToSingleChannelBitString(), SetAllOnes(), SetAllZeros(), SetPseudoRandomString(), SetRandomString(), SetSingleOne(), SetStringToSingleMarkPerChannel(), SetUserDefined(), and BeamSplitter::SplitOptSignalScalar().

void BitString::SetNumChannels

(

int

value

)

[inline]

Referenced by OptSignal::SetNumberChannelsForDemuxer().

void BitString::SetPseudoRandomString

(

int

ChannelArrayIndex

)

References log(), SetBit(), and StringLength.

Referenced by GetRandomString().

void BitString::SetRandomString

(

int

ChannelArrayIndex

)

References StatisticsOfArray::GetMedian(), RanNumGen::GetRanNum(), PSEUDO_RANDOM, RANDOM_EQUAL_ZEROS_ONES, RANDOM_SIMPLE, RNG, SetBit(), StringLength, and TypeBitString.

Referenced by GetRandomString().

void BitString::SetSingleOne

(

int

ChannelArrayIndex

)

References DebugLevel, LogFile, SetAllZeros(), SetBit(), and StringLength.

Referenced by BitString().

void BitString::SetStringToSingleMarkPerChannel

(

void

)

References NumChannels, SetBit(), and StringLength.

void BitString::SetUserDefined

(

ifstream *

InFile

)

References DebugLevel, GetChannelPhysicalIndex(), LogFile, NumChannels, ReadString(), SetBit(), and StringLength.

Referenced by BitString().

string BitString::WriteBitString

(

int

ChannelArrayIndex

)

References GetBit(), and StringLength.

void BitString::WriteBitString

(

void

)

References GetBit(), NumChannels, and StringLength.

Referenced by AddBitStringBM(), AddSignals(), BitString(), and OptSignal::OptSignal().

string BitString::WriteTypeBitString

(

void

)

References ALL_ONES, ALL_ZEROS, PSEUDO_RANDOM, RANDOM_EQUAL_ZEROS_ONES, RANDOM_SIMPLE, SINGLE_ONE, TypeBitString, and USER_DEFINED.

Referenced by BitString().

---

Friends And Related Function Documentation

void AddBitStrings	(	BitString *	BitString1,
		BitString *	BitString2,
		BitString *	BitString3
	)			[friend]

---

Member Data Documentation

int* BitString::BitStringArray [private]

Referenced by AllocateBitStringArray(), BitString(), GetBit(), SetBit(), and ~BitString().

int BitString::DebugLevel [private]

Referenced by AddBitStringBM(), BitString(), operator=(), SetSingleOne(), and SetUserDefined().

int BitString::NumChannels [private]

Referenced by AddBitStringBM(), AddBitStrings(), AllocateBitStringArray(), BitString(), GetChannelArrayIndex(), GetChannelPhysicalIndex(), GetRandomString(), operator=(), SetStringToSingleMarkPerChannel(), SetUserDefined(), and WriteBitString().

RanNumGen* BitString::RNG [private]

Referenced by BitString(), operator=(), and SetRandomString().

int BitString::StringLength [private]

Referenced by AddBitStringBM(), AddBitStrings(), AllocateBitStringArray(), BitString(), GetBit(), operator=(), ReduceToSingleChannelBitString(), SetAllOnes(), SetAllZeros(), SetBit(), SetPseudoRandomString(), SetRandomString(), SetSingleOne(), SetStringToSingleMarkPerChannel(), SetUserDefined(), and WriteBitString().

typeBitString BitString::TypeBitString [private]

Referenced by BitString(), GetRandomString(), operator=(), SetRandomString(), and WriteTypeBitString().

---

The documentation for this class was generated from the following files:

• ocsBitString.hh
• ocsBitString.cc