FrameCPP::Version_9::FrameH Class Reference

Event data. More...

#include <FrameH.hh>

Inheritance diagram for FrameCPP::Version_9::FrameH:

Collaboration diagram for FrameCPP::Version_9::FrameH:

Public Types
enum	{   DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,   DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,   DT_REAL_4 , DT_REAL_8 }
enum	{   IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,   IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,   IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,   IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,   IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION }
enum	{   DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,   DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,   DT_REAL_4 , DT_REAL_8 }
enum	{   IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,   IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,   IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,   IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,   IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION }
typedef STRING< INT_2U >	string_2_type
typedef STRING< INT_2U >	string_2_type
typedef ObjectWithChecksum< Common::FrameH, checksum_type >	self_type
typedef ObjectWithChecksum< Common::FrameH, checksum_type >	self_type
typedef ObjectWithChecksum< Common::FrameH, checksum_type >	self_type
typedef ObjectWithChecksum< Common::FrameH, checksum_type >	self_type
typedef IStream	istream_type
typedef IStream	istream_type
typedef IStream	istream_type
typedef IStream	istream_type
typedef OStream	ostream_type
typedef OStream	ostream_type
typedef OStream	ostream_type
typedef OStream	ostream_type
enum	copy_type {   DETECT_SIM = 0x0001 , DETECT_PROC = 0x0002 , HISTORY = 0x0004 , RAW_DATA = 0x0008 ,   AUX_DATA = 0x0010 , AUX_TABLE = 0x0020 , TYPE = 0x0040 , USER = 0x0080 ,   DETECT_SIM = 0x0001 , DETECT_PROC = 0x0002 , HISTORY = 0x0004 , RAW_DATA = 0x0008 ,   AUX_DATA = 0x0010 , AUX_TABLE = 0x0020 , TYPE = 0x0040 , USER = 0x0080 }
enum	copy_type {   DETECT_SIM = 0x0001 , DETECT_PROC = 0x0002 , HISTORY = 0x0004 , RAW_DATA = 0x0008 ,   AUX_DATA = 0x0010 , AUX_TABLE = 0x0020 , TYPE = 0x0040 , USER = 0x0080 ,   DETECT_SIM = 0x0001 , DETECT_PROC = 0x0002 , HISTORY = 0x0004 , RAW_DATA = 0x0008 ,   AUX_DATA = 0x0010 , AUX_TABLE = 0x0020 , TYPE = 0x0040 , USER = 0x0080 }
typedef FrameSpec::version_type	frame_spec_version_type
typedef FrameSpec::version_type	frame_spec_version_type
typedef boost::shared_ptr< Object >	object_type
typedef boost::shared_ptr< Object >	object_type
typedef std::unique_ptr< Object >	unique_object_type
typedef std::unique_ptr< Object >	unique_object_type
typedef object_type	demote_arg_type
typedef object_type	demote_arg_type
typedef object_type	demote_ret_type
typedef object_type	demote_ret_type
typedef stream_base_type	demote_stream_type
typedef stream_base_type	demote_stream_type
typedef object_type	promote_arg_type
typedef object_type	promote_arg_type
typedef object_type	promote_ret_type
typedef object_type	promote_ret_type
typedef stream_base_type	promote_stream_type
typedef stream_base_type	promote_stream_type
typedef const char *const	struct_name_type
typedef const char *const	struct_desc_type
typedef INT_2U const	struct_id_type
typedef FRAME_H_NAME_TYPE	name_type
typedef FRAME_H_RUN_TYPE	run_type
typedef FRAME_H_FRAME_TYPE	frame_type
typedef FRAME_H_DATA_QUALITY_TYPE	dataQuality_type
typedef FRAME_H_G_TIME_S_TYPE	GTimeS_type
typedef FRAME_H_G_TIME_N_TYPE	GTimeN_type
typedef FRAME_H_G_TIME_TYPE	GTime_type
typedef FRAME_H_LOCAL_TIME_TYPE	localTime_type
typedef FRAME_H_DT_TYPE	dt_type
typedef INT_2U	v3_uleaps_type
typedef INT_4S	v3_localTime_type
typedef Common::SearchContainer< FrProcData, &FrProcData::GetNameSlow >	v3_strain_type
typedef boost::shared_ptr< FrRawData >	rawData_type
typedef Common::SearchContainer< FrVect, &FrVect::GetName >	type_type
typedef type_type::iterator	type_iterator
typedef type_type::const_iterator	const_type_iterator
typedef type_type::hash_iterator	type_hash_iterator
typedef type_type::const_hash_iterator	const_type_hash_iterator
typedef Common::SearchContainer< FrVect, &FrVect::GetName >	user_type
typedef user_type::iterator	user_iterator
typedef user_type::const_iterator	const_user_iterator
typedef user_type::hash_iterator	user_hash_iterator
typedef user_type::const_hash_iterator	const_user_hash_iterator
typedef Common::SearchContainer< FrDetector, &FrDetector::GetName >	detectSim_type
typedef detectSim_type::iterator	detectSim_iterator
typedef detectSim_type::const_iterator	const_detectSim_iterator
typedef detectSim_type::hash_iterator	detectSim_hash_iterator
typedef detectSim_type::const_hash_iterator	const_detectSim_hash_iterator
typedef Common::SearchContainer< FrDetector, &FrDetector::GetName >	detectProc_type
typedef detectProc_type::iterator	detectProc_iterator
typedef detectProc_type::const_iterator	const_detectProc_iterator
typedef detectProc_type::hash_iterator	detectProc_hash_iterator
typedef detectProc_type::const_hash_iterator	const_detectProc_hash_iterator
typedef Common::SearchContainer< FrEvent, &FrEvent::GetNameSlow >	event_type
typedef event_type::iterator	event_iterator
typedef event_type::const_iterator	const_event_iterator
typedef event_type::hash_iterator	event_hash_iterator
typedef event_type::const_hash_iterator	const_event_hash_iterator
typedef Common::SearchContainer< FrHistory, &FrHistory::GetName >	history_type
typedef history_type::iterator	history_iterator
typedef history_type::const_iterator	const_history_iterator
typedef history_type::hash_iterator	history_hash_iterator
typedef history_type::const_hash_iterator	const_history_hash_iterator
typedef Common::SearchContainer< FrProcData, &FrProcData::GetNameSlow >	procData_type
typedef procData_type::iterator	procData_iterator
typedef procData_type::const_iterator	const_procData_iterator
typedef procData_type::hash_iterator	procData_hash_iterator
typedef procData_type::const_hash_iterator	const_procData_hash_iterator
typedef Common::SearchContainer< FrSimData, &FrSimData::GetNameSlow >	simData_type
typedef simData_type::iterator	simData_iterator
typedef simData_type::const_iterator	const_simData_iterator
typedef simData_type::hash_iterator	simData_hash_iterator
typedef simData_type::const_hash_iterator	const_simData_hash_iterator
typedef Common::SearchContainer< FrSimEvent, &FrSimEvent::GetNameSlow >	simEvent_type
typedef simEvent_type::iterator	simEvent_iterator
typedef simEvent_type::const_iterator	const_simEvent_iterator
typedef simEvent_type::hash_iterator	simEvent_hash_iterator
typedef simEvent_type::const_hash_iterator	const_simEvent_hash_iterator
typedef Common::SearchContainer< FrSummary, &FrSummary::GetName >	summaryData_type
typedef summaryData_type::iterator	summaryData_iterator
typedef summaryData_type::const_iterator	const_summaryData_iterator
typedef summaryData_type::hash_iterator	summaryData_hash_iterator
typedef summaryData_type::const_hash_iterator	const_summaryData_hash_iterator
typedef Common::SearchContainer< FrVect, &FrVect::GetName >	auxData_type
typedef auxData_type::iterator	auxData_iterator
typedef auxData_type::const_iterator	const_auxData_iterator
typedef auxData_type::hash_iterator	auxData_hash_iterator
typedef auxData_type::const_hash_iterator	const_auxData_hash_iterator
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow >	auxTable_type
typedef auxTable_type::iterator	auxTable_iterator
typedef auxTable_type::const_iterator	const_auxTable_iterator
typedef auxTable_type::hash_iterator	auxTable_hash_iterator
typedef auxTable_type::const_hash_iterator	const_auxTable_hash_iterator

Public Member Functions
	FrameH ()
	Default constructor.
	FrameH (const name_type &name, run_type run, frame_type frame, const GTime_type &time, const dt_type dt, dataQuality_type dqual=0)
	Explicate construction.
	FrameH (const FrameH &frame)
	Copy Constructor.
	FrameH (const Previous::FrameH &Source, stream_base_type *Stream)
	Upconvert constructor.
virtual FrameH *	Clone () const
	Virtual constructor.
virtual bool	operator== (const Common::FrameSpec::Object &Obj) const
	equality operator
bool	operator== (const FrameH &RHS) const
	FrameH ()
	Default constructor.
	FrameH (const name_type &name, run_type run, frame_type frame, const GTime_type &time, const dt_type dt, dataQuality_type dqual=0)
	Explicate construction.
	FrameH (const FrameH &frame)
	Copy Constructor.
	FrameH (const Previous::FrameH &Source, stream_base_type *Stream)
	Upconvert constructor.
virtual FrameH *	Clone () const
	Virtual constructor.
virtual bool	operator== (const Common::FrameSpec::Object &Obj) const
	equality operator
bool	operator== (const FrameH &RHS) const
virtual const char *	ObjectStructName () const
	The name structure name of this object.
virtual const Common::Description *	GetDescription (ostream_type &Stream) const
	The data structure description.
virtual const Description *	GetDescription () const
	Retrieve FrSH/FrSE description of the parent object.
virtual void	assign (assign_stream_type &Stream)=0
	Assign the contents of the instance.
void	TOCQuery (int InfoClass,...) const
void	TOCQuery (int InfoClass,...) const
virtual streamsize_type	Bytes (const StreamBase &Stream) const
	Return the number of bytes for this object.
virtual streamsize_type	Bytes (const StreamBase &Stream) const
	Return the number of bytes for this object.
virtual streamsize_type	Bytes (const StreamBase &Stream) const
	Return the number of bytes for this object.
virtual streamsize_type	Bytes (const StreamBase &Stream) const
	Return the number of bytes for this object.
virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.
virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.
virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.
virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.
virtual void	Write (ostream_type &Stream) const
	Write object to the stream.
virtual void	Write (ostream_type &Stream) const
	Write object to the stream.
virtual void	Write (ostream_type &Stream) const
	Write object to the stream.
virtual void	Write (ostream_type &Stream) const
	Write object to the stream.
class_type	GetClass () const
	Retrieve the class identifier.
class_type	GetClass () const
	Retrieve the class identifier.
frame_spec_version_type	FrameSpecVersion () const
frame_spec_version_type	FrameSpecVersion () const
ostream_type &	WriteNext (ostream_type &Stream) const
	Write a next pointer to the parent to the stream.
ostream_type &	WriteNext (ostream_type &Stream) const
	Write a next pointer to the parent to the stream.
template<typename PreviousType, typename CurrentType>
FrameSpec::ObjectInterface::promote_ret_type	PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, promote_stream_type *Stream)
virtual void	VerifyObject (Verify &Verifier, IFrameStream &Stream) const
	Verify an object.
virtual void	VerifyObject (Verify &Verifier, IFrameStream &Stream) const
	Verify an object.
rawData_type *	AddressOfRawData () const
const name_type &	GetName () const
	Retrieve name of project.
run_type	GetRun () const
	Run number.
frame_type	GetFrame () const
	Frame number.
dataQuality_type	GetDataQuality () const
	Data quality flag.
const GTime_type &	GetGTime () const
	Start Time.
dt_type	GetDt () const
	Frame length.
void	SetName (const name_type &Name)
	Establish the name.
void	SetRun (run_type Run)
	Establish the run number.
void	SetDataQuality (dataQuality_type DataQuality)
	Establish the data quality flag.
void	SetDt (dt_type Dt)
	Establish the frame duration.
void	SetGTime (const GTime_type &Value)
	Establish the start time.
rawData_type	GetRawData () const
	Retrieve the raw data reference.
const type_type &	RefType () const
const user_type &	RefUser () const
const detectSim_type &	RefDetectSim () const
const detectProc_type &	RefDetectProc () const
const history_type &	RefHistory () const
const procData_type &	RefProcData () const
const simData_type &	RefSimData () const
const event_type &	RefEvent () const
const simEvent_type &	RefSimEvent () const
const summaryData_type &	RefSummaryData () const
const auxData_type &	RefAuxData () const
const auxTable_type &	RefAuxTable () const
void	SetRawData (rawData_type r)
bool	operator== (const FrameH &RHS) const

Static Public Member Functions
static promote_ret_type	Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
	Promote previous version of object to this version.
static const Common::Description *	StructDescription ()
	The description of structure.
template<class T>
static int	DataType (const T *Data)
template<class T>
static int	DataType (const T &Data)
template<class T>
static int	DataType (const T *Data)
template<class T>
static int	DataType (const T &Data)
static const char *	CheckSumDataClass ()
	Data class to be used in class field of FrSE.
static const char *	CheckSumDataClass ()
	Data class to be used in class field of FrSE.
static const char *	CheckSumDataClass ()
	Data class to be used in class field of FrSE.
static const char *	CheckSumDataClass ()
	Data class to be used in class field of FrSE.
static const char *	CheckSumDataComment ()
	Comment to be used in comment field of FrSE.
static const char *	CheckSumDataComment ()
	Comment to be used in comment field of FrSE.
static const char *	CheckSumDataComment ()
	Comment to be used in comment field of FrSE.
static const char *	CheckSumDataComment ()
	Comment to be used in comment field of FrSE.
static object_type	DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream)
	Down grade an object.
static object_type	DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream)
	Down grade an object.
static object_type	PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
	Upgrade an object.
template<typename PreviousType, typename CurrentType>
static object_type	PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
	Upgrade an object.
static object_type	PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
	Upgrade an object.
template<typename PreviousType, typename CurrentType>
static object_type	PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
	Upgrade an object.
static struct_name_type	FrameSpecName ()
static struct_name_type	StructName ()
static struct_desc_type	FrameSpecDescription ()
	Return the dictionary name of the structure.
static struct_id_type	FrameSpecId ()
	Return the dictionary name of the structure.

Static Public Attributes
static const Common::FrameSpec::Info::frame_object_types	s_object_id = Common::FrameSpec::Info::FSI_FRAME_H
static struct_name_type	struct_name
static struct_desc_type	struct_desc
static struct_id_type	struct_id
static const INT_2U	MAX_REF

Protected Types
typedef Common::FrameH::assign_stream_type	assign_stream_type

Protected Member Functions
virtual void	assign (assign_stream_type &Stream)
	Assign the contents of the instance.
virtual delta_t_normalized_type	normalizedDeltaT () const
	Frame start time in seconds.
virtual start_time_normalized_type	normalizedStartTime () const
	Duration of the frame.
cmn_streamsize_type	pBytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure.
virtual self_type *	pCreate (istream_type &Stream) const
	Virtual constructor.
virtual void	pWrite (ostream_type &Stream) const
	Write the structure to the stream.
virtual void	readSubset (istream_type &Stream, INT_4U ElementMask)
	Limitted reading of the object.
virtual void	vTOCQuery (int InfoClass, va_list vl) const
	Answer requests for information as needed by TOC.
virtual class_type	getClass () const
	Retrieve the class identifier.
virtual class_type	getClass () const
	Retrieve the class identifier.

Protected Attributes
name_type	name
run_type	run
frame_type	frame
dataQuality_type	dataQuality
GTime_type	GTime
dt_type	dt
type_type	type
user_type	user
detectSim_type	detectSim
detectProc_type	detectProc
history_type	history
rawData_type	rawData
procData_type	procData
simData_type	simData
event_type	event
simEvent_type	simEvent
summaryData_type	summaryData
auxData_type	auxData
auxTable_type	auxTable

Private Types
typedef STRING	io_name_type
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >	object_base_type

Private Member Functions
virtual demote_ret_type	demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
	Down grade an object.
virtual promote_ret_type	promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
	Upgrade an object.
virtual Object *	Create () const
virtual Object *	Create (std::istream &Buffer) const
	constructor - virtual
virtual Object *	Create () const
virtual Object *	Create (std::istream &Buffer) const
	constructor - virtual
virtual Object *	Create () const
virtual Object *	Create (std::istream &Buffer) const
	constructor - virtual
virtual Object *	Create () const
virtual Object *	Create (std::istream &Buffer) const
	constructor - virtual

Private Attributes
checksum_type	m_chkSum
	Structure checksum.
checksum_type	m_chkSum
	Structure checksum.
const class_type	m_class
	Storage for the class identifier.
const Description *const	m_desc
	Description for parent class.
const frame_spec_version_type	frame_spec_version
	Version of the frame specification.

Detailed Description

Event data.

Member Typedef Documentation

assign_stream_type

typedef Common::FrameH::assign_stream_type FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >::assign_stream_type

protectedinherited

auxData_hash_iterator

typedef auxData_type::hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::auxData_hash_iterator

inherited

auxData_iterator

typedef auxData_type::iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::auxData_iterator

inherited

auxData_type

typedef Common::SearchContainer< FrVect, &FrVect::GetName > FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::auxData_type

inherited

auxTable_hash_iterator

typedef auxTable_type::hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::auxTable_hash_iterator

inherited

auxTable_iterator

typedef auxTable_type::iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::auxTable_iterator

inherited

auxTable_type

typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::auxTable_type

inherited

const_auxData_hash_iterator

typedef auxData_type::const_hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_auxData_hash_iterator

inherited

const_auxData_iterator

typedef auxData_type::const_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_auxData_iterator

inherited

const_auxTable_hash_iterator

typedef auxTable_type::const_hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_auxTable_hash_iterator

inherited

const_auxTable_iterator

typedef auxTable_type::const_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_auxTable_iterator

inherited

const_detectProc_hash_iterator

typedef detectProc_type::const_hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_detectProc_hash_iterator

inherited

const_detectProc_iterator

typedef detectProc_type::const_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_detectProc_iterator

inherited

const_detectSim_hash_iterator

typedef detectSim_type::const_hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_detectSim_hash_iterator

inherited

const_detectSim_iterator

typedef detectSim_type::const_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_detectSim_iterator

inherited

const_event_hash_iterator

typedef event_type::const_hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_event_hash_iterator

inherited

const_event_iterator

typedef event_type::const_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_event_iterator

inherited

const_history_hash_iterator

typedef history_type::const_hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_history_hash_iterator

inherited

const_history_iterator

typedef history_type::const_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_history_iterator

inherited

const_procData_hash_iterator

typedef procData_type::const_hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_procData_hash_iterator

inherited

const_procData_iterator

typedef procData_type::const_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_procData_iterator

inherited

const_simData_hash_iterator

typedef simData_type::const_hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_simData_hash_iterator

inherited

const_simData_iterator

typedef simData_type::const_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_simData_iterator

inherited

const_simEvent_hash_iterator

typedef simEvent_type::const_hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_simEvent_hash_iterator

inherited

const_simEvent_iterator

typedef simEvent_type::const_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_simEvent_iterator

inherited

const_summaryData_hash_iterator

typedef summaryData_type::const_hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_summaryData_hash_iterator

inherited

const_summaryData_iterator

typedef summaryData_type::const_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_summaryData_iterator

inherited

const_type_hash_iterator

typedef type_type::const_hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_type_hash_iterator

inherited

const_type_iterator

typedef type_type::const_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_type_iterator

inherited

const_user_hash_iterator

typedef user_type::const_hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_user_hash_iterator

inherited

const_user_iterator

typedef user_type::const_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::const_user_iterator

inherited

dataQuality_type

typedef FRAME_H_DATA_QUALITY_TYPE FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::dataQuality_type

inherited

demote_arg_type [1/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_arg_type

inherited

demote_arg_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_arg_type

inherited

demote_ret_type [1/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_ret_type

inherited

demote_ret_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_ret_type

inherited

demote_stream_type [1/2]

typedef stream_base_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_stream_type

inherited

demote_stream_type [2/2]

typedef stream_base_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_stream_type

inherited

detectProc_hash_iterator

typedef detectProc_type::hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::detectProc_hash_iterator

inherited

detectProc_iterator

typedef detectProc_type::iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::detectProc_iterator

inherited

detectProc_type

typedef Common::SearchContainer< FrDetector, &FrDetector::GetName > FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::detectProc_type

inherited

detectSim_hash_iterator

typedef detectSim_type::hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::detectSim_hash_iterator

inherited

detectSim_iterator

typedef detectSim_type::iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::detectSim_iterator

inherited

detectSim_type

typedef Common::SearchContainer< FrDetector, &FrDetector::GetName > FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::detectSim_type

inherited

dt_type

typedef FRAME_H_DT_TYPE FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::dt_type

inherited

event_hash_iterator

typedef event_type::hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::event_hash_iterator

inherited

event_iterator

typedef event_type::iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::event_iterator

inherited

event_type

typedef Common::SearchContainer< FrEvent, &FrEvent::GetNameSlow > FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::event_type

inherited

frame_spec_version_type [1/2]

typedef FrameSpec::version_type FrameCPP::Common::FrameSpec::ObjectInterface::frame_spec_version_type

inherited

frame_spec_version_type [2/2]

typedef FrameSpec::version_type FrameCPP::Common::FrameSpec::ObjectInterface::frame_spec_version_type

inherited

frame_type

typedef FRAME_H_FRAME_TYPE FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::frame_type

inherited

GTime_type

typedef FRAME_H_G_TIME_TYPE FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::GTime_type

inherited

GTimeN_type

typedef FRAME_H_G_TIME_N_TYPE FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::GTimeN_type

inherited

GTimeS_type

typedef FRAME_H_G_TIME_S_TYPE FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::GTimeS_type

inherited

history_hash_iterator

typedef history_type::hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::history_hash_iterator

inherited

history_iterator

typedef history_type::iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::history_iterator

inherited

history_type

typedef Common::SearchContainer< FrHistory, &FrHistory::GetName > FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::history_type

inherited

io_name_type

typedef STRING FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >::io_name_type

privateinherited

istream_type [1/4]

typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::istream_type

inherited

istream_type [2/4]

typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::istream_type

inherited

istream_type [3/4]

typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::istream_type

inherited

istream_type [4/4]

typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::istream_type

inherited

localTime_type

typedef FRAME_H_LOCAL_TIME_TYPE FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::localTime_type

inherited

name_type

typedef FRAME_H_NAME_TYPE FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::name_type

inherited

object_base_type

typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type > FrameCPP::Version_9::ObjectWithChecksum< Common::FrameH >::object_base_type

privateinherited

object_type [1/2]

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type

inherited

object_type [2/2]

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type

inherited

ostream_type [1/4]

typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::ostream_type

inherited

ostream_type [2/4]

typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::ostream_type

inherited

ostream_type [3/4]

typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::ostream_type

inherited

ostream_type [4/4]

typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::ostream_type

inherited

procData_hash_iterator

typedef procData_type::hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::procData_hash_iterator

inherited

procData_iterator

typedef procData_type::iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::procData_iterator

inherited

procData_type

typedef Common::SearchContainer< FrProcData, &FrProcData::GetNameSlow > FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::procData_type

inherited

promote_arg_type [1/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_arg_type

inherited

promote_arg_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_arg_type

inherited

promote_ret_type [1/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_ret_type

inherited

promote_ret_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_ret_type

inherited

promote_stream_type [1/2]

typedef stream_base_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_stream_type

inherited

promote_stream_type [2/2]

typedef stream_base_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_stream_type

inherited

rawData_type

typedef boost::shared_ptr< FrRawData > FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::rawData_type

inherited

run_type

typedef FRAME_H_RUN_TYPE FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::run_type

inherited

self_type [1/4]

typedef ObjectWithChecksum< Common::FrameH, checksum_type > FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::self_type

inherited

self_type [2/4]

typedef ObjectWithChecksum< Common::FrameH, checksum_type > FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::self_type

inherited

self_type [3/4]

typedef ObjectWithChecksum< Common::FrameH, checksum_type > FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::self_type

inherited

self_type [4/4]

typedef ObjectWithChecksum< Common::FrameH, checksum_type > FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::self_type

inherited

simData_hash_iterator

typedef simData_type::hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::simData_hash_iterator

inherited

simData_iterator

typedef simData_type::iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::simData_iterator

inherited

simData_type

typedef Common::SearchContainer< FrSimData, &FrSimData::GetNameSlow > FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::simData_type

inherited

simEvent_hash_iterator

typedef simEvent_type::hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::simEvent_hash_iterator

inherited

simEvent_iterator

typedef simEvent_type::iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::simEvent_iterator

inherited

simEvent_type

typedef Common::SearchContainer< FrSimEvent, &FrSimEvent::GetNameSlow > FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::simEvent_type

inherited

string_2_type [1/2]

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type

inherited

string_2_type [2/2]

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type

inherited

struct_desc_type

template<typename Object_T>

typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type

inherited

struct_id_type

template<typename Object_T>

typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type

inherited

struct_name_type

template<typename Object_T>

typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type

inherited

summaryData_hash_iterator

typedef summaryData_type::hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::summaryData_hash_iterator

inherited

summaryData_iterator

typedef summaryData_type::iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::summaryData_iterator

inherited

summaryData_type

typedef Common::SearchContainer< FrSummary, &FrSummary::GetName > FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::summaryData_type

inherited

type_hash_iterator

typedef type_type::hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::type_hash_iterator

inherited

type_iterator

typedef type_type::iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::type_iterator

inherited

type_type

typedef Common::SearchContainer< FrVect, &FrVect::GetName > FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::type_type

inherited

unique_object_type [1/2]

typedef std::unique_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::unique_object_type

inherited

unique_object_type [2/2]

typedef std::unique_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::unique_object_type

inherited

user_hash_iterator

typedef user_type::hash_iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::user_hash_iterator

inherited

user_iterator

typedef user_type::iterator FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::user_iterator

inherited

user_type

typedef Common::SearchContainer< FrVect, &FrVect::GetName > FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::user_type

inherited

v3_localTime_type

typedef INT_4S FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::v3_localTime_type

inherited

v3_strain_type

typedef Common::SearchContainer< FrProcData, &FrProcData::GetNameSlow > FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::v3_strain_type

inherited

v3_uleaps_type

typedef INT_2U FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::v3_uleaps_type

inherited

Member Enumeration Documentation

anonymous enum

anonymous enum

inherited

Enumerator
IC_EOQ
IC_AMPLITUDE
IC_CHANNEL_ID
IC_DATA_QUALITY
IC_DATA_VALID
IC_DETECTOR
IC_DETECTOR_PREFIX
IC_DT
IC_END
IC_FRAME
IC_GROUP_ID
IC_GTIME_N
IC_GTIME_S
IC_ID
IC_LOCAL_TIME
IC_NAME
IC_RUN
IC_START
IC_ULEAP_S
IC_VERSION

anonymous enum

anonymous enum

inherited

Enumerator
DT_CHAR_PTR
DT_STRING_2
DT_INT_2S
DT_INT_2U
DT_INT_4S
DT_INT_4U
DT_INT_8S
DT_INT_8U
DT_REAL_4
DT_REAL_8

anonymous enum

anonymous enum

inherited

Enumerator
IC_EOQ
IC_AMPLITUDE
IC_CHANNEL_ID
IC_DATA_QUALITY
IC_DATA_VALID
IC_DETECTOR
IC_DETECTOR_PREFIX
IC_DT
IC_END
IC_FRAME
IC_GROUP_ID
IC_GTIME_N
IC_GTIME_S
IC_ID
IC_LOCAL_TIME
IC_NAME
IC_RUN
IC_START
IC_ULEAP_S
IC_VERSION

anonymous enum

anonymous enum

inherited

Enumerator
DT_CHAR_PTR
DT_STRING_2
DT_INT_2S
DT_INT_2U
DT_INT_4S
DT_INT_4U
DT_INT_8S
DT_INT_8U
DT_REAL_4
DT_REAL_8

copy_type [1/2]

enum FrameCPP::Common::FrameH::copy_type

inherited

Enumerator
DETECT_SIM
DETECT_PROC
HISTORY
RAW_DATA
AUX_DATA
AUX_TABLE
TYPE
USER
DETECT_SIM
DETECT_PROC
HISTORY
RAW_DATA
AUX_DATA
AUX_TABLE
TYPE
USER

copy_type [2/2]

enum FrameCPP::Common::FrameH::copy_type

inherited

Enumerator
DETECT_SIM
DETECT_PROC
HISTORY
RAW_DATA
AUX_DATA
AUX_TABLE
TYPE
USER
DETECT_SIM
DETECT_PROC
HISTORY
RAW_DATA
AUX_DATA
AUX_TABLE
TYPE
USER

Constructor & Destructor Documentation

FrameH() [1/8]

FrameCPP::Version_9::FrameH::FrameH

(

)

Default constructor.

FrameH() [2/8]

FrameCPP::Version_9::FrameH::FrameH	(	const name_type &	name,
		run_type	run,
		frame_type	frame,
		const GTime_type &	time,
		const dt_type	dt,
		dataQuality_type	dqual = 0 )

Explicate construction.

Parameters

[in]	name	Name of project or other experiment description
[in]	run	Run number (number < 0 reserved for simulated data); monotonic for experimental runs.
[in]	frame	Frame number, monotonically increasing until end of run, re-starting from 0 with each new run.
[in]	time	Frame start time in GPS units.
[in]	dt	Frame length in seconds
[in]	dqual	Data quality flag

Returns

A new instance of this object.

FrameH() [3/8]

FrameCPP::Version_9::FrameH::FrameH

(

const FrameH &

frame

)

Copy Constructor.

Parameters

[in]

frame

Frame to use as the base

Returns

A new instance of the object.

FrameH() [4/8]

FrameCPP::Version_9::FrameH::FrameH	(	const Previous::FrameH &	Source,
		stream_base_type *	Stream )

Upconvert constructor.

Parameters

[in]	Source	An instance of a similiar object from a previous version of the frame specification.
[in]	Stream	The stream from which the origional object was read.

Returns

A new instance of the object.

FrameH() [5/8]

FrameCPP::Version_9::FrameH::FrameH

(

)

Default constructor.

FrameH() [6/8]

FrameCPP::Version_9::FrameH::FrameH	(	const name_type &	name,
		run_type	run,
		frame_type	frame,
		const GTime_type &	time,
		const dt_type	dt,
		dataQuality_type	dqual = 0 )

Explicate construction.

Parameters

[in]	name	Name of project or other experiment description
[in]	run	Run number (number < 0 reserved for simulated data); monotonic for experimental runs.
[in]	frame	Frame number, monotonically increasing until end of run, re-starting from 0 with each new run.
[in]	time	Frame start time in GPS units.
[in]	dt	Frame length in seconds
[in]	dqual	Data quality flag

Returns

A new instance of this object.

FrameH() [7/8]

FrameCPP::Version_9::FrameH::FrameH

(

const FrameH &

frame

)

Copy Constructor.

Parameters

[in]

frame

Frame to use as the base

Returns

A new instance of the object.

FrameH() [8/8]

FrameCPP::Version_9::FrameH::FrameH	(	const Previous::FrameH &	Source,
		stream_base_type *	Stream )

Upconvert constructor.

Parameters

[in]	Source	An instance of a similiar object from a previous version of the frame specification.
[in]	Stream	The stream from which the origional object was read.

Returns

A new instance of the object.

Member Function Documentation

AddressOfRawData()

rawData_type * FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::AddressOfRawData ( ) const

inlineinherited

assign() [1/2]

virtual void FrameCPP::Common::FrameH::assign ( assign_stream_type & Stream )

pure virtualinherited

Assign the contents of the instance.

Parameters

[in]

Stream

An input stream from which to read information for the instance.

assign() [2/2]

virtual void FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >::assign ( assign_stream_type & Stream )

inlineprotectedvirtualinherited

Assign the contents of the instance.

Parameters

[in]

Stream

An input stream from which to read information for the instance.

Note

This has been hidden so programmers are not tempted to bypass usage of IFrameStream as the input stream.

Bytes() [1/4]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Bytes ( const StreamBase & Stream ) const

virtualinherited

Return the number of bytes for this object.

Parameters

[in]

Stream

Stream characteristics used to determine the number of bytes needed to format the object for the Stream.

Returns

The number of bytes for this object

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

Bytes() [2/4]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Bytes ( const StreamBase & Stream ) const

virtualinherited

Return the number of bytes for this object.

Parameters

[in]

Stream

Stream characteristics used to determine the number of bytes needed to format the object for the Stream.

Returns

The number of bytes for this object

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

Bytes() [3/4]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Bytes ( const StreamBase & Stream ) const

virtualinherited

Return the number of bytes for this object.

Parameters

[in]

Stream

Stream characteristics used to determine the number of bytes needed to format the object for the Stream.

Returns

The number of bytes for this object

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

Bytes() [4/4]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Bytes ( const StreamBase & Stream ) const

virtualinherited

Return the number of bytes for this object.

Parameters

[in]

Stream

Stream characteristics used to determine the number of bytes needed to format the object for the Stream.

Returns

The number of bytes for this object

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

CheckSumDataClass() [1/4]

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataClass ( )

staticinherited

Data class to be used in class field of FrSE.

CheckSumDataClass() [2/4]

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataClass ( )

staticinherited

Data class to be used in class field of FrSE.

CheckSumDataClass() [3/4]

const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataClass ( )

staticinherited

Data class to be used in class field of FrSE.

CheckSumDataClass() [4/4]

const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataClass ( )

staticinherited

Data class to be used in class field of FrSE.

CheckSumDataComment() [1/4]

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataComment ( )

staticinherited

Comment to be used in comment field of FrSE.

CheckSumDataComment() [2/4]

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataComment ( )

staticinherited

Comment to be used in comment field of FrSE.

CheckSumDataComment() [3/4]

const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataComment ( )

staticinherited

Comment to be used in comment field of FrSE.

CheckSumDataComment() [4/4]

const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::CheckSumDataComment ( )

staticinherited

Comment to be used in comment field of FrSE.

Clone() [1/2]

virtual FrameH * FrameCPP::Version_9::FrameH::Clone ( ) const

inlinevirtual

Virtual constructor.

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

Clone() [2/2]

virtual FrameH * FrameCPP::Version_9::FrameH::Clone ( ) const

inlinevirtual

Virtual constructor.

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

Create() [1/12]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( ) const

inlineprivatevirtualinherited

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

Create() [2/12]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( ) const

inlineprivatevirtualinherited

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

Create() [3/12]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( ) const

inlineprivatevirtualinherited

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

Create() [4/12]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( ) const

inlineprivatevirtualinherited

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

Create() [5/12]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

[in]

Stream

The input stream from where the object is being read.

Returns

Return pointer to the newly allocated resource.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

Create() [6/12]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

[in]

Stream

The input stream from where the object is being read.

Returns

Return pointer to the newly allocated resource.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

Create() [7/12]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

[in]

Stream

The input stream from where the object is being read.

Returns

Return pointer to the newly allocated resource.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

Create() [8/12]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

[in]

Stream

The input stream from where the object is being read.

Returns

Return pointer to the newly allocated resource.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

Create() [9/12]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( std::istream & Buffer ) const

inlineprivatevirtualinherited

constructor - virtual

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

Create() [10/12]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( std::istream & Buffer ) const

inlineprivatevirtualinherited

constructor - virtual

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

Create() [11/12]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( std::istream & Buffer ) const

inlineprivatevirtualinherited

constructor - virtual

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

Create() [12/12]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Create ( std::istream & Buffer ) const

inlineprivatevirtualinherited

constructor - virtual

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

DataType() [1/4]

template<class T>

int FrameCPP::Common::TOCInfo::DataType ( const T & Data )

staticinherited

DataType() [2/4]

template<class T>

int FrameCPP::Common::TOCInfo::DataType ( const T & Data )

staticinherited

DataType() [3/4]

template<class T>

int FrameCPP::Common::TOCInfo::DataType ( const T * Data )

staticinherited

DataType() [4/4]

template<class T>

int FrameCPP::Common::TOCInfo::DataType ( const T * Data )

staticinherited

demote()

virtual demote_ret_type FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >::demote ( INT_2U Target, demote_arg_type Obj, demote_stream_type * Stream ) const

inlineprivatevirtualinherited

Down grade an object.

Parameters

[in]	Target	The version of the frame specification to demote too.
[in]	Obj	The version of the object to demote.
[in]	Stream	The input stream from which the original object was read.

Returns

An object of the previous generation.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

DemoteObject() [1/2]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type Target, object_type Obj, demote_stream_type * Stream )

staticinherited

Down grade an object.

Parameters

[in]	Target	This is the version of the frame specification of the demoted object.
[in]	Obj	The base object.
[in]	Stream	Stream from which Obj was created.

Returns

A pointer to the objected derived by demoting Obj.

DemoteObject() [2/2]

object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type Target, object_type Obj, demote_stream_type * Stream )

staticinherited

Down grade an object.

Parameters

[in]	Target	This is the version of the frame specification of the demoted object.
[in]	Obj	The base object.
[in]	Stream	Stream from which Obj was created.

Returns

A pointer to the objected derived by demoting Obj.

FrameSpecDescription()

template<typename Object_T>

struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )

inlinestaticinherited

Return the dictionary name of the structure.

FrameSpecId()

template<typename Object_T>

struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )

inlinestaticinherited

Return the dictionary name of the structure.

FrameSpecName()

template<typename Object_T>

struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )

inlinestaticinherited

FrameSpecVersion() [1/2]

FrameSpec::Object::frame_spec_version_type FrameCPP::Common::FrameSpec::Object::FrameSpecVersion ( ) const

inlineinherited

FrameSpecVersion() [2/2]

frame_spec_version_type FrameCPP::Common::FrameSpec::Object::FrameSpecVersion ( ) const

inherited

GetClass() [1/2]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const

inlineinherited

Retrieve the class identifier.

Returns

The class identifier.

GetClass() [2/2]

class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const

inherited

Retrieve the class identifier.

Returns

The class identifier.

getClass() [1/2]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const

protectedvirtualinherited

Retrieve the class identifier.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

getClass() [2/2]

virtual class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const

protectedvirtualinherited

Retrieve the class identifier.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

GetDataQuality()

dataQuality_type FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::GetDataQuality ( ) const

inlineinherited

Data quality flag.

Retrieve the data quality flag associated with the frame

Returns

The data quality flag for the frame

GetDescription() [1/2]

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const

inlinevirtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns

The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

GetDescription() [2/2]

virtual const Common::Description * FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >::GetDescription ( ostream_type & Stream ) const

inlinevirtualinherited

The data structure description.

Returns

The description of the data structure used to represent this object when written to a GWF stream

Reimplemented from FrameCPP::Common::FrameSpec::Object.

GetDt()

dt_type FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::GetDt ( ) const

inlineinherited

Frame length.

Retrieve the duration of the frame in seconds.

Returns

Length of frame in seconds.

GetFrame()

frame_type FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::GetFrame ( ) const

inlineinherited

Frame number.

Retrieve the frame number associated with the frame

Returns

The frame number of the frame

GetGTime()

const GTime_type & FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::GetGTime ( ) const

inlineinherited

Start Time.

Retrieve the start time of the frame.

Returns

The start time of the frame

GetName()

const name_type & FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::GetName ( ) const

inlineinherited

Retrieve name of project.

Retrieve the name of project or other experiment description.

Returns

Name of project

GetRawData()

rawData_type FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::GetRawData ( ) const

inlineinherited

Retrieve the raw data reference.

Set the number of leap seconds since GPS epoc.

Returns

A pointer to the raw data structure.

GetRun()

run_type FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::GetRun ( ) const

inlineinherited

Run number.

Retrieve the run number associated with the frame.

Returns

The run number of the frame

normalizedDeltaT()

virtual delta_t_normalized_type FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >::normalizedDeltaT ( ) const

inlineprotectedvirtualinherited

Frame start time in seconds.

Implements FrameCPP::Common::FrameH.

normalizedStartTime()

virtual start_time_normalized_type FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >::normalizedStartTime ( ) const

inlineprotectedvirtualinherited

Duration of the frame.

Implements FrameCPP::Common::FrameH.

ObjectStructName()

virtual const char * FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >::ObjectStructName ( ) const

inlinevirtualinherited

The name structure name of this object.

Returns

The name of the structure as specified by the frame specification.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

operator==() [1/5]

bool FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::operator== ( const FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable > & RHS ) const

inlineinherited

operator==() [2/5]

virtual bool FrameCPP::Version_9::FrameH::operator== ( const Common::FrameSpec::Object & Obj ) const

virtual

equality operator

Parameters

[in]

RHS

The FrameH object to be compared.

Returns

The value true is returned if this object is equivelent to the RHS instance; false otherwise.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

operator==() [3/5]

virtual bool FrameCPP::Version_9::FrameH::operator== ( const Common::FrameSpec::Object & Obj ) const

virtual

equality operator

Parameters

[in]

RHS

The FrameH object to be compared.

Returns

The value true is returned if this object is equivelent to the RHS instance; false otherwise.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

operator==() [4/5]

bool FrameCPP::Version_9::FrameH::operator== ( const FrameH & RHS ) const

inline

operator==() [5/5]

bool FrameCPP::Version_9::FrameH::operator== ( const FrameH & RHS ) const

inline

pBytes()

cmn_streamsize_type FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >::pBytes ( const Common::StreamBase & Stream ) const

inlineprotectedvirtualinherited

Number of bytes needed to write this structure.

Parameters

[in]

Stream

The stream from which to the object is being read or written.

Returns

The number of bytes need to read or write this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >.

pCreate()

virtual self_type * FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >::pCreate ( istream_type & Stream ) const

inlineprotectedvirtualinherited

Virtual constructor.

Parameters

[in]

Stream

The input stream from which to read the object.

Returns

A new instance of this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >.

Promote()

promote_ret_type FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >::Promote ( INT_2U Source, promote_arg_type Obj, promote_stream_type * Stream )

inlinestaticinherited

Promote previous version of object to this version.

Parameters

[in]	Source	The frame specification version of the object.
[in]	Obj	The previous version of the object.
[in]	Stream	Stream from which the origional object was created.

Returns

A new instance of FrameH based on Obj

promote()

virtual promote_ret_type FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >::promote ( INT_2U Target, promote_arg_type Obj, promote_stream_type * Stream ) const

inlineprivatevirtualinherited

Upgrade an object.

Parameters

[in]	Target	The version of the promoted frame specification.
[in]	Obj	The object to be promoted.
[in]	Stream	The input stream from which the original object was read.

Returns

An object of this class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

PromoteObject() [1/5]

template<typename PreviousType, typename CurrentType>

object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type * Stream )

staticinherited

Upgrade an object.

Parameters

[in]	Target	Promote Obj to this version of the frame specification.
[in]	Source	Obj conforms to this version of the frame specification.
[in]	Obj	Object to be converted
[in]	Stream	Originating stream for Obj.

Returns

A pointer to the objected derived by promoting Obj.

PromoteObject() [2/5]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type * Stream )

staticinherited

Upgrade an object.

Parameters

[in]	Target	Promote Obj to this version of the frame specification.
[in]	Source	Obj conforms to this version of the frame specification.
[in]	Obj	Object to be converted
[in]	Stream	Originating stream for Obj.

Returns

A pointer to the objected derived by promoting Obj.

PromoteObject() [3/5]

template<typename PreviousType, typename CurrentType>

object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type * Stream )

staticinherited

Upgrade an object.

Parameters

[in]	Target	Promote Obj to this version of the frame specification.
[in]	Source	Obj conforms to this version of the frame specification.
[in]	Obj	Object to be converted
[in]	Stream	Originating stream for Obj.

Returns

A pointer to the objected derived by promoting Obj.

PromoteObject() [4/5]

object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type * Stream )

staticinherited

Upgrade an object.

Parameters

[in]	Target	Promote Obj to this version of the frame specification.
[in]	Source	Obj conforms to this version of the frame specification.
[in]	Obj	Object to be converted
[in]	Stream	Originating stream for Obj.

Returns

A pointer to the objected derived by promoting Obj.

PromoteObject() [5/5]

template<typename PreviousType, typename CurrentType>

FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, promote_stream_type * Stream )

inherited

pWrite()

virtual void FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >::pWrite ( ostream_type & Stream ) const

inlineprotectedvirtualinherited

Write the structure to the stream.

Parameters

[in]

Stream

The output stream where the object is to be written.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >.

readSubset()

virtual void FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >::readSubset ( istream_type & Stream, INT_4U ElementMask )

inlineprotectedvirtualinherited

Limitted reading of the object.

Parameters

[in]	Stream	The input stream from which to read the object.
[in]	ElementMask	Mask of elements to read from the Stream

Implements FrameCPP::Common::FrameH.

RefAuxData()

const auxData_type & FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::RefAuxData ( ) const

inlineinherited

RefAuxTable()

const auxTable_type & FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::RefAuxTable ( ) const

inlineinherited

RefDetectProc()

const detectProc_type & FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::RefDetectProc ( ) const

inlineinherited

RefDetectSim()

const detectSim_type & FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::RefDetectSim ( ) const

inlineinherited

RefEvent()

const event_type & FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::RefEvent ( ) const

inlineinherited

RefHistory()

const history_type & FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::RefHistory ( ) const

inlineinherited

RefProcData()

const procData_type & FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::RefProcData ( ) const

inlineinherited

RefSimData()

const simData_type & FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::RefSimData ( ) const

inlineinherited

RefSimEvent()

const simEvent_type & FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::RefSimEvent ( ) const

inlineinherited

RefSummaryData()

const summaryData_type & FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::RefSummaryData ( ) const

inlineinherited

RefType()

const type_type & FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::RefType ( ) const

inlineinherited

RefUser()

const user_type & FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::RefUser ( ) const

inlineinherited

SetDataQuality()

void FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::SetDataQuality ( dataQuality_type DataQuality )

inlineinherited

Establish the data quality flag.

Set the data quality flag of the frame.

Parameters

[in]

DataQuality

The value of the data quality flag.

SetDt()

void FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::SetDt ( dt_type Dt )

inlineinherited

Establish the frame duration.

Set the length of the frame in seconds.

Parameters

[in]

Dt

The length of the frame in seconds

SetGTime()

void FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::SetGTime ( const GTime_type & Value )

inlineinherited

Establish the start time.

Set the start time of the frame.

Parameters

[in]

Value

The start time of the frame.

SetName()

void FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::SetName ( const name_type & Name )

inlineinherited

Establish the name.

Set the project name of the frame. Values less than zero are reserved for simulated data. For experimental runs, this value is monotonicly increasing.

Parameters

[in]

Name

The name to associate with the frame

SetRawData()

void FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::SetRawData ( rawData_type r )

inlineinherited

SetRun()

void FrameCPP::v9::FrameH< FrVect, FrVect, FrDetector, FrDetector, FrHistory, FrRawData, FrProcData, FrSimData, FrEvent, FrSimEvent, FrSummary, FrVect, FrTable >::SetRun ( run_type Run )

inlineinherited

Establish the run number.

Set the run number of the frame. Values less than zero are reserved for simulated data. For experimental runs, this value is monotonicly increasing.

Parameters

[in]

Run

The run number to associate with the frame.

StructDescription()

const Common::Description * FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >::StructDescription ( )

inlinestaticinherited

The description of structure.

Returns

A Description object which describes this structure as specified by the frame specification.

StructName()

template<typename Object_T>

struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )

inlinestaticinherited

TOCQuery() [1/2]

void FrameCPP::Common::TOCInfo::TOCQuery ( int InfoClass, ... ) const

inlineinherited

TOCQuery() [2/2]

void FrameCPP::Common::TOCInfo::TOCQuery ( int InfoClass, ... ) const

inherited

VerifyObject() [1/2]

void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify & Verifier, IFrameStream & Stream ) const

virtualinherited

Verify an object.

Parameters

[in,out]	Verifier	Set of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]	Stream	The stream that is being used to read the object.

Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, and FrVect.

VerifyObject() [2/2]

virtual void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify & Verifier, IFrameStream & Stream ) const

virtualinherited

Verify an object.

Parameters

[in,out]	Verifier	Set of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]	Stream	The stream that is being used to read the object.

Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, and FrVect.

vTOCQuery()

virtual void FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >::vTOCQuery ( int InfoClass, va_list vl ) const

protectedvirtualinherited

Answer requests for information as needed by TOC.

Parameters

[in]	InfoClass	Class of information being requested.
[in]	vl	Variable argument list of requested data.

Implements FrameCPP::Common::TOCInfo.

Write() [1/4]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Write ( ostream_type & Stream ) const

virtualinherited

Write object to the stream.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

Write() [2/4]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Write ( ostream_type & Stream ) const

virtualinherited

Write object to the stream.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

Write() [3/4]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Write ( ostream_type & Stream ) const

virtualinherited

Write object to the stream.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

Write() [4/4]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::Write ( ostream_type & Stream ) const

virtualinherited

Write object to the stream.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

WriteNext() [1/2]

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type & Stream ) const

inherited

Write a next pointer to the parent to the stream.

Parameters

[in,out]

Stream

The output stream to receive the next pointer.

Returns

The output stream.

WriteNext() [2/2]

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type & Stream ) const

inherited

Write a next pointer to the parent to the stream.

Parameters

[in,out]

Stream

The output stream to receive the next pointer.

Returns

The output stream.

Member Data Documentation

auxData

auxData_type FrameH::auxData

protectedinherited

auxTable

auxTable_type FrameH::auxTable

protectedinherited

dataQuality

dataQuality_type FrameH::dataQuality

protectedinherited

detectProc

detectProc_type FrameH::detectProc

protectedinherited

detectSim

detectSim_type FrameH::detectSim

protectedinherited

dt

dt_type FrameH::dt

protectedinherited

event

event_type FrameH::event

protectedinherited

frame

frame_type FrameH::frame

protectedinherited

frame_spec_version

const frame_spec_version_type FrameCPP::Common::FrameSpec::Object::frame_spec_version

privateinherited

Version of the frame specification.

The version of the frame specification for which this object was created.

GTime

GTime_type FrameH::GTime

protectedinherited

history

history_type FrameH::history

mutableprotectedinherited

m_chkSum [1/2]

checksum_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::m_chkSum

privateinherited

Structure checksum.

The checksum for the structure when the structure is contained in a stream.

m_chkSum [2/2]

checksum_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >::m_chkSum

privateinherited

Structure checksum.

The checksum for the structure when the structure is contained in a stream.

m_class

const class_type FrameCPP::Common::FrameSpec::Object::m_class

privateinherited

Storage for the class identifier.

The class identifier uniquely identifies the parent class within the frame specification. All instances of parent class will have the same class identifier.

m_desc

const Description *const FrameCPP::Common::FrameSpec::Object::m_desc

privateinherited

Description for parent class.

The description for the parent class composed of one FrSH and one or more FrSE elements.

MAX_REF

const INT_2U FrameH::MAX_REF

staticinherited

name

name_type FrameH::name

protectedinherited

procData

procData_type FrameH::procData

protectedinherited

rawData

rawData_type FrameH::rawData

protectedinherited

run

run_type FrameH::run

protectedinherited

s_object_id

const Common::FrameSpec::Info::frame_object_types FrameH::s_object_id = Common::FrameSpec::Info::FSI_FRAME_H

staticinherited

simData

simData_type FrameH::simData

protectedinherited

simEvent

simEvent_type FrameH::simEvent

protectedinherited

struct_desc

template<typename Object_T>

struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc

staticinherited

struct_id

template<typename Object_T>

struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id

staticinherited

struct_name

template<typename Object_T>

struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name

staticinherited

summaryData

summaryData_type FrameH::summaryData

protectedinherited

type

type_type FrameH::type

protectedinherited

user

user_type FrameH::user

protectedinherited

---

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

• /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Version9/FrameH.hh
• /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version9/FrameH.hh