Sct Namespace Reference

This namespace contains things that might be generally useful. More...

Data Structures
class	AbstractThrowable
	A base implementation for Throwable All important information should be included in the string returned by getMessage(). More...
class	ConfigurationException
	Thrown when an error in the configuration is found. More...
class	Env
	This static class contains useful methods for dealing with environment variables. More...
class	Error
	Represents problems that might be more reasonably described as bugs. More...
class	Exception
	Represents genuinely exceptional events (such as resource acquisition failure). More...
class	FileException
	Thrown to indicate a file IO error. More...
class	IllegalStateError
	This error indicates that a class is not in an appropriate state for the request that was made of it. More...
class	InvalidArgumentError
	Thrown to report invalid arguments to functions. More...
class	InvariantViolatedError
	This error indicates that a class' invariants have been violated somehow. More...
class	IoException
	Thrown when an IO error has occured e.g. More...
class	IOManager
	An abstract class that represents an I/O backend. More...
class	IOManagerDummy
	Dummy IOManager provides streamers for code validation by UnitTest purposes only! More...
class	IOName
class	IOParams
	A tag class. More...
class	IpcException
	Thrown to indicate an error with an Ipc call. More...
class	IpcObjectException
	Thrown when an error publishing or withdrawing IPCObjects. More...
class	IsException
	Thrown to indicate an error from the Information Service. More...
class	ISIStreamWrapper
	Wrapper to wrap a ISistream as a Sct::IStream. More...
class	ISOStreamWrapper
	Wrapper to wrap a ISostream as a Sct::Ostream. More...
class	ISSerializableWrapper
	wraps a isinfo object (class as a template) as a Serializable allowing it to be read and written using IOManager classes. More...
class	ISSerializableWrapperI
	interface for templated class ISSerializableWrapper More...
class	ISStreamerWrapper
	Templated class for streaming objects derriving from the oniline isinfo with the various Sct::IOManager classes. More...
class	ISStreamerWrapper::InnerClass
	Small class inherits from T since publishGuts and refreshGuts are protected by is_generator.sh. More...
class	IStream
	Input steam interface for Sct::Streamer s. More...
class	IStreamAdaptor
	Adaptor for making a Sct::IStream from a std::istream. More...
class	LogicError
	Logic errors represent internal problems in the logic of the program. More...
class	MathsError
	Thrown when an mathametical error has occured e.g. More...
class	NoSuchStreamerException
	Indicates that there is no Streamer for a given className. More...
class	OStream
	Output stream interface for Sct::Streamer s. More...
class	OStreamAdaptor
	Adaptor for making a SCT::OStream from a std::ostream. More...
class	OutOfRangeError
	Thrown to show that arguement value is not in the allowed range. More...
class	RangedVector
	Class is like a vector, but checks the array bounds of the vector. More...
class	SctNames
	This static class exists to provide the names of SCT Online Software components. More...
class	Serializable
	Classes should implement this interface if they want to be serialized by the IO system. More...
class	StdExceptionWrapper
class	Streamable
	Classes should implement this interface if they want to be serialized by the IO system. More...
class	StreamCorruptedException
	Thrown to indicate that the stream is somehow not in the state the I/O code thought it ought to be in. More...
class	Streamer
	A streamer converts to and from a streamed representation of a data object. More...
class	Throwable
	The base class for all of the exceptions which we throw in the SCT code. More...
class	UnsupportedOperationError
	Indicates a method is not supported by this class. More...
class	VersionNotSupportedException
	Indicates an that an I/O operation failed because the version of the data was not compatible with what the software was capable of dealing with. More...
class	XmlStyleIStream
class	XmlStyleOStream
Module Parameters
Parameters of SCT modules Author: Alan Barr Date: 31 March 2003
const unsigned int	nLinkModule
const unsigned int	nChipModule
const unsigned int	nChannelModule
Typedefs
typedef IoException	IoError
	To maintain backward compatibility.
typedef map< string, shared_ptr< Streamer > >	StreamerMap
typedef InvalidArgumentError	InvalidArgument
	For backward compatibility.
Functions
size_t	substituteVariable (string &str, size_t startPos)
void	Terminate () throw ()
	This function is called in case of exception violations It should NOT be called by the user.
void	Unexpected () throw ()
	This function is called in case of uncaught exceptions It should NOT be called by the user.
void	setExceptionHandlers (const char *name) throw ()
	Main programs should call this to the Sct defaults.
ilu_T_CString	copyStringToILU (std::string str)
	Contains a set of functions useful for converting between normal objects and ILU objects.
template<typename ILUSequence, typename ListMember> ILUSequence *	copyListToILU (std::list< ListMember > thisList)
template<typename ILUSequence> ILUSequence *	copyStringListToILU (std::list< std::string > thisList)
template<typename ILUSequence, typename ListMember> std::list< ListMember >	copyILUToList (ILUSequence *thisSeq)
template<typename ILUSequence, typename List> List	copyILUToStdCollection (ILUSequence *thisSeq)
template<typename ILUSequence, typename ArrayMember> ILUSequence *	copyArrayToILU (ArrayMember *array, unsigned long length)
template<typename ILUSequence, typename ArrayMember> ILUSequence *	copyVectorToILU (std::vector< ArrayMember > array)
template<typename ILUMatrix, typename ILUSequence, typename ArrayMember> ILUMatrix *	copyVectorVectorToILU (std::vector< std::vector< ArrayMember > > matrix)
template<typename ILUBlock, typename ArrayMember> ArrayMember *	copyILUToArray (ILUBlock thisSeq, ArrayMember *array, size_t length)
template<typename T> T	min (T a, T b)
template<typename T> void	getArray (istream &stream, T *p, size_t size, size_t actualSize)
template<typename T> void	getArrayCreate (istream &stream, T **p, size_t &size)
template<typename T> void	getArrayNoCreate (istream &stream, T *p, size_t size)
void	getArray (istream &istr, char *p, size_t size, size_t actualSize)
void	getArray (istream &istr, unsigned char *p, size_t size, size_t actualSize)
unsigned char	roundToUChar (float value)
unsigned char	roundToUChar (double value)
const char *	getVersionString ()
const char *	getVersionModifier ()
unsigned int	getMajorVersion ()
unsigned int	getMinorVersion ()
double	getVersion ()
std::string	invalidate (const char *val, int length)
std::string	validate (const char *val, int length)
Variables
const char *	process_name
const char *	BuildSystem
const char *	BuildHost
const char *	BuildDate
const char *	CmtConfig
const char *	OnlineVersion
const char *	RootVersion
const char *	GccVersion
const char *	RodDaqVersion
const char *	DataFlowVersion
const char *	VersionString
	The string that contains the version info. Should be in form SctRodDaq_x_xx_sometext.
const char *	VersionModifier
	the bit at the end
const double	Version
	x_xx => x.xx
const unsigned int	MajorVersion
	The major version.
const unsigned int	MinorVersion
	The minor version (decimal part of version * 100).
std::string	escape []
std::string	entity []

---

Detailed Description

This namespace contains things that might be generally useful.

All the classes currently here are to do with IS/Serialization in one way or another. Streamable and Serializable are interfaces that client classes should implement if they want the IO system to serialize them. The IS* classes are the machinery to do that for IS. In particular, look at the ISManager class. SctISName is a class that represents the name of something in IS. Finally, SctNames is a class that gives access to the IS server names and IPC partition.

Here are some pretty pictures that might explain how the IS/IO stuff works.

Shows how to use the Steamable interface

Shows how to use the Serializable interface

---

Typedef Documentation

typedef InvalidArgumentError Sct::InvalidArgument

For backward compatibility. Definition at line 65 of file LogicErrors.h. Referenced by SctFitter::FitAlgorithmMap::getAlgorithm(), SctAnalysis::AnalysisAlgorithmMap::getAlgorithm(), and Sct::Archive::IONameArchiveFile::IONameArchiveFile().

typedef IoException Sct::IoError

To maintain backward compatibility. Definition at line 37 of file IoExceptions.h. Referenced by SctData::IO::TrimRangeTestResultStreamer_v2::read(), SctData::IO::TrimRangeTestResultStreamer_v1::read(), SctData::IO::TimeWalkTestResultStreamer_v1::read(), SctData::IO::TGraphStreamer_v1::read(), SctData::IO::TF1Streamer_v1::read(), SctData::IO::TestResultStreamer_v3::read(), SctData::IO::TestResultStreamer_v1::read(), SctData::IO::StrobeDelayTestResultStreamer_v2::read(), SctData::IO::StrobeDelayTestResultStreamer_v1::read(), SctData::IO::SingleVariableTestResultStreamer_v2::read(), SctData::IO::SingleVariableTestResultStreamer_v1::read(), SctData::ScanResultWriter::read(), SctData::IO::ScanResultStreamer_v1::read(), SctData::IO::ScanPointsStreamer_v1::read(), SctData::IO::RxThresholdTestResultStreamer_v1::read(), SctData::IO::RxDelayTestResultStreamer_v1::read(), SctData::IO::ResultHeaderStreamer_v1::read(), SctData::IO::PipelineTestResultStreamer_v1::read(), SctData::IO::NPtGainTestResultStreamer_v1::read(), SctData::IO::NoiseOccupancyTestResultStreamer_v1::read(), SctData::IO::NMaskTestResultStreamer_v1::read(), SctData::IO::ModuleConfigurationStreamer_v2::read(), SctData::IO::ModuleConfigurationStreamer_v1::read(), Sct::IS::IOManagerIS::read(), SctData::IO::FullBypassTestResultStreamer_v1::read(), SctData::IO::FitScanResultStreamer_v1::read(), SctData::IO::FitObjectStreamer_v1::read(), SctData::IO::DefectListStreamer_v1::read(), SctData::IO::ChipConfigurationStreamer_v1::read(), SctData::IO::TrimRangeTestResultStreamer_v2::write(), SctData::IO::TrimRangeTestResultStreamer_v1::write(), SctData::TestSummary::TrimRangeSummaryWriter::write(), SctData::IO::TimeWalkTestResultStreamer_v1::write(), SctData::TestSummary::TimeWalkSummaryWriter::write(), SctData::IO::TGraphStreamer_v1::write(), SctData::IO::TF1Streamer_v1::write(), SctData::IO::TestResultStreamer_v3::write(), SctData::IO::TestResultStreamer_v1::write(), SctData::TestSummary::SummaryWriter::write(), SctData::TestSummary::SummaryManager::write(), SctData::IO::StrobeDelayTestResultStreamer_v2::write(), SctData::IO::StrobeDelayTestResultStreamer_v1::write(), SctData::TestSummary::StrobeDelaySummaryWriter::write(), SctData::IO::SingleVariableTestResultStreamer_v2::write(), SctData::IO::SingleVariableTestResultStreamer_v1::write(), SctData::ScanResultWriter::write(), SctData::IO::ScanResultStreamer_v1::write(), SctData::IO::ScanPointsStreamer_v1::write(), SctData::IO::RxThresholdTestResultStreamer_v1::write(), SctData::TestSummary::RxThresholdSummaryWriter::write(), SctData::IO::RxDelayTestResultStreamer_v1::write(), SctData::TestSummary::RxDelaySummaryWriter::write(), SctData::IO::ResultHeaderStreamer_v1::write(), SctData::IO::PipelineTestResultStreamer_v1::write(), SctData::TestSummary::PipelineSummaryWriter::write(), SctData::IO::NPtGainTestResultStreamer_v1::write(), SctData::TestSummary::NPtGainSummaryWriter::write(), SctData::IO::NoiseOccupancyTestResultStreamer_v1::write(), SctData::TestSummary::NoiseOccupancySummaryWriter::write(), SctData::IO::NMaskTestResultStreamer_v1::write(), SctData::TestSummary::NMaskSummaryWriter::write(), SctData::IO::ModuleConfigurationStreamer_v2::write(), SctData::IO::ModuleConfigurationStreamer_v1::write(), Sct::IS::IOManagerIS::write(), SctData::IO::FullBypassTestResultStreamer_v1::write(), SctData::TestSummary::FullBypassSummaryWriter::write(), SctData::IO::FitScanResultStreamer_v1::write(), SctData::IO::FitObjectStreamer_v1::write(), SctData::IO::DefectListStreamer_v1::write(), and SctData::IO::ChipConfigurationStreamer_v1::write().

---

Function Documentation

ilu_T_CString copyStringToILU (  std::string  str  )  [inline]

Contains a set of functions useful for converting between normal objects and ILU objects. Author: Matthew Palmer based on an original by Bruce Gallop Definition at line 16 of file ILUMarshalling.h.

void Sct::Terminate (   )  throw ()

This function is called in case of exception violations It should NOT be called by the user. It sends a message to MRS and calls terminate(); Definition at line 130 of file Exception.cpp. References Sct::AbstractThrowable::sendToMrs(), and Sct::Throwable::sendToMrs().

Here is the call graph for this function:

void Sct::Unexpected (   )  throw ()

This function is called in case of uncaught exceptions It should NOT be called by the user. It sends the last created exception to MRS, and calls abort(); Definition at line 167 of file Exception.cpp. References Sct::AbstractThrowable::sendToMrs().

Here is the call graph for this function:

---

Variable Documentation

const unsigned int Sct::MajorVersion

The major version. Definition at line 62 of file Version.cpp.

const unsigned int Sct::MinorVersion

The minor version (decimal part of version * 100). Definition at line 63 of file Version.cpp.

const double Sct::Version

x_xx => x.xx Definition at line 61 of file Version.cpp.

const char * Sct::VersionModifier

the bit at the end Definition at line 60 of file Version.cpp.

const char * Sct::VersionString

The string that contains the version info. Should be in form SctRodDaq_x_xx_sometext. Definition at line 59 of file Version.cpp.

---