Extended TCL Commands

Functions

Name	Description
Adc2container	Convert FrameCPP ADC data structure into LDAS Container.
DetectorProc2container	Convert FrameCPP Detector data structure into LDAS Container.
DetectorSim2container	Convert FrameCPP simulated Detector data structure into LDAS Container.
Event2container	Convert FrameCPP Event data structure into LDAS Container.
History2container	Convert FrameCPP History data structure into LDAS Container.
Proc2container	Convert FrameCPP Proc data structure into LDAS Container.
Ser2container	Convert FrameCPP Serial data structure into LDAS Container.
SimData2container	Convert FrameCPP SimData structure into LDAS Container.
SimEvent2container	Convert FrameCPP SimEvent data structure into LDAS Container.
Summary2container	Convert FrameCPP Summary data structure into LDAS Container.
adcPointer2ProcPointer	Convert frameCPP::AdcData to the frameCPP::ProcData.
closeFrameFile	Close a frame file
concatAdcDataList	Concatenate AdcData
concatAdcDataList_r	Concatenate AdcData -- get thread result
concatAdcDataList_t	Concatenate AdcData -- threaded
concatFrameList	Concatenate Frames.
concatFrameList_r	Concatenate Frames - return value
concatFrameList_t	Concatenate Frames - Threaded
concatProcDataList	Concatenate ProcData
concatProcDataList_r	Concatenate ProcData -- get thread result
concatProcDataList_t	Concatenate ProcData -- threaded
concatSerDataList	Concatenate SerData
concatSerDataList_r	Concatenate SerData -- thread return value
concatSerDataList_t	Concatenate SerData -- threaded
concatSimDataList	Concatenate SimData
concatSimDataList_r	Concatenate SimData -- get thread result
concatSimDataList_t	Concatenate SimData -- threaded
createDetector	Create a FrameCPP detector as ILWD container object.
createFrame	Create an empty FrameCPP Frame as ILWD container object.
createHistory	Create a FrameCPP History as ILWD container object.
createMsg	Create a FrameCPP Msg as ILWD container object.
createOuterDetectorProcContainer	Create an empty ILWD container to hold a linked list of FrameCPP ProcDetector data structures.
createOuterDetectorSimContainer	Create an empty ILWD container to hold a linked list of FrameCPP SimDetector data structures.
createOuterHistoryContainer	Create an empty ILWD container to hold a linked list of FrameCPP History data structures.
createProcData	Create a FrameCPP ProcData as ILWD container object.
createRawData	Create an empty FrameCPP RawData as ILWD container object.
createRawFrame	Create a simple template frame.
createResampleState	Create resampling state
destructAdcData	Delete an ADC object from memory.
destructFrame	Delete a frame object from memory.
destructProcData	Delete ProcData object from memory.
destructResampleState	Destroy resampling state
dumpFrameCPPRegistry	Display currently registered frameCPP objects.
fullFrame2container	Convert whole FrameCPP Frame into LDAS Container
fullFrame2container_r	Convert whole FrameCPP Frame into LDAS Container - thread return value
fullFrame2container_t	Convert whole FrameCPP Frame into LDAS Container - Threaded
getChannelList	Get ADC Channel List
getChannelListFromFrameFile	Get list of channels from frame file.
getFrameAdcData	Find ADC structure by name or access by index.
getFrameAdcDataBias	Get ADC bias.
getFrameAdcDataChannelGroup	Get ADC channel group number.
getFrameAdcDataChannelNumber	Get ADC channel number.
getFrameAdcDataComment	Get ADC comment.
getFrameAdcDataDataValid	Get ADC data valid flag.
getFrameAdcDataFShift	Get ADC frequency shift.
getFrameAdcDataNBits	Get ADC's number of bits per sample.
getFrameAdcDataName	Get ADC name.
getFrameAdcDataNum	Get the number of ADC structures in a frame.
getFrameAdcDataPhase	Get ADC phase at start of dataset.
getFrameAdcDataSampleDt	Get ADC sample delta T.
getFrameAdcDataSampleRate	Get ADC sampling rate.
getFrameAdcDataSlice	Get a slice of the ADC data.
getFrameAdcDataSlope	Get ADC Slope.
getFrameAdcDataTimeOffset	Get ADC time offset.
getFrameAdcDataTimeOffsetN	Get ADC time offset nanoseconds.
getFrameAdcDataTimeOffsetS	Get ADC time offset seconds.
getFrameAdcDataUnits	Get ADC engineering unit string.
getFrameAttribute	Return an attribute of a frame.
getFrameAuxNum	Get the number of auxiliary data structures in a frame.
getFrameData	Return frame data.
getFrameDetectorArmXaltitude	Get Detector altitude angle of arm X.
getFrameDetectorArmXazimuth	Get Detector orientation of arm X.
getFrameDetectorArmXmidpoint	Get Detector midpoint of arm X.
getFrameDetectorArmYaltitude	Get Detector altitude angle of arm Y.
getFrameDetectorArmYazimuth	Get Detector orientation of arm Y.
getFrameDetectorArmYmidpoint	Get Detector midpoint of arm Y.
getFrameDetectorDataQuality	Get Detector's dataQuality word.
getFrameDetectorElevation	Get Detector vertex elevation.
getFrameDetectorLatitude	Get Detector vertex latitude (degrees).
getFrameDetectorLocalTime	Get Detector's localTime offset.
getFrameDetectorLongitude	Get Detector vertex longitude (degrees).
getFrameDetectorName	Get Detector name.
getFrameDetectorProc	Find frame detector structure by name of access by index.
getFrameDetectorProcNum	Get the number of detector structures in a frame.
getFrameDetectorQaBitList	Get Detector's data quality descriptor list.
getFrameDetectorSim	Find frame simulation detector structure by name of access by index.
getFrameDetectorSimNum	Get the number of simulated detector structures in a frame.
getFrameDictionary	Get FrameCPP dictionary info.
getFrameEvent	Find Event structure by name or access by index.
getFrameEventAmplitude	Get Event amplitude.
getFrameEventComment	Get Event comment.
getFrameEventEventStatus	Get Event eventStatus.
getFrameEventGTime	Get Event's "maximum of event" time.
getFrameEventInputs	Get Event inputs.
getFrameEventNParam	Get Event number of additional event parameters.
getFrameEventName	Get Event name.
getFrameEventNum	Get the number of Event structures in a frame.
getFrameEventParameterNames	Get Event parameter Name at offset x.
getFrameEventParameters	Get Event parameter at offset x.
getFrameEventProbability	Get Event probability.
getFrameEventStatistics	Get Event statistics.
getFrameEventTimeAfter	Get Event timeAfter.
getFrameEventTimeBefore	Get Event timeBefore.
getFrameFrameH	Convert FrameCPP Frame Header into LDAS Container History and Detector structures are included too.
getFrameFrameHDataQuality	Get frame dataQuality
getFrameFrameHDt	Get frame period (delta t or Dt)
getFrameFrameHFrame	Get frame "frame number"
getFrameFrameHGTime	Get frame GPS time.
getFrameFrameHName	Get frame name.
getFrameFrameHRun	Get frame run number.
getFrameFrameHULeapS	Get frame leap seconds.
getFrameHistory	Find History structure by name or access by index.
getFrameHistoryComment	Get History comment.
getFrameHistoryName	Get History name.
getFrameHistoryNum	Get the number of history data structures in a frame.
getFrameHistoryTime	Get History time.
getFrameMsg	Find Msg structure by name or access by index.
getFrameMsgAlarm	Get Msg alarm (name of message).
getFrameMsgGTime	Get Msg GPS time.
getFrameMsgMessage	Get Msg message.
getFrameMsgNum	Get the number of Msg structures in a frame.
getFrameMsgSeverity	Get Msg severity.
getFrameNumber	Read the number of frames from the TOC structure
getFrameProcData	Find ProcData structure by name or access by index.
getFrameProcDataAuxParam	Get ProcData auxParam at offset x.
getFrameProcDataAuxParamNames	Get ProcData auxParam Name at offset x.
getFrameProcDataBW	Get ProcData BW at start of dataset.
getFrameProcDataComment	Get ProcData comment.
getFrameProcDataFRange	Get ProcData frequency range.
getFrameProcDataFShift	Get ProcData frequency shift.
getFrameProcDataNAuxParam	Get ProcData number of additional procdata parameter.s
getFrameProcDataName	Get ProcData name.
getFrameProcDataNum	Get the number of procesed data structures in a frame.
getFrameProcDataPhase	Get ProcData phase at start of dataset.
getFrameProcDataSlice	Get a slice of the Proc data.
getFrameProcDataSliceIndex	Get a slice of the Proc data.
getFrameProcDataSubType	Get ProcData subType.
getFrameProcDataTRange	Get ProcData time range.
getFrameProcDataTimeOffset	Get ProcData time offset.
getFrameProcDataType	Get ProcData type.
getFrameSerData	Find Serial Data structure by name or access by index.
getFrameSerDataData	Get Serial Data Data.
getFrameSerDataName	Get Serial Data name.
getFrameSerDataNum	Get the number of Serial data structures in a frame.
getFrameSerDataSampleRate	Get Serial Data sampling rate.
getFrameSerDataTime	Get Serial Data acquisition time.
getFrameSimData	Find SimData structure by name or access by index.
getFrameSimDataComment	Get SimData comment.
getFrameSimDataFShift	Get SimData frequency shift.
getFrameSimDataName	Get SimData name.
getFrameSimDataNum	Get the number of simulation data structures in a frame.
getFrameSimDataPhase	Get SimData phase at start of dataset.
getFrameSimDataSampleRate	Get SimData sampling rate.
getFrameSimEvent	Find SimEvent structure by name or access by index.
getFrameSimEventAmplitude	Get SimEvent amplitude.
getFrameSimEventComment	Get SimEvent comment.
getFrameSimEventGTime	Get SimEvent maximum of event time.
getFrameSimEventInputs	Get SimEvent inputs.
getFrameSimEventNParam	Get SimEvent number of additional event parameters.
getFrameSimEventName	Get SimEvent name.
getFrameSimEventNum	Get the number of SimEvent data structures in a frame.
getFrameSimEventParameterNames	Get SimEvent parameter Name at offset x.
getFrameSimEventParameters	Get SimEvent parameter at offset x.
getFrameSimEventTimeAfter	Get SimEvent timeAfter.
getFrameSimEventTimeBefore	Get SimEvent timeBefore.
getFrameStatData	Find StatData structure by name or by index.
getFrameStatDataComment	Get Static Data Structure comment string.
getFrameStatDataName	Get Static Data Structure name.
getFrameStatDataRepresentation	Get Static Data Structure representation string.
getFrameStatDataTimeEnd	Get Static Data Structure timeEnd variable.
getFrameStatDataTimeStart	Get Static Data Structure timeStart variable.
getFrameStatDataVersion	Get Static Data Structure version.
getFrameSummary	Find Summary structure by name or access by index.
getFrameSummaryComment	Get Summary comment.
getFrameSummaryGTime	Get Summary GPS time.
getFrameSummaryName	Get Summary name.
getFrameSummaryNum	Get the number of summary data structures in a frame.
getFrameSummaryTest	Get Summary test.
ilwd2frame	Convert an ILWD frame to a FrameCPP frame.
ilwd2frame_r	Convert an ILWD frame to a FrameCPP frame - thread return value
ilwd2frame_t	Convert an ILWD frame to a FrameCPP frame - Threaded
insertAdcChanList	Transfer Frame ADC channels into an ILWD container.
insertDetector	Insert detector structure from the FrameCPP `frame' into the LDAS container `f'.
insertFrameData	Insert ILWD frame data into an ILWD frame.
insertHistory	Insert all history structures from the FrameCPP 'frame' into the LDAS container `f'.
insertSerChanList	Transfer Frame Serial Data channels into an ILWD container.
isFrameValid	Is frame a valid object?
normalizeFrameTimeILwd	Normalize time data within Frame Container and subcontainers.
openFrameFile	Open a frame file for reading/writing.
openFrameFile_r	Open a frame file for reading/writing. - Thread return value
openFrameFile_t	Open a frame file for reading/writing. - Threaded
readFrame	Read a frame from a file.
readFrame_r	Read a frame from a file - Thread return value
readFrame_t	Read a frame from a file - Threaded
recvFrameBinary	Receive Frame as File
recvFrameBinary_r	Receive frame as file - thread return value
recvFrameBinary_t	Receive Frame as File - Threaded
reduceRawFrames_r	Create reduced data set of frames. - Thread return value.
reduceRawFrames_t	Create reduced data set of frames (threaded).
rehashAdc	Rehash adc name hash in the frame.
rehashProc	Rehash ProcData name hash in the frame.
rehashSer	Rehash serial data name hash in the frame.
resampleAdcData	Resample AdcData
resampleAdcData_r	Resample AdcData - Thread return value
resampleAdcData_t	Resample AdcData (threaded)
resampleDelay	Get resampling filter delay time
resampleRawFrames_r	Create resampled reduced data set of frames. - Thread return value.
resampleRawFrames_t	Create resampled reduced data set of frames (threaded).
sendFrameBinary	Send Frame as File
sendFrameBinary_r	Send frame as file - thread return value
sendFrameBinary_t	Send Frame as File -- Threaded
setFrameAdcDataTimeOffset	Set ADC time offset.
setFrameProcDataTimeOffset	Reset timeOffset for frameCPP::ProcData.
writeFrame	Write a frame to a file.
writeFrame_r	Write a frame to a file - thread return value
writeFrame_t	Write a frame to a file - Threaded

Member Descriptions:

Members of type function

---

Adc2container - Convert FrameCPP ADC data structure into LDAS Container.

---

Function returns newly allocated C++ ILwd container object. Caller is responsible for the destruction of this object.

Usage - Basic SWIG interface:
set ptResult [ Adc2container adcPtr sec nsec dt ]

Parameters:

Name	Type	Description
adcPtr	FrAdcData*	Adc data pointer.
sec	unsigned int	GPS frame timestamp.
sec	unsigned int	GPS frame timestamp.
dt	double	Frame delta time.

Return value:
Ldascontainer* ptResult - A pointer to new C++ ILWD format element that represents FrameCPP::AdcData.

Exceptions:

Exception	Description
SwigException
null adcdata pointer	AdcData pointer is NULL.
bad_alloc	Memory allocation failed.

---

DetectorProc2container - Convert FrameCPP Detector data structure into LDAS Container.

---

Function returns newly allocated C++ ILwd container object. Caller is responsible for the destruction of this object.

Usage - Basic SWIG interface:
set ptResult [ DetectorProc2container detectorPtr ]

Parameters:

Name	Type	Description
detectorPtr	FrDetector*	Detector pointer.

Return value:
LdasContainer* ptResult - A pointer to new C++ ILWD format element that represents FrameCPP::Detector.

Exceptions:

Exception	Description
SwigException
null detector pointer	Detector pointer is NULL.
bad_alloc	Memory allocation failed.

---

DetectorSim2container - Convert FrameCPP simulated Detector data structure into LDAS Container.

---

Function returns newly allocated C++ ILwd container object. Caller is responsible for the destruction of this object.

Usage - Basic SWIG interface:
set ptResult [ DetectorProc2container detectorPtr]

Parameters:

Name	Type	Description
detectorPtr	FrDetector*	Detector pointer.

Return value:
Ldascontainer* ptResult - A pointer to new C++ ILWD format element that represents FrameCPP::Detector.

Exceptions:

Exception	Description
SwigException
null detector pointer	Detector pointer is NULL.
bad_alloc	Memory allocation failed.

---

Event2container - Convert FrameCPP Event data structure into LDAS Container.

---

Function returns newly allocated C++ ILwd container object. Caller is responsible for the destruction of this object.

Usage - Basic SWIG interface:
set ptResult [ SimEvent2container simPtr sec nsec dt ]

Parameters:

Name	Type	Description
simPtr	FrEvent*	SimEvent data pointer.
sec	unsigned int	GPS frame timestamp.
sec	unsigned int	GPS frame timestamp.
dt	double	Frame delta time.

Return value:
Ldascontainer* ptResult - A pointer to new C++ ILWD format element that represents FrameCPP::Event.

Exceptions:

Exception	Description
SwigException
null simevent pointer	SimEvent pointer is NULL.
bad_alloc	Memory allocation failed.

---

History2container - Convert FrameCPP History data structure into LDAS Container.

---

Function returns newly allocated C++ ILwd container object. Caller is responsible for the destruction of this object.

Usage - Basic SWIG interface:
set ptResult [ History2container histPtr ]

Parameters:

Name	Type	Description
histPtr	FrHistory*	History pointer.

Return value:
Ldascontainer* ptResult - A pointer to new C++ ILWD format element that represents FrameCPP::History.

Exceptions:

Exception	Description
SwigException
null history pointer	History pointer is NULL.
bad_alloc	Memory allocation failed.

---

Proc2container - Convert FrameCPP Proc data structure into LDAS Container.

---

Function returns newly allocated C++ ILwd container object. Caller is responsible for the destruction of this object.

Usage - Basic SWIG interface:
set ptResult [ Proc2container procPtr sec nsec dt ]

Parameters:

Name	Type	Description
procPtr	FrProcData*	Proc data pointer.
sec	unsigned int	GPS frame timestamp.
sec	unsigned int	GPS frame timestamp.
dt	double	Frame delta time.

Return value:
Ldascontainer* ptResult - A pointer to new C++ ILWD format element that represents FrameCPP::ProcData.

Exceptions:

Exception	Description
SwigException
null procdata pointer	ProcData pointer is NULL.
bad_alloc	Memory allocation failed.

---

Ser2container - Convert FrameCPP Serial data structure into LDAS Container.

---

Function returns newly allocated C++ ILwd container object. Caller is responsible for the destruction of this object.

Usage - Basic SWIG interface:
set ptResult [ Ser2container serPtr sec nsec dt ]

Parameters:

Name	Type	Description
serPtr	FrSerData*	Serial data pointer.
sec	unsigned int	GPS frame timestamp.
sec	unsigned int	GPS frame timestamp.
dt	double	Frame delta time.

Return value:
Ldascontainer* ptResult - A pointer to new C++ ILWD format element that represents FrameCPP::SerData.

Exceptions:

Exception	Description
SwigException
null serdata pointer	SerData pointer is NULL.
bad_alloc	Memory allocation failed.

---

SimData2container - Convert FrameCPP SimData structure into LDAS Container.

---

Function returns newly allocated C++ ILwd container object. Caller is responsible for the destruction of this object.

Usage - Basic SWIG interface:
set ptResult [ SimData2container simPtr sec nsec dt ]

Parameters:

Name	Type	Description
simPtr	FrSimData*	Sim data pointer.
sec	unsigned int	GPS frame timestamp.
sec	unsigned int	GPS frame timestamp.
dt	double	Frame delta time.

Return value:
Ldascontainer* ptResult - A pointer to new C++ ILWD format element that represents FrameCPP::SimData.

Exceptions:

Exception	Description
SwigException
null simdata pointer	SimData pointer is NULL.
bad_alloc	Memory allocation failed.

---

SimEvent2container - Convert FrameCPP SimEvent data structure into LDAS Container.

---

Function returns newly allocated C++ ILwd container object. Caller is responsible for the destruction of this object.

Usage - Basic SWIG interface:
set ptResult [ SimEvent2container simPtr sec nsec dt ]

Parameters:

Name	Type	Description
simPtr	FrSimEvent*	SimEvent data pointer.
sec	unsigned int	GPS frame timestamp.
sec	unsigned int	GPS frame timestamp.
dt	double	Frame delta time.

Return value:
Ldascontainer* ptResult - A pointer to new C++ ILWD format element that represents FrameCPP::SimEvent.

Exceptions:

Exception	Description
SwigException
null simevent pointer	SimEvent pointer is NULL.
bad_alloc	Memory allocation failed.

---

Summary2container - Convert FrameCPP Summary data structure into LDAS Container.

---

Function returns newly allocated C++ ILwd container object. Caller is responsible for the destruction of this object.

Usage - Basic SWIG interface:
set ptResult [ Summary2container sumPtr ]

Parameters:

Name	Type	Description
sumPtr	FrSummary*	Summary pointer.

Return value:
LdasContainer* ptResult - A pointer to new C++ ILWD format element that represents FrameCPP::Summary.

Exceptions:

Exception	Description
SwigException
null summary pointer	Summary pointer is NULL.
bad_alloc	Memory allocation failed.

---

adcPointer2ProcPointer - Convert frameCPP::AdcData to the frameCPP::ProcData.

---

It creates new ProcData structure, which is not linked to any frame. Function returns newly constructed C++ FrameCPP::ProcData object. User is responsible for the destruction of returned object( 'destructProcData' ).

Usage - Basic SWIG interface:
set ptResult [ adcPointer2ProcPointer adcPtr ]

Parameters:

Name	Type	Description
adcPtr	FrAdcData*	source AdcData data pointer

Return value:
FrameCPP::FrProcData* ptResult - a pointer to newly allocated ProcData data structure.

Exceptions:

Exception	Description
SwigException
std::bad_alloc	Memory allocation failed.
null adcdata	AdcData pointer is null.

---

closeFrameFile - Close a frame file

---

Usage - Basic SWIG interface:
closeFrameFile ptFrameFile

Parameters:

Name	Type	Description
ptFrameFile	FrameFile*	A pointer to a frame file object in the C++ layer. This object must have been created via the openFrameFile command.

Exceptions:

Exception	Description
invalid_frame_file	The pointer is invalid (it does not point to a valid object in the C++ layer).

---

concatAdcDataList - Concatenate AdcData

---

This command concatenates a list of AdcData objects, creating a new object in the process. Caller is responsible for destruction of the result ILWD object.

Usage - Basic SWIG interface:
set ptResult [concatAdcDataList ptObjArray]

Parameters:

Name	Type	Description
ptObjArray	vector<LdasContainer*> &	A pointer to a NULL terminated array of ILWD AdcData objects in the C++ layer.

Return value:
LdasContainer* ptResult - The concatenated object.

Exceptions:

Exception	Description
invalid_ilwd_element	A pointer to the ILWD element is invalid.
invalid_container	One or both of the container objects don't exist.
invalid_frame_object	One or both of the container objects do not contain a frame object.
not_adcdata	The container objects contain a frame data type other than AdcData.
bad_adcdata: not_frame_data	The container objects are not frame data.
incompatible_types	The container objects do not contain the same type.
bad_adcdata	The containers contain adcdata but it is malformed.
incompatible_adc_group	The containers contain AdcData but they have a different group.
incompatible_adc_channel	The containers contain AdcData but they have a different channel.
incompatible_adc_nbits	The containers contain AdcData but they have a different number of bits in the ADC output.
incompatible_channels	The containers contain AdcData but they are for different channels.
incompatible_adc_nbits	The containers contain AdcData but the ADC's which generated the data didn't have the same nBits.
incompatible_adc_bias	The containers contain AdcData but the ADC's which generated the data didn't have the same bias.
incompatible_adc_slope	The containers contain AdcData but the ADC's which generated the data didn't have the same slope.
incompatible_adc_units	The containers contain AdcData but the units are not the same.
incompatible_adc_samplerate	The containers contain AdcData but the sample rate is different.
incompatible_adc_fshift	The containers contain AdcData but the frequency shift is different.
unsupported_adcdata	The containers contain AdcData but one or more of them containe either more than one data vector or a multi-dimensional data vector.
incompatible_adcdata	The containers contain AdcData, however the data in the object has different types (e.g. INT_4U vs. INT_4S), different units, or the beginning of the data in the second container does not correspond to the end of the data in the first container.
incomplete_adcdata	The containers contain AdcData, however the data in the first container does not run until the end of the frame.
memory_allocation_failed	Error allocating memory.
invalid_format: "element" is unexpected type	AdcData element specified by "element" has different type from expected.
invalid_format: "element" not found	AdcData is missing "element".
invalid_format	AdcData is malformed.
SwigException

---

concatAdcDataList_r - Concatenate AdcData -- get thread result

---

This command concatenates a list of AdcData objects, creating a new object in the process. Caller is responsible for destruction of the result ILWD object.

Usage - Basic SWIG interface:
set ptResult [concatAdcDataList_r tid]

Parameters:

Name	Type	Description
tid	tid*	A pointer to a ilwd2frame thread.

Return value:
LdasContainer* ptResult - The concatenated object.

Exceptions:

Exception	Description
invalid_ilwd_element	A pointer to the ILWD element is invalid.
invalid_container	One or both of the container objects don't exist.
invalid_frame_object	One or both of the container objects do not contain a frame object.
not_adcdata	The container objects contain a frame data type other than AdcData.
bad_adcdata: not_frame_data	The container objects are not frame data.
incompatible_types	The container objects do not contain the same type.
bad_adcdata	The containers contain adcdata but it is malformed.
incompatible_adc_group	The containers contain AdcData but they have a different group.
incompatible_adc_channel	The containers contain AdcData but they have a different channel.
incompatible_adc_nbits	The containers contain AdcData but they have a different number of bits in the ADC output.
incompatible_channels	The containers contain AdcData but they are for different channels.
incompatible_adc_nbits	The containers contain AdcData but the ADC's which generated the data didn't have the same nBits.
incompatible_adc_bias	The containers contain AdcData but the ADC's which generated the data didn't have the same bias.
incompatible_adc_slope	The containers contain AdcData but the ADC's which generated the data didn't have the same slope.
incompatible_adc_units	The containers contain AdcData but the units are not the same.
incompatible_adc_samplerate	The containers contain AdcData but the sample rate is different.
incompatible_adc_fshift	The containers contain AdcData but the frequency shift is different.
unsupported_adcdata	The containers contain AdcData but one or more of them containe either more than one data vector or a multi-dimensional data vector.
incompatible_adcdata	The containers contain AdcData, however the data in the object has different types (e.g. INT_4U vs. INT_4S), different units, or the beginning of the data in the second container does not correspond to the end of the data in the first container.
incomplete_adcdata	The containers contain AdcData, however the data in the first container does not run until the end of the frame.
memory_allocation_failed	Error allocating memory.
invalid_format: "element" is unexpected type	AdcData element specified by "element" has different type from expected.
invalid_format: "element" not found	AdcData is missing "element".
invalid_format	AdcData is malformed.
SwigException

---

concatAdcDataList_t - Concatenate AdcData -- threaded

---

This command concatenates a list of AdcData objects, creating a new object in the process.

Usage - Basic SWIG interface:
set tid [concatAdcDataList_t ptObjArray]

Parameters:

Name	Type	Description
ptObjArray	vector<LdasContainer*> &	A pointer to a NULL terminated array of ILWD AdcData objects in the C++ layer.

Return value:
tid* tid - A pointer to created thread.

Exceptions:

Exception	Description
SwigException

---

concatFrameList - Concatenate Frames.

---

This command concatenates a list of Frame objects, creating a new object in the process. Caller is responsible for destruction of the result ILWD object.

Usage - Basic SWIG interface:
set ptResult [concatFrameList ptObjArray]

Parameters:

Name	Type	Description
ptObjArray	vector<LdasContainer*> &	A pointer to a NULL terminated array of ILWD Frame objects in the C++ layer.

Return value:
LdasContainer* ptResult - The concatenated object.

Exceptions:

Exception	Description
invalid_ilwd_element	A pointer to the ILWD element is invalid.
invalid_container	One or both of the container objects don't exist.
invalid_frame_object	One or both of the container objects do not contain a frame object.
not_frame	The container objects contain a frame data type other than Frame.
not_frame_data	The container objects are not frame data.
incompatible_frames	The container objects do not contain the same type.
incompatible_frame	The containers contain Frame data, however the data in the object has different types (e.g. INT_4U vs. INT_4S), different units, or the beginning of the data in the second container does not correspond to the end of the data in the first container.
bad_frame	The container object contains a frame data, but this data malformed( such as specified data in the object is missing, or element of the object is empty ).
memory_allocation_failed	Error allocating memory.
invalid_format: "element" is unexpected type	Frame element specified by "element" has different type from expected.
invalid_format: "element" not found	Frame is missing "element".
invalid_format	Frame data is malformed.
SwigException

---

concatFrameList_r - Concatenate Frames - return value

---

This command concatenates a list of Frame objects, creating a new object in the process. Caller is responsible for destruction of the result ILWD object.

Usage - Basic SWIG interface:
set ptResult [concatFrameList_r tid]

Parameters:

Name	Type	Description
tid	tid*	A pointer to a concatFrameList thread.

Return value:
LdasContainer* ptResult - The concatenated object.

Exceptions:

Exception	Description
invalid_ilwd_element	A pointer to the ILWD element is invalid.
invalid_container	One or both of the container objects don't exist.
invalid_frame_object	One or both of the container objects do not contain a frame object.
not_frame	The container objects contain a frame data type other than Frame.
not_frame_data	The container objects are not frame data.
incompatible_frames	The container objects do not contain the same type.
incompatible_frame	The containers contain Frame data, however the data in the object has different types (e.g. INT_4U vs. INT_4S), different units, or the beginning of the data in the second container does not correspond to the end of the data in the first container.
bad_frame	The container object contains a frame data, but this data malformed( such as specified data in the object is missing, or element of the object is empty ).
memory_allocation_failed	Error allocating memory.
invalid_format: "element" is unexpected type	Frame element specified by "element" has different type from expected.
invalid_format: "element" not found	Frame is missing "element".
invalid_format	Frame data is malformed.
SwigException

---

concatFrameList_t - Concatenate Frames - Threaded

---

This command concatenates a list of Frame objects, creating a new object in the process.

Usage - Basic SWIG interface:
set tid [concatFrameList_t ptObjArray]

Parameters:

Name	Type	Description
ptObjArray	vector<LdasContainer *> &	A pointer to a NULL terminated array of ILWD Frame objects in the C++ layer.

Return value:
tid* tid - A pointer to created thread.

Exceptions:

Exception	Description
SwigException

---

concatProcDataList - Concatenate ProcData

---

This command concatenates a list of ProcData objects, creating a new object in the process. Caller is responsible for destruction of the result ILWD object.

Usage - Basic SWIG interface:
set ptResult [concatProcDataList ptObjArray]

Parameters:

Name	Type	Description
ptObjArray	vector<LdasContainer*> &	A pointer to a NULL terminated array of ILWD ProcData objects in the C++ layer.

Return value:
LdasContainer* ptResult - The concatenated object.

Exceptions:

Exception	Description
invalid_ilwd_element	A pointer to the ILWD element is invalid.
invalid_container	One or both of the container objects don't exist.
invalid_frame_object	One or both of the container objects do not contain a frame object.
not_procdata	The container objects contain a frame data type other than ProcData.
not_frame_data	The container objects are not frame data.
incompatible_types	The container objects do not contain the same type.
bad_procdata	The containers contain procdata but it is malformed.
incompatible_channels	The containers contain ProcData but they are for different channels.
incompatible_proc_samplerate	The containers contain ProcData but the sample rate is different.
incompatible_proc_fshift	The containers contain ProcData but the frequency shift is different.
unsupported_data	The containers contain ProcData but one or more of them containe either more than one data vector or a
multi	dimensional data vector.
incompatible_procdata	The containers contain ProcData, however the data in the object has different types (e.g. INT_4U vs. INT_4S), different units, or the beginning of the data in the second container does not correspond to the end of the data in the first container.
incomplete_procdata	The containers contain ProcData, however the data in the first container does not run until the end of the frame.
memory_allocation_failed	Error allocating memory.
invalid_format: "element" is unexpected type	ProcData element specified by "element" has different type from expected.
invalid_format: "element" not found	ProcData is missing "element".
invalid_format	ProcData is malformed.
SwigException

---

concatProcDataList_r - Concatenate ProcData -- get thread result

---

This command concatenates a list of ProcData objects, creating a new object in the process. Caller is responsible for destruction of the result ILWD object.

Usage - Basic SWIG interface:
set ptResult [concatProcDataList_r tid]

Parameters:

Name	Type	Description
tid	tid*	A pointer to a concatProcDataList thread.

Return value:
LdasContainer* ptResult - The concatenated object.

Exceptions:

Exception	Description
invalid_ilwd_element	A pointer to the ILWD element is invalid.
invalid_container	One or both of the container objects don't exist.
invalid_frame_object	One or both of the container objects do not contain a frame object.
not_procdata	The container objects contain a frame data type other than ProcData.
not_frame_data	The container objects are not frame data.
incompatible_types	The container objects do not contain the same type.
bad_procdata	The containers contain procdata but it is malformed.
incompatible_channels	The containers contain ProcData but they are for different channels.
incompatible_proc_samplerate	The containers contain ProcData but the sample rate is different.
incompatible_proc_fshift	The containers contain ProcData but the frequency shift is different.
unsupported_data	The containers contain ProcData but one or more of them containe either more than one data vector or a multi-dimensional data vector.
incompatible_procdata	The containers contain ProcData, however the data in the object has different types (e.g. INT_4U vs. INT_4S), different units, or the beginning of the data in the second container does not correspond to the end of the data in the first container.
incomplete_procdata	The containers contain ProcData, however the datain the first container does not run until the end of the frame.
memory_allocation_failed	Error allocating memory.
invalid_format: "element" is unexpected type	ProcData element specified by "element" has different type from expected.
invalid_format: "element" not found	ProcData is missing "element".
invalid_format	ProcData is malformed.
SwigException

---

concatProcDataList_t - Concatenate ProcData -- threaded

---

This command concatenates a list of ProcData objects, creating a new object in the process.

Usage - Basic SWIG interface:
set tid [concatProcDataList_t ptObjArray]

Parameters:

Name	Type	Description
ptObjArray	vector<LdasContainer*> &	A pointer to a NULL terminated array of ILWD ProcData objects in the C++ layer.

Return value:
tid* tid - A pointer to created thread.

Exceptions:

Exception	Description
SwigException

---

concatSerDataList - Concatenate SerData

---

This command concatenates a list of SerData objects, creating a new object in the process. Caller is responsible for destruction of the result ILWD object.

Usage - Basic SWIG interface:
set ptResult [concatSerDataList ptObjArray]

Parameters:

Name	Type	Description
ptObjArray	vector<LdasContainer*> &	A pointer to a NULL terminated array of ILWD SerData objects in the C++ layer.

Return value:
LdasContainer* ptResult - The concatenated object.

Exceptions:

Exception	Description
invalid_ilwd_element	A pointer to the ILWD element is invalid.
invalid_container	One or both of the container objects don't exist.
invalid_frame_object	One or both of the container objects do not contain a frame object.
not_serdata	The container objects contain a frame data type other than SerData.
not_frame_data	The container objects are not frame data.
incompatible_types	The container objects do not contain the same type.
bad_serdata	The containers contain SerData but it is malformed.
incompatible_channels	The containers contain SerData but they are for different channels.
incompatible_ser_time	The containers contain SerData but the time is different.
incompatible_ser_samplerate	The containers contain SerData but the sample rate is different.
unsupported_data	The containers contain SerData but one or more of them contain either more than one data vector or a multi-dimensional data vector.
incompatible_serdata	The containers contain SerData, however the data in the object has different types (e.g. INT_4U vs. INT_4S), different units, or the beginning of the data in the second container does not correspond to the end of the data in the first container.
incompatible_ser_data	The containers contain SerData but the data is different.
memory_allocation_failed	Error allocating memory.
invalid_format: "element" is unexpected type	SerData element specified by "element" has different type from expected.
invalid_format: "element" not found	SerData is missing "element".
invalid_format	SerData is malformed.
SwigException

---

concatSerDataList_r - Concatenate SerData -- thread return value

---

This command concatenates a list of SerData objects, creating a new object in the process. Caller is responsible for destruction of the result ILWD object.

Usage - Basic SWIG interface:
set ptResult [concatSerDataList_r tid]

Parameters:

Name	Type	Description
tid	tid*	A pointer to a concatSerDataList thread

Return value:
LdasContainer* ptResult - The concatenated object.

Exceptions:

Exception	Description
invalid_ilwd_element	A pointer to the ILWD element is invalid.
invalid_container	One or both of the container objects don't exist.
invalid_frame_object	One or both of the container objects do not contain a frame object.
not_serdata	The container objects contain a frame data type other than SerData.
not_frame_data	The container objects are not frame data.
incompatible_types	The container objects do not contain the same type.
bad_serdata	The containers contain SerData but it is malformed.
incompatible_channels	The containers contain SerData but they are for different channels.
incompatible_ser_time	The containers contain SerData but the time is different.
incompatible_ser_samplerate	The containers contain SerData but the sample rate is different.
unsupported_data	The containers contain SerData but one or more of them contain either more than one data vector or a multi-dimensional data vector.
incompatible_serdata	The containers contain SerData, however the data in the object has different types (e.g. INT_4U vs. INT_4S), different units, or the beginning of the data in the second container does not correspond to the end of the data in the first container.
incompatible_ser_data	The containers contain SerData but the data is different.
memory_allocation_failed	Error allocating memory.
invalid_format: "element" is unexpected type	SerData element specified by "element" has different type from expected.
invalid_format: "element" not found	SerData is missing "element".
invalid_format	SerData is malformed.
SwigException

---

concatSerDataList_t - Concatenate SerData -- threaded

---

This command concatenates a list of SerData objects, creating a new object in the process.

Usage - Basic SWIG interface:
set tid [concatSerDataList_t ptObjArray]

Parameters:

Name	Type	Description
ptObjArray	vector<LdasContainer*> &	A pointer to a NULL terminated array of ILWD SerData objects in the C++ layer.

Return value:
tid* tid - A pointer to created thread.

Exceptions:

Exception	Description
SwigException

---

concatSimDataList - Concatenate SimData

---

This command concatenates a list of SimData objects, creating a new object in the process. Caller is responsible for destruction of the result ILWD object.

Usage - Basic SWIG interface:
set ptResult [concatSimDataList ptObjArray]

Parameters:

Name	Type	Description
ptObjArray	vector<LdasContainer*> &	A pointer to a NULL terminated array of ILWD SimData objects in the C++ layer.

Return value:
LdasContainer* ptResult - The concatenated object.

Exceptions:

Exception	Description
invalid_ilwd_element	A pointer to the ILWD element is invalid.
invalid_container	One or both of the container objects don't exist.
invalid_frame_object	One or both of the container objects do not contain a frame object.
not_simdata	The container objects contain a frame data type other than SimData.
not_frame_data	The container objects are not frame data.
incompatible_types	The container objects do not contain the same type.
bad_simdata	The containers contain SimData but it is malformed.
incompatible_channels	The containers contain SimData but they are for different channels.
incompatible_sim_samplerate	The containers contain SimData but the sample rate is different.
unsupported_data	The containers contain SimData but one or more of them contain either more than one data vector or a multi-dimensional data vector.
incompatible_simdata	The containers contain SimData, however the data in the object has different types (e.g. INT_4U vs. INT_4S), different units, or the beginning of the data in the second container does not correspond to the end of the data in the first container.
memory_allocation_failed	Error allocating memory.
invalid_format: "element" is unexpected type	SimData element specified by "element" has different type from expected.
invalid_format: "element" not found	SimData is missing "element".
invalid_format	SimData is malformed.
SwigException

---

concatSimDataList_r - Concatenate SimData -- get thread result

---

This command concatenates a list of SimData objects, creating a new object in the process. Caller is responsible for destruction of the result ILWD object.

Usage - Basic SWIG interface:
set ptResult [concatSimDataList_r tid]

Parameters:

Name	Type	Description
tid	tid*	A pointer to a concatSimDataList thread.

Return value:
LdasContainer* ptResult - The concatenated object.

Exceptions:

Exception	Description
invalid_ilwd_element	A pointer to the ILWD element is invalid.
invalid_container	One or both of the container objects don't exist.
invalid_frame_object	One or both of the container objects do not contain a frame object.
not_simdata	The container objects contain a frame data type other than SimData.
not_frame_data	The container objects are not frame data.
incompatible_types	The container objects do not contain the same type.
bad_simdata	The containers contain SimData but it is malformed.
incompatible_channels	The containers contain SimData but they are for different channels.
incompatible_sim_samplerate	The containers contain SimData but the sample rate is different.
unsupported_data	The containers contain SimData but one or more of them contain either more than one data vector or a multi-dimensional data vector.
incompatible_simdata	The containers contain SimData, however the data in the object has different types (e.g. INT_4U vs. INT_4S), different units, or the beginning of the data in the second container does not correspond to the end of the data in the first container.
memory_allocation_failed	Error allocating memory.
invalid_format: "element" is unexpected type	SimData element specified by "element" has different type from expected.
invalid_format: "element" not found	SimData is missing "element".
invalid_format	SimData is malformed.
SwigException

---

concatSimDataList_t - Concatenate SimData -- threaded

---

This command concatenates a list of SimData objects, creating a new object in the process.

Usage - Basic SWIG interface:
set tid [concatSimDataList_t ptObjArray]

Parameters:

Name	Type	Description
ptObjArray	vector<LdasContainer*> &	A pointer to a NULL terminated array of ILWD SimData objects in the C++ layer.

Return value:
tid* tid - A pointer to created thread.

Exceptions:

Exception	Description
SwigException

---

createDetector - Create a FrameCPP detector as ILWD container object.

---

This function creates new ILWD container object that represents FrameCPP detector structure. Detector metadata is passed as function arguments.

Parameters:

Name	Type	Description
name	const char*	Detector name.
longitude	double	Detector vertex longitude, degrees.
latitude	double	Detector vertex lattitude, degrees.
elevation	float	Vertex elevation, meters.
armXazimuth	float	Orientation of X arm.
armYazimuth	float	Orientation of Y arm.
armXaltitude	float	Altitude of X arm.
armYaltitude	float	Altitude of Y arm.
armXmidpoint	float	Midpoint of X arm.
armYmidpoint	float	Midpoint of Y arm.
localTime	int	local time offset.
dataQuality	unsigned int	data quality word.
qaBitList	const char*	data quality word definition list.

Return value:
LdasContainer* - A pointer to newly allocated ILWD container object.

Exceptions:

Exception	Description
SwigException
bad_alloc	Memory allocation failed.

---

createFrame - Create an empty FrameCPP Frame as ILWD container object.

---

Usage - Basic SWIG interface:
set ptContainer [ createFrame name run frame gtimes gtimen uleaps dt]

Parameters:

Name	Type	Description
name	const char*	The name for the frame.
run	unsigned int	The run number.
frame	unsigned int	The frame number.
gtimes	unsigned int	The GPS start time of the frame in seconds.
gtimen	unsigned int	The residual nanoseconds to the GPS start time.
uleaps	unsigned short	The integer number of leap seconds between GPS/TAI and UTC.
dt	double	The frame length in seconds.

Return value:
LdasContainer* ptContainer - A pointer to the newly allocated ILWD container object.

Exceptions:

Exception	Description
SwigException
bad_alloc	Memory allocation failed.

---

createHistory - Create a FrameCPP History as ILWD container object.

---

This function creates new ILWD container object that represents FrameCPP History structure. History metadata is passed as function arguments.

Usage - Basic SWIG interface:
set ptContainer [ createHistory name time comment ]

Parameters:

Name	Type	Description
name	const char*	Name of the history record.
time	unsigned int	Time of post-processing. GPS time in integer seconds since GPS standard epoch.
comment	const char*	Program name and relevant comments needed to define post-processing.

Return value:
LdasContainer* ptContainer - A pointer to newly allocated ILWD container object.

Exceptions:

Exception	Description
SwigException
bad_alloc	Memory allocation failed.

---

createMsg - Create a FrameCPP Msg as ILWD container object.

---

This function creates new ILWD container object that represents FrameCPP Msg structure. Msg metadata is passed as function arguments.

Usage - Basic SWIG interface:
set ptContainer [ createMsg alarm message severity ]

Parameters:

Name	Type	Description
alarm	const char*	The name of the message, error flag or alarm state.
message	const char*	The message body.
severity	unsigned int	An integer indicating the message severity level.
gtimes	unsigned int	GPS time seconds.
gtimen	unsigned int	GPS time nanosecond residual.

Return value:
LdasContainer* ptContainer - A pointer to newly allocated ILWD container object.

Exceptions:

Exception	Description
SwigException
bad_alloc	Memory allocation failed.

---

createOuterDetectorProcContainer - Create an empty ILWD container to hold a linked list of FrameCPP ProcDetector data structures.

---

This is a helper function to be used only when genericAPI functions are used to create an ILWD frame object( 'addContainerElement' and so on ). All frameAPI conversion functions will handle this outter layer automatically.

Usage - Basic SWIG interface:
set ptContainer [ createOuterDetectorProcContainer ]

Return value:
LdasContainer* ptContainer - A pointer to newly allocated ILWD container object.

---

createOuterDetectorSimContainer - Create an empty ILWD container to hold a linked list of FrameCPP SimDetector data structures.

---

This is a helper function to be used only when genericAPI functions are used to create an ILWD frame object( 'addContainerElement' and so on ). All frameAPI conversion functions will handle this outter layer automatically.

Usage - Basic SWIG interface:
set ptContainer [ createOuterDetectorSimContainer ]

Return value:
LdasContainer* ptContainer - A pointer to newly allocated ILWD container object.

---

createOuterHistoryContainer - Create an empty ILWD container to hold a linked list of FrameCPP History data structures.

---

This is a helper function to be used only when genericAPI functions are used to create an ILWD frame object( 'addContainerElement' and so on ). All frameAPI conversion functions will handle this outter layer automatically.

Usage - Basic SWIG interface:
set ptContainer [ createOuterHistoryContainer ]

Return value:
LdasContainer* ptContainer - A pointer to newly allocated ILWD container object.

---

createProcData - Create a FrameCPP ProcData as ILWD container object.

---

This function creates new ILWD container object that represents FrameCPP FrProc structure. ProcData metadata is passed as function arguments.

Parameters:

Name	Type	Description
name	const char*	The name for the ProcData.
comment	const char*	Comment.
sampleRate	double	sampling rate.
timeOffsetS	int	time offset second.
timeOffsetN	int	time offset nanoseconds.
fShift	double	frequency shift.
phase	double	phase of heterodyning signal.
gtimes		The GPS start time of the target frame in seconds.
gtimen		The residual nanoseconds to the GPS start time.
dt		The target frame's length in seconds.

Return value:
LdasContainer* - A pointer to newly allocated ILWD container object.

Exceptions:

Exception	Description
SwigException
bad_alloc	Memory allocation failed.

---

createRawData - Create an empty FrameCPP RawData as ILWD container object.

---

This function creates new ILWD container object that represents FrameCPP RawData structure.

Usage - Basic SWIG interface:
set ptContainer [ createRawData name ]

Parameters:

Name	Type	Description
name	const char*	Name of the raw data.

Return value:
LdasContainer* ptContainer - A pointer to newly allocated ILWD container object.

Exceptions:

Exception	Description
SwigException
bad_alloc	Memory allocation failed.

---

createRawFrame - Create a simple template frame.

---

This function creates an empty frame. It copies the header, detector information and history data from passed to it frame.

Usage - Basic SWIG interface:
set ptFrame [createRawFrame ptSourceFrame]

Parameters:

Name	Type	Description
ptSourceFrame	FrameH*	Frame object pointer.

Return value:
FrameH* ptFrame - Newly created raw frame object.

Exceptions:

Exception	Description
bad_alloc	Memory allocation failed.

---

createResampleState - Create resampling state

---

Usage - Basic SWIG interface:
set resampleState [ createResampleState q adcPtr ]

Parameters:

Name	Type	Description
q		downsampling factor
adcPtr		FrameCPP::AdcData object for which resampleState is intended

Return value:
ResampleBase* resampleState - resampling state. Keeps filter history.

Exceptions:

Exception	Description
SwigException

---

destructAdcData - Delete an ADC object from memory.

---

This is only meant to delete the result of getFrameAdcDataSlice, resampleAdcData function calls.

Usage - Basic SWIG interface:
destructADC adcPtr

Parameters:

Name	Type	Description
adcPtr	FrAdcData*	A pointer to an ADC object.

Exceptions:

Exception	Description
invalid_adcdata	The ADC does not exist in the C++ layer.
SwigException

---

destructFrame - Delete a frame object from memory.

---

Usage - Basic SWIG interface:
destructFrame ptFrame

Parameters:

Name	Type	Description
ptFrame	FrameH*	A pointer to a frame object.

Exceptions:

Exception	Description
invalid_frame	The frame does not exist in the C++ layer
SwigException

---

destructProcData - Delete ProcData object from memory.

---

This is only meant to delete the result of getFrameProcDataSlice*, adcPointer2ProcPointer function calls.

Usage - Basic SWIG interface:
destructProcData procPtr

Parameters:

Name	Type	Description
procPtr	FrProcData*	A pointer to ProcData object.

Exceptions:

Exception	Description
invalid_procdata	The ProcData does not exist in the C++ layer.
SwigException

---

destructResampleState - Destroy resampling state

---

Usage - Basic SWIG interface:
destructResampleState resampleState

Parameters:

Name	Type	Description
resampleState	ResampleBase*	resample state returned by createResampleState

Exceptions:

Exception	Description
SwigException

---

dumpFrameCPPRegistry - Display currently registered frameCPP objects.

---

This method is mostly to assist debugging of the API. It displays registered frameCPP objects of these classes: FrameH, FrameFile, AdcData, and ProcData.

---

fullFrame2container - Convert whole FrameCPP Frame into LDAS Container

---

Caller is responsible for destruction of the result ILWD object.

Usage - Basic SWIG interface:
set ptResult [ fullFrame2container frame ]

Parameters:

Name	Type	Description
frame	FrameH*	frame pointer.

Return value:
Ldascontainer* ptResult - newly allocated frame container

Exceptions:

Exception	Description
invalid_frame	frame is not registered .
SwigException

---

fullFrame2container_r - Convert whole FrameCPP Frame into LDAS Container - thread return value

---

Caller is responsible for destruction of the result ILWD object.

Usage - Basic SWIG interface:
set container [fullFrame2container_r tid]

Parameters:

Name	Type	Description
tid	tid*	A pointer to a fullFrame2container thread.

Return value:
Ldascontainer* ptResult - newly allocated frame container.

Exceptions:

Exception	Description
invalid_frame	frame is not registered
SwigException

---

fullFrame2container_t - Convert whole FrameCPP Frame into LDAS Container - Threaded

---

Usage - Basic SWIG interface:
set tid [ fullFrame2container_t frame ]

Parameters:

Name	Type	Description
frame	FrameH*	frame pointer.

Return value:
tid* tid - A pointer to created thread.

Exceptions:

Exception	Description
SwigException

---

getChannelList - Get ADC Channel List

---

Usage - Basic SWIG interface:
set ptVar [getChannelList ptFrame]

Parameters:

Name	Type	Description
ptFrame	const FrameH*	A pointer to a frame object.
ChannelSpecifier	int	An optional argument that specifies the types of channels to return. This value is the ORed value of CHANNEL_ADC, CHANNEL_PROC, CHANNEL_SERIAL, and CHANNEL_SIM. The default for this value is CHANNEL_ADC | CHANNEL_PROC.

Return value:
string ptVar - A TCL list consisting of the channel names of all of the ADC objects contained within the frame.

Exceptions:

Exception	Description
invalid_frame	The frame does not exist in the C++ layer.
SwigException

---

getChannelListFromFrameFile - Get list of channels from frame file.

---

Usage - Basic SWIG interface:
set ptVar [getChannelListFromFrameFile Filename MetaInfo ?ChannelSpecifier? ]

Parameters:

Name	Type	Description
Filename	string	The fully qualified filename
MetaInfo	const int	Flag composed of the oring together of values described in the table below indicating which meta information associated with the channels should be retrieved. Standard meta information is the meta information that can be retieved by reading only the top most Fr structure for the specified channel type. Extended meta information requires the reading of the entire structure including all FrVect structures. This is more costly as some channels may have large data sets. Flag Description META_INFO_ADC Obtain the standard metadata for an FrAdcData structure. META_INFO_PROC Obtain the standard metadata for an FrProcData structure. META_INFO_SIM Obtain the standard metadata for an FrSimEvent structure. META_INFO_SERIAL Obtain the standard metadata for an FrSerData structure. META_INFO_ALL Obtain the standard metadata for all Fr structures listed above. EXTENDED_META_INFO_ADC Obtain the extended metadata for an FrAdcData structure. EXTENDED_META_INFO_PROC Obtain the extended metadata for an FrProcData structure. EXTENDED_META_INFO_SIM Obtain the extended metadata for an FrSimEvent structure. EXTENDED_META_INFO_SERIAL Obtain the extended metadata for an FrSerData structure. EXTENDED_META_INFO_ALL Obtain the extended metadata for all Fr structures listed above.
ChannelSpecifier	int	An optional argument that specifies the types of channels to return. This value is the ORed value of CHANNEL_ADC, CHANNEL_PROC, CHANNEL_SERIAL, and CHANNEL_SIM. The default for this value is CHANNEL_ADC | CHANNEL_PROC.

Return value:
string ptVar - A TCL list consisting of the channel names of all of the ADC objects contained within the frame.

Exceptions:

Exception	Description
invalid_frame	The frame does not exist in the C++ layer.
SwigException

---

getFrameAdcData - Find ADC structure by name or access by index.

---

This function returns a 'shallow' AdcData pointer( a pointer to the data of FrameCPP frame object ).

Usage - Basic SWIG interface:
set adc [ getFrameAdcData frame adcName ]

Parameters:

Name	Type	Description
frame	FrameH*	frame pointer
adcName	char*	channel name or index

Return value:
FrameCPP::FrAdcData* ptResult - adc data pointer.

Exceptions:

Exception	Description
channel_not_found	channel is not found
invalid_frame	Frame object is invalid.
no_raw_data	RawData is not found.
SwigException

---

getFrameAdcDataBias - Get ADC bias.

---

Note: AdcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: AdcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameAdcDataBias adc ]

Parameters:

Name	Type	Description
adc	FrAdcData*	A pointer to the FrameCPP AdcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_adcdata_pointer	AdcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameAdcDataChannelGroup - Get ADC channel group number.

---

Note: AdcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: AdcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameAdcDataChannelGroup adc ]

Parameters:

Name	Type	Description
adc	FrAdcData*	A pointer to the FrameCPP AdcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_adcdata_pointer	AdcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameAdcDataChannelNumber - Get ADC channel number.

---

Note: AdcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: AdcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameAdcDataChannelNumber adc ]

Parameters:

Name	Type	Description
adc	FrAdcData*	A pointer to the FrameCPP AdcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_adcdata_pointer	AdcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameAdcDataComment - Get ADC comment.

---

Note: AdcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: AdcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameAdcDataComment adc ]

Parameters:

Name	Type	Description
adc	FrAdcData*	A pointer to the FrameCPP AdcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_adcdata_pointer	AdcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameAdcDataDataValid - Get ADC data valid flag.

---

Note: AdcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: AdcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameAdcDataDataValid adc ]

Parameters:

Name	Type	Description
adc	FrAdcData*	A pointer to the FrameCPP AdcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_adcdata_pointer	AdcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameAdcDataFShift - Get ADC frequency shift.

---

Note: AdcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: AdcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameAdcDataFShift adc ]

Parameters:

Name	Type	Description
adc	FrAdcData*	A pointer to the FrameCPP AdcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_adcdata_pointer	AdcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameAdcDataNBits - Get ADC's number of bits per sample.

---

Note: AdcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: AdcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameAdcDataNBits adc ]

Parameters:

Name	Type	Description
adc	FrAdcData*	A pointer to the FrameCPP AdcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_adcdata_pointer	AdcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameAdcDataName - Get ADC name.

---

Note: AdcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: AdcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameAdcDataName adc ]

Parameters:

Name	Type	Description
adc	FrAdcData*	A pointer to the FrameCPP AdcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_adcdata_pointer	AdcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameAdcDataNum - Get the number of ADC structures in a frame.

---

Usage - Basic SWIG interface:
set numADCs [ getFrameAdcDataNum frame ]

Parameters:

Name	Type	Description
frame	FrameH*	A pointer to the FrameCPP frame object.

Return value:
unsigned long - Number of ADC structures.

Exceptions:

Exception	Description
invalid_frame	Frame object is invalid.

---

getFrameAdcDataPhase - Get ADC phase at start of dataset.

---

Note: AdcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: AdcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameAdcDataPhase adc ]

Parameters:

Name	Type	Description
adc	FrAdcData*	A pointer to the FrameCPP AdcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_adcdata_pointer	AdcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameAdcDataSampleDt - Get ADC sample delta T.

---

Note: AdcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: AdcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameAdcDataSampleDt adc ]

Parameters:

Name	Type	Description
adc	FrAdcData*	A pointer to the FrameCPP AdcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_adcdata_pointer	AdcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameAdcDataSampleRate - Get ADC sampling rate.

---

Note: AdcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: AdcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameAdcDataSampleRate adc ]

Parameters:

Name	Type	Description
adc	FrAdcData*	A pointer to the FrameCPP AdcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_adcdata_pointer	AdcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameAdcDataSlice - Get a slice of the ADC data.

---

This call is only usefull for longer than one second ADC data structures. It creates new ADC structure, which is not linked to any frame. Function returns newly constructed C++ FrameCPP::AdcData object. User is responsible for the destruction of returned object( 'destructAdcData' ).

Usage - Basic SWIG interface:
set ptResult [ getFrameAdcDataSlice adcPtr offs dT ]

Parameters:

Name	Type	Description
adcPtr	FrAdcData*	source ADC data pointer.
offs	double	positive offset in seconds into the ADC data.
dT	double	delta T for the slice.

Return value:
FrameCPP::FrAdcData* ptResult - a pointer to newly allocated ADC data structure.

Exceptions:

Exception	Description
invalid_offset	Specified offset is not valid for the data contained in the ADC.
invalid_dt	Specified delta time is too long.
bad_alloc	Memory allocation failed.
null adcdata	AdcData pointer is NULL.
SwigException

---

getFrameAdcDataSlope - Get ADC Slope.

---

Note: AdcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: AdcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameAdcDataSlope adc ]

Parameters:

Name	Type	Description
adc	FrAdcData*	A pointer to the FrameCPP AdcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_adcdata_pointer	AdcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameAdcDataTimeOffset - Get ADC time offset.

---

Note: AdcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: AdcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameAdcDataTimeOffset adc ]

Parameters:

Name	Type	Description
adc	FrAdcData*	A pointer to the FrameCPP AdcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_adcdata_pointer	AdcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameAdcDataTimeOffsetN - Get ADC time offset nanoseconds.

---

Note: AdcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: AdcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameAdcDataTimeOffsetN adc ]

Parameters:

Name	Type	Description
adc	FrAdcData*	A pointer to the FrameCPP AdcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_adcdata_pointer	AdcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameAdcDataTimeOffsetS - Get ADC time offset seconds.

---

Note: AdcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: AdcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameAdcDataTimeOffsetS adc ]

Parameters:

Name	Type	Description
adc	FrAdcData*	A pointer to the FrameCPP AdcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_adcdata_pointer	AdcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameAdcDataUnits - Get ADC engineering unit string.

---

Note: AdcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: AdcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameAdcDataUnits adc ]

Parameters:

Name	Type	Description
adc	FrAdcData*	A pointer to the FrameCPP AdcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_adcdata_pointer	AdcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameAttribute - Return an attribute of a frame.

---

Usage - Basic SWIG interface:
foreach {value idx} [getFrameAttribute ptFrame attribute] { break; }

Parameters:

Name	Type	Description
ptFrame	FrameH*	A pointer to a frame object.
attribute	char*	This is the atribute which the user wants to query. It is a somewhat complicated format which I'll describe later. An example is: rawData.adcData{channel="34"}.sampleRate

Return value:
string value - The value of the parameter string idx - the index into the array of matches to the query

Exceptions:

Exception	Description
invalid_frame	The frame does not exist in the C++ layer.
bad_attribute	The requested attribute does not exist.
bad_query	The attribute query is malformed or did not match.
SwigException

---

getFrameAuxNum - Get the number of auxiliary data structures in a frame.

---

Usage - Basic SWIG interface:
set numAux [ getFrameAuxNum frame ]

Parameters:

Name	Type	Description
frame	FrameH*	A pointer to the FrameCPP frame object

Return value:
unsigned long - Number of Aux structures.

Exceptions:

Exception	Description
invalid_frame	Frame object is invalid.

---

getFrameData - Return frame data.

---

The data is converted into the internal light-weight data format.

Usage - Basic SWIG interface:
foreach {ptElement idx} [getFrameData $ptFrame query] { break; }

Parameters:

Name	Type	Description
ptFrame	FrameH*	A pointer to a frame object.
query	const char*	This is an identifier for which data the user wants to obtain. Like the attribute parameter for 'getFrameAttribute', it is a somewhat complicated format which I'll describe later. An example is: rawData.adcData{name="IFO_MCR"}

Return value:
string ptElement - A pointer to an LdasElement instantiated in the C++ layer. This element contains the requested data. The name field contains information about which structure (in the frame) the data came from. string idx - The index into the array of ptElements which satisfied the query

Exceptions:

Exception	Description
invalid_frame	The frame does not exist in the C++ layer.
bad_query	The query is malformed or did not match.
SwigException

---

getFrameDetectorArmXaltitude - Get Detector altitude angle of arm X.

---

Note: Detector object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Detector pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameDetectorArmXaltitude detector ]

Parameters:

Name	Type	Description
detector	FrDetector*	A pointer to the FrameCPP Detector object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_detector_pointer	Detector object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameDetectorArmXazimuth - Get Detector orientation of arm X.

---

Note: Detector object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Detector pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameDetectorArmXazimuth detector ]

Parameters:

Name	Type	Description
detector	FrDetector*	A pointer to the FrameCPP Detector object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_detector_pointer	Detector object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameDetectorArmXmidpoint - Get Detector midpoint of arm X.

---

Note: Detector object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Detector pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameDetectorArmXmidpoint detector ]

Parameters:

Name	Type	Description
detector	FrDetector*	A pointer to the FrameCPP Detector object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_detector_pointer	Detector object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameDetectorArmYaltitude - Get Detector altitude angle of arm Y.

---

Note: Detector object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Detector pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameDetectorArmYaltitude detector ]

Parameters:

Name	Type	Description
detector	FrDetector*	A pointer to the FrameCPP Detector object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_detector_pointer	Detector object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameDetectorArmYazimuth - Get Detector orientation of arm Y.

---

Note: Detector object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Detector pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameDetectorArmYazimuth detector ]

Parameters:

Name	Type	Description
detector	FrDetector*	A pointer to the FrameCPP Detector object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_detector_pointer	Detector object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameDetectorArmYmidpoint - Get Detector midpoint of arm Y.

---

Note: Detector object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Detector pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameDetectorArmYmidpoint detector ]

Parameters:

Name	Type	Description
detector	FrDetector*	A pointer to the FrameCPP Detector object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_detector_pointer	Detector object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameDetectorDataQuality - Get Detector's dataQuality word.

---

Note: Detector object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Detector pointer becomes invalid if frame object it's referencing to gets destructed. NOTE: This call is now depricated as of version 6 of the frame specification. .

Usage - Basic SWIG interface:
set ptElement [ getFrameDetectorDataQuality detector ]

Parameters:

Name	Type	Description
detector	FrDetector*	A pointer to the FrameCPP Detector object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_detector_pointer	Detector object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameDetectorElevation - Get Detector vertex elevation.

---

Note: Detector object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Detector pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameDetectorElevation detector ]

Parameters:

Name	Type	Description
detector	FrDetector*	A pointer to the FrameCPP Detector object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_detector_pointer	Detector object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameDetectorLatitude - Get Detector vertex latitude (degrees).

---

Note: Detector object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Detector pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameDetectorLatitudeD detector ]

Parameters:

Name	Type	Description
detector	FrDetector*	A pointer to the FrameCPP Detector object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_detector_pointer	Detector object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameDetectorLocalTime - Get Detector's localTime offset.

---

Note: Detector object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Detector pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameDetectorLocalTime detector ]

Parameters:

Name	Type	Description
detector	FrDetector*	A pointer to the FrameCPP Detector object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_detector_pointer	Detector object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameDetectorLongitude - Get Detector vertex longitude (degrees).

---

Note: Detector object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Detector pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameDetectorLongitudeD detector ]

Parameters:

Name	Type	Description
detector	FrDetector*	A pointer to the FrameCPP Detector object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_detector_pointer	Detector object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameDetectorName - Get Detector name.

---

Note: Detector object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Detector pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameDetectorName detector ]

Parameters:

Name	Type	Description
detector	FrDetector*	A pointer to the FrameCPP Detector object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_detector_pointer	Detector object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameDetectorProc - Find frame detector structure by name of access by index.

---

This function returns a 'shallow' Detector pointer( a pointer to the data of FrameCPP frame object ).

NOTE: This pointer is only valid while the frame file is open. Anotherwords, open the frame file, read the detector stucture, do any processing or converting, and then close the frame file.

Usage - Basic SWIG interface:
set ptDetector [ getFrameDetectorProc frame ]

Parameters:

Name	Type	Description
frame	FrameH*	frame pointer
detectorName	char*	Detector name or index.

Return value:
FrDetector* - A pointer to the Detector structure.

Exceptions:

Exception	Description
invalid_frame	Frame object is invalid.
detectorProc_not_found	Detector structure is not found

---

getFrameDetectorProcNum - Get the number of detector structures in a frame.

---

Usage - Basic SWIG interface:
set numDetectProcs [ getFrameDetectorProcNum frame ]

Parameters:

Name	Type	Description
frame	FrameH*	A pointer to the FrameCPP frame object

Return value:
unsigned long - Number of Detector structures.

Exceptions:

Exception	Description
invalid_frame	Frame object is invalid.

---

getFrameDetectorQaBitList - Get Detector's data quality descriptor list.

---

Note: Detector object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: NOTE: This call is now depricated as of version 6 of the frame specification. . Detector pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameDetectorQaBitList detector ]

Parameters:

Name	Type	Description
detector	FrDetector*	A pointer to the FrameCPP Detector object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_detector_pointer	Detector object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameDetectorSim - Find frame simulation detector structure by name of access by index.

---

This function returns a 'shallow' Detector pointer( a pointer to the data of FrameCPP frame object ).

NOTE: This pointer is only valid while the frame file is open. Anotherwords, open the frame file, read the detector stucture, do any processing or converting, and then close the frame file.

Usage - Basic SWIG interface:
set ptDetector [ getFrameDetectorSim frame ]

Parameters:

Name	Type	Description
frame	FrameH*	frame pointer
detectorName	char*	Detector name or index.

Return value:
FrDetector* - A pointer to the Detector structure.

Exceptions:

Exception	Description
invalid_frame	Frame object is invalid.
detectorSim_not_found	Simulated detector structure is not found

---

getFrameDetectorSimNum - Get the number of simulated detector structures in a frame.

---

Usage - Basic SWIG interface:
set numDetectSims [ getFrameDetectorSimNum frame ]

Parameters:

Name	Type	Description
frame	FrameH*	A pointer to the FrameCPP frame object

Return value:
unsigned long - Number of simulated detectors.

Exceptions:

Exception	Description
invalid_frame	Frame object is invalid.

---

getFrameDictionary - Get FrameCPP dictionary info.

---

Usage - Basic SWIG interface:
set str [ getFrameDictionary ]

Return value:
string -

Exceptions:

Exception	Description
	None.

---

getFrameEvent - Find Event structure by name or access by index.

---

This function returns a 'shallow' Event pointer( a pointer to the data of FrameCPP frame object ).

Usage - Basic SWIG interface:
set proc [ getFrameEvent frame eventName ]

Parameters:

Name	Type	Description
frame	FrameH*	frame pointer.
eventName	char*	Event name or index.

Return value:
FrameCPP::FrEvent* ptResult - Event pointer.

Exceptions:

Exception	Description
event_not_found	EventData channel is not found.
invalid_frame	Frame object is invalid.
SwigException

---

getFrameEventAmplitude - Get Event amplitude.

---

Note: Event object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Event pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameEventAmplitude event ]

Parameters:

Name	Type	Description
event	FrEvent*	A pointer to the FrameCPP Event object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_event_pointer	Event object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameEventComment - Get Event comment.

---

Note: Event object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Event pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameEventComment event ]

Parameters:

Name	Type	Description
event	FrEvent*	A pointer to the FrameCPP Event object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_event_pointer	Event object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameEventEventStatus - Get Event eventStatus.

---

Note: Event object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Event pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameEventEventStatus event ]

Parameters:

Name	Type	Description
event	FrEvent*	A pointer to the FrameCPP Event object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_event_pointer	Event object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameEventGTime - Get Event's "maximum of event" time.

---

Note: Event object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Event pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameEventGTime event ]

Parameters:

Name	Type	Description
event	FrEvent*	A pointer to the FrameCPP Event object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_event_pointer	Event object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameEventInputs - Get Event inputs.

---

Note: Event object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Event pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameEventInputs event ]

Parameters:

Name	Type	Description
event	FrEvent*	A pointer to the FrameCPP Event object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_event_pointer	Event object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameEventNParam - Get Event number of additional event parameters.

---

Note: Event object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Event pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameEventNParam event ]

Parameters:

Name	Type	Description
event	FrEvent*	A pointer to the FrameCPP Event object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_event_pointer	Event object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameEventName - Get Event name.

---

Note: Event object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Event pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameEventName event ]

Parameters:

Name	Type	Description
event	EventData*	A pointer to the FrameCPP Event object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_event_pointer	Event object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameEventNum - Get the number of Event structures in a frame.

---

Usage - Basic SWIG interface:
set numEventStructs [ getFrameEventNum frame ]

Parameters:

Name	Type	Description
frame	FrameH*	A pointer to the FrameCPP frame object

Return value:
unsigned long - Number of Event structures..

Exceptions:

Exception	Description
invalid_frame	Frame object is invalid.

---

getFrameEventParameterNames - Get Event parameter Name at offset x.

---

Note: Event object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Event pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameEventParameterNames event index ]

Parameters:

Name	Type	Description
event	FrEvent*	A pointer to the FrameCPP Event object.
index	INT_2U	Index of parameter name to get

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_event_pointer	Event object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameEventParameters - Get Event parameter at offset x.

---

Note: Event object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Event pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameEventParameters event index ]

Parameters:

Name	Type	Description
event	FrEvent*	A pointer to the FrameCPP Event object.
index	INT_2U	Index of parameter to get

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_event_pointer	Event object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameEventProbability - Get Event probability.

---

Note: Event object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Event pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameEventProbability event ]

Parameters:

Name	Type	Description
event	FrEvent*	A pointer to the FrameCPP Event object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_event_pointer	Event object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameEventStatistics - Get Event statistics.

---

Note: Event object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Event pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameEventStatistics event ]

Parameters:

Name	Type	Description
event	FrEvent*	A pointer to the FrameCPP Event object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_event_pointer	Event object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameEventTimeAfter - Get Event timeAfter.

---

Note: Event object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Event pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameEventTimeAfter Event ]

Parameters:

Name	Type	Description
event	FrEvent*	A pointer to the FrameCPP Event object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_event_pointer	Event object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameEventTimeBefore - Get Event timeBefore.

---

Note: Event object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Event pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameEventTimeBefore event ]

Parameters:

Name	Type	Description
event	FrEvent*	A pointer to the FrameCPP Event object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_event_pointer	Event object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameFrameH - Convert FrameCPP Frame Header into LDAS Container History and Detector structures are included too.

---

Caller is responsible for destruction of the result ILWD object.

Usage - Basic SWIG interface:
set ptResult [ getFrameFrameH frame ]

Parameters:

Name	Type	Description
frame	FrameH*	frame pointer.

Return value:
Ldascontainer* ptResult - newly allocated frame container.

Exceptions:

Exception	Description
invalid_frame	frame is not registered
SwigException

---

getFrameFrameHDataQuality - Get frame dataQuality

---

Usage - Basic SWIG interface:
set ptElement [ getFrameFrameHDataQuality frame ]

Parameters:

Name	Type	Description
frame	FrameH*	A pointer to the frame object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
invalid_frame	Frame object is invalid.
bad_alloc	Memory allocation failed.

---

getFrameFrameHDt - Get frame period (delta t or Dt)

---

Usage - Basic SWIG interface:
set ptElement [ getFrameFrameHDt frame ]

Parameters:

Name	Type	Description
frame	FrameH*	A pointer to the frame object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
invalid_frame	Frame object is invalid.
bad_alloc	Memory allocation failed.

---

getFrameFrameHFrame - Get frame "frame number"

---

Usage - Basic SWIG interface:
set ptElement [ getFrameFrameHFrame frame ]

Parameters:

Name	Type	Description
frame	FrameH*	A pointer to the FrameCPP frame object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
invalid_frame	Frame object is invalid.
bad_alloc	Memory allocation failed.

---

getFrameFrameHGTime - Get frame GPS time.

---

Usage - Basic SWIG interface:
set ptElement [ getFrameFrameHGTime frame ]

Parameters:

Name	Type	Description
frame	FrameH*	A pointer to the frame object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
invalid_frame	Frame object is invalid.
bad_alloc	Memory allocation failed.

---

getFrameFrameHName - Get frame name.

---

Usage - Basic SWIG interface:
set ptElement [ getFrameFrameHName frame ]

Parameters:

Name	Type	Description
frame	FrameH*	A pointer to the FrameCPP frame object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
invalid_frame	Frame object is invalid.
bad_alloc	Memory allocation failed.

---

getFrameFrameHRun - Get frame run number.

---

Usage - Basic SWIG interface:
set ptElement [ getFrameFrameHRun frame ]

Parameters:

Name	Type	Description
frame	FrameH*	A pointer to the FrameCPP frame object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
invalid_frame	Frame object is invalid.
bad_alloc	Memory allocation failed.

---

getFrameFrameHULeapS - Get frame leap seconds.

---

Usage - Basic SWIG interface:
set ptElement [ getFrameFrameHULeapS frame ]

Parameters:

Name	Type	Description
frame	FrameH*	A pointer to the frame object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
invalid_frame	Frame object is invalid.
bad_alloc	Memory allocation failed.

---

getFrameHistory - Find History structure by name or access by index.

---

This function returns a 'shallow' History pointer( a pointer to the data of FrameCPP frame object ).

Usage - Basic SWIG interface:
set ptResult [ getFrameHistory frame historyName ]

Parameters:

Name	Type	Description
frame	FrameH*	frame pointer.
historyName	char*	History name or index.

Return value:
FrameCPP::FrHistory* ptResult - History structure pointer.

Exceptions:

Exception	Description
history_not_found	History record was not found.
invalid_frame	Frame object is invalid.
SwigException

---

getFrameHistoryComment - Get History comment.

---

Note: History object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: History pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameHistoryComment hist ]

Parameters:

Name	Type	Description
hist	FrHistory*	A pointer to the FrameCPP History object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_history_pointer	History object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameHistoryName - Get History name.

---

Note: History object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: History pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameHistoryName hist ]

Parameters:

Name	Type	Description
hist	FrHistory*	A pointer to the FrameCPP History object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_history_pointer	History object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameHistoryNum - Get the number of history data structures in a frame.

---

Usage - Basic SWIG interface:
set numHist [ getFrameHistoryNum frame ]

Parameters:

Name	Type	Description
frame	FrameH*	A pointer to the FrameCPP frame object.

Return value:
unsigned long - Number of History structures.

Exceptions:

Exception	Description
invalid_frame	Frame object is invalid.

---

getFrameHistoryTime - Get History time.

---

Note: History object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: History pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameHistoryTime hist ]

Parameters:

Name	Type	Description
hist	FrHistory*	A pointer to the FrameCPP History object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_history_pointer	History object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameMsg - Find Msg structure by name or access by index.

---

This function returns a 'shallow' Msg pointer( a pointer to the data of FrameCPP frame object ).

Usage - Basic SWIG interface:
set msg [ getFrameMsg frame msgName ]

Parameters:

Name	Type	Description
frame	FrameH*	frame pointer
msgName	char*	message name or index

Return value:
FrameCPP::FrMsg* ptResult - Msg pointer.

Exceptions:

Exception	Description
msg_not_found	channel is not found
invalid_frame	Frame object is invalid.
no_raw_data	RawData is not found.
SwigException

---

getFrameMsgAlarm - Get Msg alarm (name of message).

---

Note: Msg object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Msg pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameMsgAlarm msg ]

Parameters:

Name	Type	Description
msg	FrMsg*	A pointer to the FrameCPP Msg object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_msg_pointer	Msg object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameMsgGTime - Get Msg GPS time.

---

Note: Msg object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Msg pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameMsgGTime msg ]

Parameters:

Name	Type	Description
msg	FrMsg*	A pointer to the FrameCPP Msg object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_msg_pointer	Msg object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameMsgMessage - Get Msg message.

---

Note: Msg object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Msg pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameMsgMessage msg ]

Parameters:

Name	Type	Description
msg	FrameCPP::FrMsg*	A pointer to the FrameCPP Msg object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_msg_pointer	Msg object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameMsgNum - Get the number of Msg structures in a frame.

---

Usage - Basic SWIG interface:
set numMsg [ getFrameMsgNum frame ]

Parameters:

Name	Type	Description
frame	FrameH*	A pointer to the FrameCPP frame object.

Return value:
unsigned long - Number of Msg structures.

Exceptions:

Exception	Description
invalid_frame	Frame object is invalid.

---

getFrameMsgSeverity - Get Msg severity.

---

Note: Msg object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Msg pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameMsgSeverity msg ]

Parameters:

Name	Type	Description
msg	FrMsg*	A pointer to the FrameCPP Msg object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_msg_pointer	Msg object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameNumber - Read the number of frames from the TOC structure

---

Usage - Basic SWIG interface:
set ifnum [getFrameNumber ptFrameFile]

Parameters:

Name	Type	Description
ptFrameFile	FrameFile*	A pointer to a frame file object in the C++ layer. This object must have been created via the openFrameFile command.

Return value:
INT_4U - Integer number, the number of frames in the file.

Exceptions:

Exception	Description
invalid_frame_file	The pointer is invalid (it does not point to a valid object in the C++ layer).
read_failure

---

getFrameProcData - Find ProcData structure by name or access by index.

---

This function returns a 'shallow' ProcData pointer( a pointer to the data of FrameCPP frame object ).

Usage - Basic SWIG interface:
set proc [ getFrameProc frame procName ]

Parameters:

Name	Type	Description
frame	FrameH*	frame pointer.
procName	char*	procData channel name or index.

Return value:
FrameCPP::FrProcData* ptResult - procData pointer.

Exceptions:

Exception	Description
procdata_not_found	ProcData channel is not found
invalid_frame	Frame object is invalid.
SwigException

---

getFrameProcDataAuxParam - Get ProcData auxParam at offset x.

---

Note: ProcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: ProcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameProcDataAuxParameters procdata index ]

Parameters:

Name	Type	Description
procdata	FrProcData*	A pointer to the FrameCPP ProcData object.
index	INT_2U	Index of auxParam to get

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_procdata_pointer	ProcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameProcDataAuxParamNames - Get ProcData auxParam Name at offset x.

---

Note: ProcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: ProcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameProcDataAuxParameterNames procdata index ]

Parameters:

Name	Type	Description
procdata	FrProcData*	A pointer to the FrameCPP ProcData object.
index	INT_2U	Index of auxParam name to get

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_procdata_pointer	ProcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameProcDataBW - Get ProcData BW at start of dataset.

---

Note: ProcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: ProcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameProcDataBW proc ]

Parameters:

Name	Type	Description
proc	FrProcData*	A pointer to the FrameCPP ProcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_procdata_pointer	ProcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameProcDataComment - Get ProcData comment.

---

Note: ProcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: ProcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameProcDataComment proc ]

Parameters:

Name	Type	Description
proc	FrProcData*	A pointer to the FrameCPP ProcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_procdata_pointer	ProcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameProcDataFRange - Get ProcData frequency range.

---

Note: ProcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: ProcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameProcDataFRange proc ]

Parameters:

Name	Type	Description
proc	FrProcData*	A pointer to the FrameCPP ProcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_procdata_pointer	ProcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameProcDataFShift - Get ProcData frequency shift.

---

Note: ProcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: ProcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameProcDataFShift proc ]

Parameters:

Name	Type	Description
proc	FrProcData*	A pointer to the FrameCPP ProcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_procdata_pointer	ProcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameProcDataNAuxParam - Get ProcData number of additional procdata parameter.s

---

Note: ProcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: ProcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameProcDataNAuxParam procdata ]

Parameters:

Name	Type	Description
procdata	FrProcData*	A pointer to the FrameCPP ProcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_procdata_pointer	ProcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameProcDataName - Get ProcData name.

---

Note: ProcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: ProcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameProcDataName proc ]

Parameters:

Name	Type	Description
proc	FrProcData*	A pointer to the FrameCPP ProcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_procdata_pointer	ProcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameProcDataNum - Get the number of procesed data structures in a frame.

---

Usage - Basic SWIG interface:
set numProc [ getFrameProcDataNum frame ]

Parameters:

Name	Type	Description
frame	FrameH*	A pointer to the FrameCPP frame object

Return value:
unsigned long - Number of ProcData structures..

Exceptions:

Exception	Description
invalid_frame	Frame object is invalid.

---

getFrameProcDataPhase - Get ProcData phase at start of dataset.

---

Note: ProcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: ProcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameProcDataPhase proc ]

Parameters:

Name	Type	Description
proc	FrProcData*	A pointer to the FrameCPP ProcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_procdata_pointer	ProcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameProcDataSlice - Get a slice of the Proc data.

---

It creates new ProcData structure, which is not linked to any frame. Function returns newly constructed C++ FrameCPP::ProcData object. User is responsible for the destruction of returned object( 'destructProcData' ).

Usage - Basic SWIG interface:
set ptResult [ getFrameProcDataSlice procPtr offs length ]

Parameters:

Name	Type	Description
procPtr	FrProcData*	Source ProcData data pointer.
offset	double	Offset into the ADC data.
delta	double	Slice data length.

Return value:
FrameCPP::FrProcData* ptResult - a pointer to newly allocated ProcData data structure.

Exceptions:

Exception	Description
invalid_offset	Specified offset is not valid for the data contained in the ProcData.
invalid_length	Specified length is too long.
std::bad_alloc	Memory allocation failed.
null procdata	ProcData pointer is NULL.
SwigException

---

getFrameProcDataSliceIndex - Get a slice of the Proc data.

---

It creates new ProcData structure, which is not linked to any frame. Function returns newly constructed C++ FrameCPP::ProcData object. User is responsible for the destruction of returned object( 'destructProcData' ).

Usage - Basic SWIG interface:
set ptResult [ getFrameProcDataSliceIndex procPtr offs length ]

Parameters:

Name	Type	Description
procPtr	FrProcData*	source ProcData data pointer.
offs	unsigned int	index into the ADC data.
length	unsigned int	slice data length.

Return value:
FrameCPP::FrProcData* ptResult - a pointer to newly allocated ProcData data structure.

Exceptions:

Exception	Description
std::bad_alloc	Memory allocation failed.
null procdata	ProcData pointer is NULL.
invalid_offset	Specified offset is not valid for the data contained in the ProcData.
invalid_length	Specified length is too long.
SwigException

---

getFrameProcDataSubType - Get ProcData subType.

---

Note: ProcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: ProcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameProcDataSubType proc ]

Parameters:

Name	Type	Description
proc	FrProcData*	A pointer to the FrameCPP ProcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_procdata_pointer	ProcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameProcDataTRange - Get ProcData time range.

---

Note: ProcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: ProcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameProcDataTRange proc ]

Parameters:

Name	Type	Description
proc	FrProcData*	A pointer to the FrameCPP ProcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_procdata_pointer	ProcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameProcDataTimeOffset - Get ProcData time offset.

---

Note: ProcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: ProcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameProcDataTimeOffset proc ]

Parameters:

Name	Type	Description
proc	FrProcData*	A pointer to the FrameCPP ProcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_procdata_pointer	ProcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameProcDataType - Get ProcData type.

---

Note: ProcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: ProcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameProcDataType proc ]

Parameters:

Name	Type	Description
proc	FrProcData*	A pointer to the FrameCPP ProcData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_procdata_pointer	ProcData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameSerData - Find Serial Data structure by name or access by index.

---

This function returns a 'shallow' SerData pointer( a pointer to the data of FrameCPP frame object ).

Usage - Basic SWIG interface:
set adc [ getFrameSerData frame serName ]

Parameters:

Name	Type	Description
frame	FrameH*	frame pointer
serName	char*	channel name or index

Return value:
FrameCPP::FrSerData* ptResult - serial data pointer.

Exceptions:

Exception	Description
serdata_not_found	channel is not found
invalid_frame	Frame object is invalid.
no_raw_data	RawData is not found.
SwigException

---

getFrameSerDataData - Get Serial Data Data.

---

Note: SerData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: SerData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameSerDataData ser ]

Parameters:

Name	Type	Description
ser	FrSerData*	A pointer to the FrameCPP SerData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_serdata_pointer	SerData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameSerDataName - Get Serial Data name.

---

Note: SerData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: SerData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameSerDataName ser ]

Parameters:

Name	Type	Description
ser	FrSerData*	A pointer to the FrameCPP SerData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_serdata_pointer	SerData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameSerDataNum - Get the number of Serial data structures in a frame.

---

Usage - Basic SWIG interface:
set numSerial [ getFrameSerDataNum frame ]

Parameters:

Name	Type	Description
frame	FrameH*	A pointer to the FrameCPP frame object.

Return value:
unsigned long - Number of SerData structures.

Exceptions:

Exception	Description
invalid_frame	Frame object is invalid.

---

getFrameSerDataSampleRate - Get Serial Data sampling rate.

---

Note: SerData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: SerData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameSerDataSampleRate ser ]

Parameters:

Name	Type	Description
ser	FrSerData*	A pointer to the FrameCPP SerData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_serdata_pointer	SerData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameSerDataTime - Get Serial Data acquisition time.

---

Note: SerData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: SerData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameSerDataTime ser ]

Parameters:

Name	Type	Description
ser	FrSerData*	A pointer to the FrameCPP SerData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_serdata_pointer	SerData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameSimData - Find SimData structure by name or access by index.

---

This function returns a 'shallow' SimData pointer( a pointer to the data of FrameCPP frame object ).

Usage - Basic SWIG interface:
set proc [ getFrameSimData frame simName ]

Parameters:

Name	Type	Description
frame	FrameH*	frame pointer.
simName	char*	SimData name or index.

Return value:
FrameCPP::FrSimData* ptResult - SimData pointer.

Exceptions:

Exception	Description
simdata_not_found	SimData channel is not found.
invalid_frame	Frame object is invalid.
SwigException

---

getFrameSimDataComment - Get SimData comment.

---

Note: SimData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: SimData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameSimDataComment sim ]

Parameters:

Name	Type	Description
sim	FrSimData*	A pointer to the FrameCPP SimData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_simdata_pointer	SimData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameSimDataFShift - Get SimData frequency shift.

---

Note: SimData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: SimData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameSimDataFShift sim ]

Parameters:

Name	Type	Description
sim	FrSimData*	A pointer to the FrameCPP SimData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_simdata_pointer	SimData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameSimDataName - Get SimData name.

---

Note: SimData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: SimData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameSimDataName sim ]

Parameters:

Name	Type	Description
sim	FrSimData*	A pointer to the FrameCPP SimData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_simdata_pointer	SimData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameSimDataNum - Get the number of simulation data structures in a frame.

---

Usage - Basic SWIG interface:
set numSimData [ getFrameSimDataNum frame ]

Parameters:

Name	Type	Description
frame	FrameH*	A pointer to the FrameCPP frame object

Return value:
unsigned long - Number of SimData structures..

Exceptions:

Exception	Description
invalid_frame	Frame object is invalid.

---

getFrameSimDataPhase - Get SimData phase at start of dataset.

---

Note: SimData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: SimData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameSimDataPhase sim ]

Parameters:

Name	Type	Description
sim	FrSimData*	A pointer to the FrameCPP SimData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_simdata_pointer	SimData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameSimDataSampleRate - Get SimData sampling rate.

---

Note: SimData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: SimData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameSimDataSampleRate sim ]

Parameters:

Name	Type	Description
sim	FrSimData*	A pointer to the FrameCPP SimData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_simdata_pointer	SimData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameSimEvent - Find SimEvent structure by name or access by index.

---

This function returns a 'shallow' SimEvent pointer( a pointer to the data of FrameCPP frame object ).

Usage - Basic SWIG interface:
set proc [ getFrameSimEvent frame simName ]

Parameters:

Name	Type	Description
frame	FrameH*	frame pointer.
simName	char*	SimEvent name or index.

Return value:
FrameCPP::FrSimEvent* ptResult - SimEvent pointer.

Exceptions:

Exception	Description
simevent_not_found	SimEvent channel is not found.
invalid_frame	Frame object is invalid.
SwigException

---

getFrameSimEventAmplitude - Get SimEvent amplitude.

---

Note: SimEvent object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: SimEvent pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameSimEventAmplitude sim ]

Parameters:

Name	Type	Description
sim	FrSimEvent*	A pointer to the FrameCPP SimEvent object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_simevent_pointer	SimEvent object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameSimEventComment - Get SimEvent comment.

---

Note: SimEvent object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: SimEvent pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameSimEventComment sim ]

Parameters:

Name	Type	Description
sim	FrSimEvent*	A pointer to the FrameCPP SimEvent object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_simevent_pointer	SimEvent object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameSimEventGTime - Get SimEvent maximum of event time.

---

Note: SimEvent object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: SimEvent pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameSimEventGTime sim ]

Parameters:

Name	Type	Description
sim	FrSimEvent*	A pointer to the FrameCPP SimEvent object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_simevent_pointer	SimEvent object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameSimEventInputs - Get SimEvent inputs.

---

Note: SimEvent object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: SimEvent pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameSimEventInputs sim ]

Parameters:

Name	Type	Description
sim	FrSimEvent*	A pointer to the FrameCPP SimEvent object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_simevent_pointer	SimEvent object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameSimEventNParam - Get SimEvent number of additional event parameters.

---

Note: SimEvent object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: SimEvent pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameSimEventNParam event ]

Parameters:

Name	Type	Description
event	FrSimEvent*	A pointer to the FrameCPP SimEvent object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_event_pointer	SimEvent object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameSimEventName - Get SimEvent name.

---

Note: SimEvent object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: SimEvent pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameSimEventName sim ]

Parameters:

Name	Type	Description
sim	FrSimEvent*	A pointer to the FrameCPP SimEvent object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_simevent_pointer	SimEvent object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameSimEventNum - Get the number of SimEvent data structures in a frame.

---

Usage - Basic SWIG interface:
set numSimEventStructs [ getFrameSimEventNum frame ]

Parameters:

Name	Type	Description
frame	FrameH*	A pointer to the FrameCPP frame object

Return value:
unsigned long - Number of SimEvent structures.

Exceptions:

Exception	Description
invalid_frame	Frame object is invalid.

---

getFrameSimEventParameterNames - Get SimEvent parameter Name at offset x.

---

Note: SimEvent object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: SimEvent pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameSimEventParameterNames event index ]

Parameters:

Name	Type	Description
event	FrSimEvent*	A pointer to the FrameCPP SimEvent object.
index	INT_2U	Index of parameter name to get

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_event_pointer	SimEvent object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameSimEventParameters - Get SimEvent parameter at offset x.

---

Note: SimEvent object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: SimEvent pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameSimEventParameters event index ]

Parameters:

Name	Type	Description
event	FrSimEvent*	A pointer to the FrameCPP SimEvent object.
index	INT_2U	Index of parameter to get

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_event_pointer	SimEvent object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameSimEventTimeAfter - Get SimEvent timeAfter.

---

Note: SimEvent object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: SimEvent pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameSimEventTimeAfter sim ]

Parameters:

Name	Type	Description
sim	FrSimEvent*	A pointer to the FrameCPP SimEvent object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_simevent_pointer	SimEvent object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameSimEventTimeBefore - Get SimEvent timeBefore.

---

Note: SimEvent object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: SimEvent pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameSimEventTimeBefore sim ]

Parameters:

Name	Type	Description
sim	FrSimEvent*	A pointer to the FrameCPP SimEvent object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_simevent_pointer	SimEvent object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameStatData - Find StatData structure by name or by index.

---

Usage - Basic SWIG interface:
set nFound [ getFrameStat detector statName representation pointerList ]

Parameters:

Name	Type	Description
detector	FrDetector*	Pointer to detector, whose static data is needed.
statName	char*	Static Data structure name to search for or the index (representation is ignored then).
representation	char*	Static Data structure representation to search for.
pointerList	vector<StatData *> &	- value result; list of all Statics matched. These StatData pointers are shallow: pointers to the data of Detector object.

Return value:
int result - number of structures found.

Exceptions:

Exception	Description
SwigException
null_detector_pointer	Detector object is NULL.

---

getFrameStatDataComment - Get Static Data Structure comment string.

---

Note: StatData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: StatData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameStatDataComment stat ]

Parameters:

Name	Type	Description
stat	FrStatData*	A pointer to the FrameCPP StatData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_statdata_pointer	StatData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameStatDataName - Get Static Data Structure name.

---

Note: StatData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: StatData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameStatDataName stat ]

Parameters:

Name	Type	Description
stat	FrStatData*	A pointer to the FrameCPP StatData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_statdata_pointer	StatData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameStatDataRepresentation - Get Static Data Structure representation string.

---

Note: StatData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: StatData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameStatDataRepresentation stat ]

Parameters:

Name	Type	Description
stat	FrStatData*	A pointer to the FrameCPP StatData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_statdata_pointer	StatData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameStatDataTimeEnd - Get Static Data Structure timeEnd variable.

---

Note: StatData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: StatData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameStatDataTimeEnd start ]

Parameters:

Name	Type	Description
stat	FrStatData*	A pointer to the FrameCPP StatData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_statdata_pointer	StatData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameStatDataTimeStart - Get Static Data Structure timeStart variable.

---

Note: StatData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: StatData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameStatDataTimeStart start ]

Parameters:

Name	Type	Description
stat	FrStatData*	A pointer to the FrameCPP StatData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_statdata_pointer	StatData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameStatDataVersion - Get Static Data Structure version.

---

Note: StatData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: StatData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameStatDataVersion start ]

Parameters:

Name	Type	Description
stat	FrStatData*	A pointer to the FrameCPP StatData object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_statdata_pointer	StatData object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameSummary - Find Summary structure by name or access by index.

---

This function returns a 'shallow' Summary pointer( a pointer to the data of FrameCPP frame object ).

Usage - Basic SWIG interface:
set proc [ getFrameSummary frame sumName ]

Parameters:

Name	Type	Description
frame	FrameH*	frame pointer.
sumName	char*	Summary name or index.

Return value:
FrameCPP::FrSummary* ptResult - Summary pointer.

Exceptions:

Exception	Description
sum_not_found	Summary channel is not found.
invalid_frame	Frame object is invalid.
SwigException

---

getFrameSummaryComment - Get Summary comment.

---

Note: Summary object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Summary pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameSummaryComment sum ]

Parameters:

Name	Type	Description
sum	FrSummary*	A pointer to the FrameCPP Summary object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_summary_pointer	Summary object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameSummaryGTime - Get Summary GPS time.

---

Note: Summary object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Summary pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameSummaryGTime sum ]

Parameters:

Name	Type	Description
sum	FrSummary*	A pointer to the FrameCPP Summary object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_summary_pointer	Summary object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameSummaryName - Get Summary name.

---

Note: Summary object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Summary pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameSummaryName sum ]

Parameters:

Name	Type	Description
sum	FrSummary*	A pointer to the FrameCPP Summary object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_summary_pointer	Summary object is NULL.
bad_alloc	Memory allocation failed.

---

getFrameSummaryNum - Get the number of summary data structures in a frame.

---

Usage - Basic SWIG interface:
set numSummaryStructs [ getFrameSummaryNum frame ]

Parameters:

Name	Type	Description
frame	FrameH*	A pointer to the FrameCPP frame object

Return value:
unsigned long - Number of Summary structures..

Exceptions:

Exception	Description
invalid_frame	Frame object is invalid.

---

getFrameSummaryTest - Get Summary test.

---

Note: Summary object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: Summary pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ getFrameSummaryTest sum ]

Parameters:

Name	Type	Description
sum	FrSummary*	A pointer to the FrameCPP Summary object.

Return value:
string - String representation of ILWD element pointer.

Exceptions:

Exception	Description
null_summary_pointer	Summary object is NULL.
bad_alloc	Memory allocation failed.

---

ilwd2frame - Convert an ILWD frame to a FrameCPP frame.

---

Caller is responsible for destruction of the result FrameCPP object.

Usage - Basic SWIG interface:
set ptFrame [ilwd2frame ptILwdFrame]param: LdasContainer* ptILwdFrame - A pointer to an ILWD frame in the C layer. This is an ILWD container object which holds a frame.

Return value:
FrameH* ptFrame - A FrameCPP frame object instantiated in the C++ layer.

Exceptions:

Exception	Description
invalid_container	The ILWD frame does not exist.
invalid_format	The ILWD frame object was malformed.
SwigException

---

ilwd2frame_r - Convert an ILWD frame to a FrameCPP frame - thread return value

---

Caller is responsible for destruction of the result FrameCPP object.

Usage - Basic SWIG interface:
set ptFrame [ilwd2frame_r tid]

Parameters:

Name	Type	Description
tid	tid*	A pointer to a ilwd2frame thread.

Return value:
FrameH* ptFrame - A FrameCPP frame object instantiated in the C++ layer.

Exceptions:

Exception	Description
invalid_container	The ILWD frame does not exist.
invalid_format	The ILWD frame object was malformed.
SwigException

---

ilwd2frame_t - Convert an ILWD frame to a FrameCPP frame - Threaded

---

Usage - Basic SWIG interface:
set tid [ilwd2frame_t ptILwdFrame]param: LdasContainer* ptILwdFrame - A pointer to an ILWD frame in the C layer. This is an ILWD container object which holds a frame.

Return value:
tid* tid - A pointer to created thread.

Exceptions:

Exception	Description
SwigException

---

insertAdcChanList - Transfer Frame ADC channels into an ILWD container.

---

Usage - Basic SWIG interface:
insertAdcChanList frame f "chan1 10 125-200"

Parameters:

Name	Type	Description
frame	Frame *	Valid FrameCPP frame object where the data is copied from.
f	LdasContainer *	Valid ILWD frame object to which the data will be added.
channelList	char*	ADC channel names, indexes, index ranges. Empty list means all ADCs.

Exceptions:

Exception	Description
channel_not_found	a channel from the `channels' list is not found.
invalid_frame	frame is not registered.
invalid_container	container is not registered.
invalid_container	container is not a frame container.
no_rawdata	there is no raw data in the container.
bad_rawdata	invalid adcdata within the rawdata.
SwigException

---

insertDetector - Insert detector structure from the FrameCPP `frame' into the LDAS container `f'.

---

Usage - Basic SWIG interface:
insertDetector frame f

Parameters:

Name	Type	Description
frame	Frame *	Valid FrameCPP frame object where the data is copied from.
f	LdasContainer *	Valid ILWD frame object to which the data be added.

Exceptions:

Exception	Description
detector_not_found	There is no Detector structure in the `frame'
invalid_frame	FrameCPP `frame' is not registered
invalid_container	ILwd frame container is not a valid object.
bad_ilwd_frame	ILWD format frame is malformed.
bad_alloc	Memory allocation failed.
SwigException

---

insertFrameData - Insert ILWD frame data into an ILWD frame.

---

This function inserts a deep copy of ILWD frame data into the ILWD frame container. ILWD data can be any FrameCPP data structure, such as AdcData, ProcData, History, ProcDetector, SimDetector, etc.

Boolean flag checkTime enables( if TRUE )/disables( if FALSE ) "frame time - frame data time" validation: time associated with the data must be the start time of the frame it's getting inserted into. This is a TCL's responsibility to pass the correct value for the flag. Malformed frames will be a result of improper use of this flag.

Usage - Basic SWIG interface:
insertFrameData ptILwdFrame ptILwdFrameData

Parameters:

Name	Type	Description
ptILwdFrame	LdasContainer*	A pointer to a valid ILWD frame object in the C++ layer.
ptILwdFrameData	LdasContainer*	A pointer to a valid ILWD frame data object in the C++ layer.
validateTime	const bool	A flag to enable/disable time stamp validation for data insertion. TRUE to enable, FALSE to disable. Default is TRUE( value = 1 ).

Return value:
none -

Exceptions:

Exception	Description
invalid_container	One of the container objects does not exist in the C++ layer.
invalid_frame	The frame container does not represent a frame.
invalid_frame_data	The frame data object being added does not represent frame data.
invalid_request	The second container is also a frame object (adding a frame object to a frame object is not supported) or it is not a frame data object at all.
incompatible_time	The second container represents a data object which corresponds to a different time than the frame object.
incompatible_length	The second container represents a data object which has a different 'dt' than the frame to which it is being added.
no_rawdata	The ILWD frame data object represents AdcData, SerData or a LogMsg there is no RawData object in the frame.
detectsim_exists	The ILWD frame data object represents a frame detectSim but there is already one present in the frame.
detectproc_exists	The ILWD frame data object represents a frame detectProc but there is already one present in the frame.
rawdata_exists	The ILWD frame data object represents a frame RawData structure but there is already one present in the frame.
bad_frame	The ILWD frame object is malformed.
bad_adcdata	The ILWD frame data object represents AdcData but it is malformed.
bad_detector	The ILWD frame data object represents a detector but it is malformed.
bad_procdata	The ILWD frame data object represents ProcData but it is malformed.
bad_simdata	The ILWD frame data object represents SimData but it is malformed.
bad_serdata	The ILWD frame data object represents SerData but it is malformed.
bad_event	The ILWD frame data object represents Event but it is malformed.
SwigException

---

insertHistory - Insert all history structures from the FrameCPP 'frame' into the LDAS container `f'.

---

Usage - Basic SWIG interface:
insertHistory frame f

Parameters:

Name	Type	Description
frame	Frame *	Valid FrameCPP frame object where the data is copied from.
f	LdasContainer *	Valid ILWD frame object to which the data be added.

Exceptions:

Exception	Description
invalid_frame	FrameCPP `frame' is not registered
invalid_container	ILwd frame container is not a valid object.
bad_ilwd_frame	ILWD format frame is malformed.
bad_alloc	Memory allocation failed.
SwigException

---

insertSerChanList - Transfer Frame Serial Data channels into an ILWD container.

---

Usage - Basic SWIG interface:
insertSerChanList frame f "chan1 10 125-200"

Parameters:

Name	Type	Description
frame	Frame *	Valid FrameCPP frame object where the data is copied from.
f	LdasContainer *	Valid ILWD frame object to which the data will be added added.
channelList	char *	Serial data channel names, indexes, index ranges. Empty list means all Serial data channels.

Exceptions:

Exception	Description
channel_not_found	a channel from the `channels' list is not found.
invalid_frame	frame is not registered.
invalid_container	container is not registered.
invalid_container	container is not a frame container.
no_rawdata	there is no raw data in the container.
bad_rawdata	invalid serdata within the rawdata.
SwigException

---

isFrameValid - Is frame a valid object?

---

This method returns true if the frame is a valid C++ object, false otherwise.

Usage - Basic SWIG interface:
isFrameValid frame

Parameters:

Name	Type	Description
frame	FrameCPP::FrameH*	A pointer to the FrameCPP frame object.

Return value:
bool - True if valid, false otherwise.

---

normalizeFrameTimeILwd - Normalize time data within Frame Container and subcontainers.

---

Usage - Basic SWIG interface:
normalizeFrameTimeILwd Frame

Parameters:

Name	Type	Description
Frame	LdasContainer*	Pointer to Frame container.

---

openFrameFile - Open a frame file for reading/writing.

---

Usage - Basic SWIG interface:
set ptFrameFile [openFrameFile filename mode]

Parameters:

Name	Type	Description
filename	const char*	The filename to open.
mode	const char*	The mode in which the file should be opened. Valid modes are (they are not case sensitive): r - Open the file for reading w - Open the file for writing. This will overwrite a preexisting file. If the file doesn't exist it will be created.

Return value:
FrameFile* prFrameFile - A pointer to the frame file object instantiated in the C++ layer.

Exceptions:

Exception	Description
file_not_found	The file couldn't be located.
invalid_mode	An invalid mode was specified.
permission_denied	Permission to access the file or a directory component was denied.
bad_alloc	Insufficient kernel memory to open the file.
io_error	An unknown I/O error occurred.
file_creation_failed	The file could not be created.

---

openFrameFile_r - Open a frame file for reading/writing. - Thread return value

---

Usage - Basic SWIG interface:
set ptFrameFile [openFrameFile_r tid]

Parameters:

Name	Type	Description
tid	tid*	A pointer to readFrame thread

Return value:
FrameFile* prFrameFile - A pointer to the frame file object instantiated in the C++ layer.

---

openFrameFile_t - Open a frame file for reading/writing. - Threaded

---

Parameters:

Name	Type	Description
filename	const char*	The filename to open.
mode	const char*	The mode in which the file should be opened. Valid modes are (they are not case sensitive): r - Open the file for reading w - Open the file for writing. This will overwrite a preexisting file. If the file doesn't exist it will be created.

Return value:
tid* tid - A pointer to created thread

---

readFrame - Read a frame from a file.

---

Usage - Basic SWIG interface:
set ptFrame [readFrame ptFrameFile]

Parameters:

Name	Type	Description
ptFrameFile	FrameFile*	A pointer to a frame file object in the C++ layer. This object must have been created via the openFrameFile command.

Return value:
FrameH* ptFrame - A pointer to the newly allocated frame object.

Exceptions:

Exception	Description
invalid_frame_file	The pointer is invalid (it does not point to a valid object in the C++ layer).
read_failure	Error reading frame file.

---

readFrame_r - Read a frame from a file - Thread return value

---

Usage - Basic SWIG interface:
set ptFrame [readFrame_r tid]

Parameters:

Name	Type	Description
tid	tid*	A pointer to readFrame thread

Return value:
FrameH* ptFrame - A pointer to the newly allocated frame object.

Exceptions:

Exception	Description
invalid_frame_file	The pointer is invalid (it does not point to a valid object in the C++ layer).
read_failure
SwigException

---

readFrame_t - Read a frame from a file - Threaded

---

Usage - Basic SWIG interface:
set tid [readFrame_t ptFrameFile]

Parameters:

Name	Type	Description
ptFrameFile	FrameFile*	A pointer to a frame file object in the C++ layer. This object must have been created via the openFrameFile command.

Return value:
tid* tid - A pointer to created thread

Exceptions:

Exception	Description
invalid_frame_file	The pointer is invalid (it does not point to a valid object in the C++ layer).
read_failure	Error reading frame file.

---

recvFrameBinary - Receive Frame as File

---

This command receives a frame object from a socket as frame file. The file is parsed and the frame is read. If the frame file contains more than one frame then only the first frame will be read.

Usage - Basic SWIG interface:
set ptFrame [recvFrame ptSocket]

Parameters:

Name	Type	Description
ptSocket	os_tcp_socket*	a data socket in the C++ layer created with either the createDataSocket or acceptDataSocket commands. It must be connected.

Return value:
FrameH* ptFrame - a pointer to the newly instantiated frame in the C++ layer.

Exceptions:

Exception	Description
invalid_socket	the socket doesn't exist.
unconnected_socket	the socket isn't connected.
bad_alloc	insufficient memory for frame.
SwigException

---

recvFrameBinary_r - Receive frame as file - thread return value

---

Usage - Basic SWIG interface:
set ptFrame [recvFrameBinary_r tid]

Parameters:

Name	Type	Description
tid	tid*	A pointer to a recvFrameBinary thread.

Return value:
FrameH* ptFrame - a pointer to the newly instantiated frame in the C++ layer.

Exceptions:

Exception	Description
invalid_socket	the socket doesn't exist.
unconnected_socket	the socket isn't connected.
bad_alloc	insufficient memory for frame.
SwigException

---

recvFrameBinary_t - Receive Frame as File - Threaded

---

This command receives a frame object from a socket as frame file. The file is parsed and the frame is read. If the frame file contains more than one frame then only the first frame will be read.

Usage - Basic SWIG interface:
set tid [recvFrameBinary_t ptSocket]

Parameters:

Name	Type	Description
ptSocket	os_tcp_socket*	a data socket in the C++ layer created with either the createDataSocket or acceptDataSocket commands. It must be connected.

Return value:
tid* tid - A pointer to created thread.

Exceptions:

Exception	Description
SwigException

---

reduceRawFrames_r - Create reduced data set of frames. - Thread return value.

---

Usage - Basic SWIG interface:
set resultFiles [ reduceRawFrames_r tid ]

Parameters:

Name	Type	Description
t	tid*	A pointer to the 'reduceRawFrames' thread.

Return value:
string - Space separated filenames of RDS frames.

---

reduceRawFrames_t - Create reduced data set of frames (threaded).

---

compression method to apply to the data. ( ex: GZIP ). that support multiple levels ( ex: 6 for GZIP ).

Usage - Basic SWIG interface:
set tid [ reduceRawFrames_t start stop frame_files channel_names output_directory type compression_method compression_level ]

Parameters:

Name	Type	Description
start	const INT_4U	Start time in seconds of data to be written to disk.
end	const INT_4U	End time in seconds of data to be written to disk.
frame_files	const char*	A comma separated list of frame file names.
channels	const char*	A comma separated list of channels to extract from original frames (only channel names are allowed).
dir	const char*	Directory to write result frames to, i.e. /some/directory/to/write (please note: no terminating forward slash).
type	const char*	type specifier for output.
compression_method	const char*	Text string representing the
compression_level	int	Level of compression for compression methods
verify_checksum	bool	true if the checksum of each input file is to be validated
verify_frame_checksum	bool	true if the checksum of each input frame is to be validated
verify_time_range	bool	true if should verify time data within file with the name of the file
verify_data_valid	bool	true if the adc channels should have their dataValid field verified.
FramesPerFile	INT_4U	Number of frames per file. If the value is zero, then the number of frames will be determined at runtime.
SecondsPerFrame	INT_4U	Number of seconds per frame. If the value is zero, then the number of seconds per frame will be determined at runtime
AllowShortFrames	const bool	FramesPerFile * SecondsPerFrame is not a multiple of the time difference, an exception is normally thrown. This flag allows short final frames to be created.
GenerateFrameChecksum	const bool	Generate checksums on a per frame basis.
FillMissingDataValidArray	const bool	If the aux element of an FrAdcData structure is missing, then fill in with the appropriate dataValid value.
MetadataCheck	const bool	true if the metadata should be validated
MD5SumOutputDirectory	const char*	Name of the output directory.

Return value:
tid* - A pointer to the created thread object.

---

rehashAdc - Rehash adc name hash in the frame.

---

Rehashing must be done before `insertAdcChanList()' call and some other calls with a channel name in the list argument.

Usage - Basic SWIG interface:
rehashAdc frame

Parameters:

Name	Type	Description
frame	FrameH*	Valid FrameCPP frame pointer

Exceptions:

Exception	Description
SwigException
invalid_frame	Frame object is invalid.
invalid_frame: null rawData	RawData is missing.

---

rehashProc - Rehash ProcData name hash in the frame.

---

Usage - Basic SWIG interface:
rehashProc frame

Parameters:

Name	Type	Description
frame	FrameH*	Valid FrameCPP frame pointer

Exceptions:

Exception	Description
SwigException
invalid_frame	Frame object is invalid.

---

rehashSer - Rehash serial data name hash in the frame.

---

Rehashing must be done before `insertSerChanList()' call and some other calls with a channel name in the list argument.

Usage - Basic SWIG interface:
rehashSer frame

Parameters:

Name	Type	Description
frame	FrameH*	Valid FrameCPP frame pointer.

Exceptions:

Exception	Description
SwigException
invalid_frame	Frame object is invalid.
invalid_frame: null rawData	RawData is missing.

---

resampleAdcData - Resample AdcData

---

Usage - Basic SWIG interface:
set newAdcPtr [ resampleAdcData adcPtr resampleState ]

Parameters:

Name	Type	Description
adcPtr	FrAdcData*	FrameCPP::AdcData object to downsample
resampleState	ResampleBase*	resample state returned by createResampleState

Return value:
FrProcData* newProcPtr - A pointer to created ProcData object.

Exceptions:

Exception	Description
SwigException

---

resampleAdcData_r - Resample AdcData - Thread return value

---

Usage - Basic SWIG interface:
set newAdcPtr [resampleAdcData_r tid]

Parameters:

Name	Type	Description
tid	tid*	A pointer to resampleAdcData thread

Return value:
FrAdcData* newAdcPtr - A pointer to created AdcData object.

Exceptions:

Exception	Description
SwigException

---

resampleAdcData_t - Resample AdcData (threaded)

---

Usage - Basic SWIG interface:
set tid [ resampleAdcData_t adcPtr resampleState ]

Parameters:

Name	Type	Description
adcPtr	FrAdcData*	FrameCPP::AdcData object to downsample
resampleState	ResampleBase*	resample state returned by createResampleState

Return value:
tid* tid - A pointer to created thread

Exceptions:

Exception	Description
SwigException

---

resampleDelay - Get resampling filter delay time

---

Usage - Basic SWIG interface:
set delay [ resampleDelay procPtr resampleState ]

Parameters:

Name	Type	Description
procPtr	FrProcData*	FrameCPP::ProcData object
resampleState	ResampleBase*	resample state returned by createResampleState

Return value:
delay - time delay in seconds

Exceptions:

Exception	Description
SwigException

---

resampleRawFrames_r - Create resampled reduced data set of frames. - Thread return value.

---

Usage - Basic SWIG interface:
set resultFiles [ resampleRawFrames_r tid ]

Parameters:

Name	Type	Description
t	tid*	A pointer to the 'resampleRawFrames' thread.

Return value:
string - Space separated filenames of RDS frames.

---

resampleRawFrames_t - Create resampled reduced data set of frames (threaded).

---

compression method to apply to the data. ( ex: GZIP ). that support multiple levels ( ex: 6 for GZIP ).

Usage - Basic SWIG interface:
set tid [ resampleRawFrames start stop frame_files channel_names resample_factors output_directory type compression_method compression_level ]

Parameters:

Name	Type	Description
start	const INT_4U	Start time in seconds of data to be written to disk.
end	const INT_4U	End time in seconds of data to be written to disk.
frame_files	const char*	A comma separated list of frame file names.
channels	const char*	A comma separated list of channels to extract from original frames (only channel names are allowed).
resample	const char*	A comma separated list of resample factors.
dir	const char*	Directory to write result frames to, i.e. /some/directory/to/write (please note: no terminating forward slash).
type	const char*	type specifier for output.
compression_method	const char*	Text string representing the
compression_level	int	Level of compression for compression methods
verify_checksum	bool	true if the checksum of each input file is to be validated
verify_frame_checksum	bool	true if the checksum of each input frame is to be validated
verify_time_range	bool	true if should verify time data within file with the name of the file
verify_data_valid	bool	true if the adc channels should have their dataValid field verified.
FramesPerFile	INT_4U	Number of frames per file. If the value is zero, then the number of frames will be determined at runtime.
SecondsPerFrame	INT_4U	Number of seconds per frame. If the value is zero, then the number of seconds per frame will be determined at runtime
AllowShortFrames	const bool	FramesPerFile * SecondsPerFrame is not a multiple of the time difference, an exception is normally thrown. This flag allows short final frames to be created.
GenerateFrameChecksum	const bool	Generate checksums on a per frame basis.
FillMissingDataValidArray	const bool	If the aux element of an FrAdcData structure is missing, then fill in with the appropriate dataValid value.
MetadataCheck	const bool	true if the metadata should be validated
MD5SumOutputDirectory	const char*	Name of the output directory.

Return value:
tid* - A pointer to the created thread object.

---

sendFrameBinary - Send Frame as File

---

This command sends a Frame object in the C++ layer through a socket as a frame file.

Usage - Basic SWIG interface:
sendFrameBinary ptSocket ptFrame

Parameters:

Name	Type	Description
ptSocket	os_tcp_socket*	a data socket in the C++ layer created with either the createDataSocket or acceptDataSocket commands. It must be connected.
ptFrame	FrameH*	a frame object instantiated in the C++ layer.

Return value:
none -

Exceptions:

Exception	Description
invalid_socket	the socket doesn't exist.
unconnected_socket	the socket isn't connected.
invalid_frame	the frame doesn't exist.
SwigException

---

sendFrameBinary_r - Send frame as file - thread return value

---

Usage - Basic SWIG interface:
sendFrameBinary_r tid

Parameters:

Name	Type	Description
tid	tid*	A pointer to a sendFrameBinary thread.

Return value:
Nothing -

Exceptions:

Exception	Description
invalid_socket	the socket doesn't exist.
unconnected_socket	the socket isn't connected.
invalid_frame	the frame doesn't exist.
SwigException

---

sendFrameBinary_t - Send Frame as File -- Threaded

---

This command sends a Frame object in the C++ layer through a socket as a frame file.

Usage - Basic SWIG interface:
set tid [sendFrameBinary_t ptSocket ptFrame]

Parameters:

Name	Type	Description
ptSocket	os_tcp_socket*	a data socket in the C++ layer created with either the createDataSocket or acceptDataSocket commands. It must be connected.
ptFrame	FrameH*	a frame object instantiated in the C++ layer.

Return value:
tid* tid - A pointer to created thread.

Exceptions:

Exception	Description
SwigException

---

setFrameAdcDataTimeOffset - Set ADC time offset.

---

Note: AdcData object can be a shallow pointer into the FrameCPP frame object. Caller should be careful when calling this function: AdcData pointer becomes invalid if frame object it's referencing to gets destructed.

Usage - Basic SWIG interface:
set ptElement [ setFrameAdcDataTimeOffset adc sec nsec ]

Parameters:

Name	Type	Description
adc	FrAdcData*	A pointer to the FrameCPP AdcData object.
sec	unsigned int	Time offset seconds.
nsec	unsigned int	Time offset nanoseconds.

Return value:
Nothing. -

Exceptions:

Exception	Description
null_adcdata_pointer	AdcData object is NULL.

---

setFrameProcDataTimeOffset - Reset timeOffset for frameCPP::ProcData.

---

This is a temporary solution for AdcData--->ProcData conversion.

Usage - Basic SWIG interface:
setFrameProcDataTimeOffset sec nan

Parameters:

Name	Type	Description
procPtr	FrProcData*	ProcData data pointer
sec	const INT_4U	TimeOffset seconds.
nan	const INT_4U	TimeOffset nanoseconds.

Return value:
None -

Exceptions:

Exception	Description
SwigException
invalid_procdata	ProcData object is invalid.

---

writeFrame - Write a frame to a file.

---

Usage - Basic SWIG interface:
writeFrame ptFrameFile ptFrame

Parameters:

Name	Type	Description
ptFrameFile	FrameFile*	A pointer to a frame file object in the C++ layer. This object must have been created via the openFrameFile command.
ptFrame	FrameH*	A pointer to a frame object.
CmopressionMethod	string	The compression method to use. Values can be either raw, gzip, or gzip_diff. The default is gzip.
CompressionLevel	int	The level of compression to be done. This value is only used by compression methods that support compression levels such as gzip. The default is 1.

Return value:
Nothing -

Exceptions:

Exception	Description
invalid_frame_file	The pointer is invalid (it does not point to a valid object in the C++ layer).
invalid_frame
write_failure
SwigException

---

writeFrame_r - Write a frame to a file - thread return value

---

Usage - Basic SWIG interface:
writeFrame_r tid

Parameters:

Name	Type	Description
tid	tid*	A pointer to a writeFrame thread

Return value:
Nothing -

Exceptions:

Exception	Description
invalid_frame_file	The pointer is invalid (it does not point to a valid object in the C++ layer).
invalid_frame
write_failure
SwigException

---

writeFrame_t - Write a frame to a file - Threaded

---

Usage - Basic SWIG interface:
set tid [writeFrame_t ptFrameFile ptFrame]

Parameters:

Name	Type	Description
ptFrameFile	FrameFile*	A pointer to a frame file object in the C++ layer. This object must have been created via the openFrameFile command.
ptFrame	FrameH*	A pointer to a frame object.
CmopressionMethod	string	The compression method to use. Values can be either raw, gzip, or gzip_diff. The default is gzip.
CompressionLevel	int	The level of compression to be done. This value is only used by compression methods that support compression levels such as gzip. The default is 1.

Return value:
tid* tid - A pointer to created thread

Exceptions:

Exception	Description
SwigException