Class Index Cross Index Namespace Index

Namespace FrameCPP::Version_3_4_5


Index:

Members of type class

AdcData Base ClassInfo Container ContainerBase
DaqFrame DaqReader Detector Dictionary Dimension
EndOfFile EndOfFrame Event FileHeader Frame
FrameAppendWriterTOC FrameReadPlan FrameReader FrameReaderBase FrameWriterTOC
GeneralReader History ImageFrameWriter ImageFrameWriter Input
Library Location Msg ObjectHeader ObjectInfo
Output ProcData RawData RefHead RefHeadBase
Reference SE SH SearchContainer SerData
SimData SimEvent StatData Summary TOC
TOCReader Table Time Vect

Members of type typedef

FrAdcData FrDetector FrEvent FrHistory FrMsg
FrProcData FrRawData FrSerData FrSimData FrSimEvent
FrStatData FrSummary FrTable FrVect FrameH
FrameWriter FrameWriterImage adc_map_info_struct

Members of type function

Container GeneralReader GetStreamPtr RefHead T
append append append begin begin
end end erase erase inline Container
inline GeneralReader inline RefHead insert insert insert
insert insert insert int isEndOfFile
operator * operator * operator + operator - operator /
operator << operator << operator >> operator >> operator >>
reverse void

Member Descriptions:

Members of type typedef


FrameCPP::Version_3_4_5::FrAdcData

FrameCPP::Version_3_4_5::FrDetector

FrameCPP::Version_3_4_5::FrEvent

FrameCPP::Version_3_4_5::FrHistory

FrameCPP::Version_3_4_5::FrMsg

FrameCPP::Version_3_4_5::FrProcData

FrameCPP::Version_3_4_5::FrRawData

FrameCPP::Version_3_4_5::FrSerData

FrameCPP::Version_3_4_5::FrSimData

FrameCPP::Version_3_4_5::FrSimEvent

FrameCPP::Version_3_4_5::FrStatData

FrameCPP::Version_3_4_5::FrSummary

FrameCPP::Version_3_4_5::FrTable

FrameCPP::Version_3_4_5::FrVect

FrameCPP::Version_3_4_5::FrameH

FrameCPP::Version_3_4_5::FrameWriter

FrameCPP::Version_3_4_5::FrameWriterImage

FrameCPP::Version_3_4_5::adc_map_info_struct

Members of type function


FrameCPP::Version_3_4_5::Container - Set Ownership.
Sets the ownsership for the element at the given index.

Parameters:
NameTypeDescription
cconst Container< T >& The container to copy from
cconst Container< T >& The container to assign from.
cconst Container< T >& The container to assign from.
cconst Container< T >& The container to compare with.
cconst Container< T >& The container to compare with.
indexsize_t The index of the desired element.
iterconst_iterator A constant iterator pointing to an element in the container.
indexsize_t Index.
iteriterator The element whose ownership will be modified.
ownsbool true if the container should own the data, false otherwise.
indexsize_t The element whose ownership will be modified.
ownsbool True if the container should own the data, false otherwise.

Return value:
const Container< T >& - - This container. const Container< T >& -- This container. bool -- true if the containers are equal. bool -- true if the containers are not equal. T* -- A pointer to the object stored at the index. T* -- A constant pointer to the object stored at the index. bool -- True if the object is owned by the container. bool -- True if the object is owned by the container. T* -- First item. T* -- Last item.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
None.
std::bad_allocMemory allocation failed.
std::bad_allocMemory allocation failed.
frame_mismatch`T' mismatch.
None.
None.
None.
None.
None.


FrameCPP::Version_3_4_5::GeneralReader - Constructor

Exceptions:
ExceptionDescription
read_failureRead failed.


FrameCPP::Version_3_4_5::GetStreamPtr

FrameCPP::Version_3_4_5::RefHead - Adds an item to the referenced container.

Parameters:
NameTypeDescription
bBase* Item to be added.

Exceptions:
ExceptionDescription
std::bad_cast


FrameCPP::Version_3_4_5::T - Returns the last item in the container.

Parameters:
NameTypeDescription
indexsize_t The index of the desired element.

Return value:
const T* - - A constant pointer to the object stored at the index. const T* -- First item. const T* -- Last item.

Exceptions:
ExceptionDescription
None.
None.
None.


FrameCPP::Version_3_4_5::append - Append an element to the end of the container.
Memory for the element will be allocated and the container will own the new element.

Parameters:
NameTypeDescription
dataconst T& The item to append.

Return value:
iterator - - The iterator correspinding to the appended object.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.


FrameCPP::Version_3_4_5::append - Append an element to the end of the container.
Memory for the element will be allocated and the container will own the new element.

Parameters:
NameTypeDescription
dataconst T* The item to append.

Return value:
iterator - - The iterator corresponding to the appended object.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.


FrameCPP::Version_3_4_5::append - Append an element to the end of the container.
The user may also specifiy whether or not memory is allocated for the element (i.e., the element is copied) and if the container owns the element.

Parameters:
NameTypeDescription
dataconst T& The item to append.
copybool True if memory should be allocated and the element copied into the container (default: true).
ownsbool True if the container will own the element (default: true).

Return value:
iterator - - The iterator corresponding to the appended object.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.


FrameCPP::Version_3_4_5::begin - Returns an iterator at the beginning of the container.

Return value:
Container< T >::iterator - - Beginning iterator.

Exceptions:
ExceptionDescription
None.


FrameCPP::Version_3_4_5::begin - Returns an iterator at the beginning of the container.

Return value:
Container< T >::const_iterator - - Beginning iterator.

Exceptions:
ExceptionDescription
None.


FrameCPP::Version_3_4_5::end - Returns an iterator at the end of the container.

Return value:
Container< T >::iterator - - End iterator.

Exceptions:
ExceptionDescription
None.


FrameCPP::Version_3_4_5::end - Returns an iterator at the end of the container.

Return value:
Container< T >::const_iterator - - End iterator.

Exceptions:
ExceptionDescription
None.


FrameCPP::Version_3_4_5::erase - Erase an element.
This erases an element at the specified index. If the index is out of range then nothing happens.

Parameters:
NameTypeDescription
indexunsigned int Element index.

Exceptions:
ExceptionDescription
None.


FrameCPP::Version_3_4_5::erase - Erases a range of elements.
If end is less thatn start or any of the iterators are out of range then nothing will happen.

Parameters:
NameTypeDescription
startiterator Range start.
finishiterator Range end.

Exceptions:
ExceptionDescription
None.


FrameCPP::Version_3_4_5::inline Container - Default constructor.
This just creates an empty container.

Exceptions:
ExceptionDescription
None.


FrameCPP::Version_3_4_5::inline GeneralReader - Destructor

Exceptions:
ExceptionDescription
None.


FrameCPP::Version_3_4_5::inline RefHead - Copy Constructor.

Parameters:
NameTypeDescription
cContainer< T >& Referenced container.
refconst RefHead& Object to be copied.


FrameCPP::Version_3_4_5::insert - Insert an element into the container.
The element will be copied and the container will own the new element.

Parameters:
NameTypeDescription
iteriterator An iterator pointing to the location where the element should be added.
dataconst T& The item to add.

Return value:
iterator - - An iterator pointing to the added item.

Exceptions:
ExceptionDescription
std::bad_allocMemory could not be allocated for the element.


FrameCPP::Version_3_4_5::insert - Insert an element into the container.
The element will be copied and the container will own the new element.

Parameters:
NameTypeDescription
iteriterator An iterator pointing to the location where the element should be added.
dataconst T* The item to add.

Return value:
iterator - - An iterator pointing to the added item.

Exceptions:
ExceptionDescription
std::bad_allocMemory could not be allocated for the element.


FrameCPP::Version_3_4_5::insert - Insert an element into the container.

Parameters:
NameTypeDescription
iteriterator An iterator pointing to the location where the element should be added.
dataT* The item to add.
copybool Duplicate passed data or not.
ownsbool Destroy the data when container is destroyed or not.

Return value:
iterator - - An iterator pointing to the added item.

Exceptions:
ExceptionDescription
std::bad_allocMemory could not be allocated for the element.


FrameCPP::Version_3_4_5::insert - Insert an element into the container.
The element will be copied and the container will own the new element.

Parameters:
NameTypeDescription
indexsize_t The index at which the element should be added. If the index is out of range then the element will be inserted at the end.
dataconst T& The item to add.

Return value:
iterator - - An iterator pointing to the added item.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.


FrameCPP::Version_3_4_5::insert - Insert an element into the container.
The element will be copied and the container will own the new element.

Parameters:
NameTypeDescription
indexsize_t The index at which the element should be added. If the index is out of range then the element will be inserted at the end.
dataconst T* The item to add.

Return value:
iterator - - An iterator pointing to the added item.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.


FrameCPP::Version_3_4_5::insert - Insert an element into the container.

Parameters:
NameTypeDescription
indexsize_t The index at which the element should be added. If the index is out of range then the element will be inserted at the end.
dataT* The item to add.
copybool Duplicate passed data or not.
ownsbool Destroy the data when container is destroyed or not.

Return value:
iterator - - An iterator pointing to the added item.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.


FrameCPP::Version_3_4_5::int - Returns the size of the container.

Return value:
size_t - - The number of objects in the container.

Exceptions:
ExceptionDescription
None.


FrameCPP::Version_3_4_5::isEndOfFile - See if FrEndOfFile structure was read, ie. the end of frame file reached

Return value:
bool - True if FrEndOfFile was read.

Exceptions:
ExceptionDescription
None


FrameCPP::Version_3_4_5::operator *

Exceptions:
ExceptionDescription
None.


FrameCPP::Version_3_4_5::operator *

Exceptions:
ExceptionDescription
None.


FrameCPP::Version_3_4_5::operator +

Exceptions:
ExceptionDescription
None.


FrameCPP::Version_3_4_5::operator -

Exceptions:
ExceptionDescription
None.


FrameCPP::Version_3_4_5::operator /

Exceptions:
ExceptionDescription
None.


FrameCPP::Version_3_4_5::operator <<

Exceptions:
ExceptionDescription
write_failureWrite failed.


FrameCPP::Version_3_4_5::operator <<

Exceptions:
ExceptionDescription
write_failureWrite failed.


FrameCPP::Version_3_4_5::operator >>

Exceptions:
ExceptionDescription
read_failureRead failed.


FrameCPP::Version_3_4_5::operator >>

FrameCPP::Version_3_4_5::operator >>

Exceptions:
ExceptionDescription
read_failureRead failed.


FrameCPP::Version_3_4_5::reverse - Reverses the order of eight bytes.
This is a template specialization.

Parameters:
NameTypeDescription
destunsigned char* Pointer to the start of the data.
nunsignet int Number of data points.
destunsigned char* Pointer to the start of the data.
nunsignet int Number of data points.
destunsigned char* Pointer to the start of the data.
nunsignet int Number of data points.
destunsigned char* Pointer to the start of the data.
nunsignet int Number of data points.
destunsigned char* Pointer to the start of the data.
nunsignet int Number of data points.
destunsigned char* Pointer to the start of the data.
nunsignet int Number of data points.
destunsigned char* Pointer to the start of the data.
nunsignet int Number of data points.
destunsigned char* Pointer to the start of the data.
nunsignet int Number of data points.

Exceptions:
ExceptionDescription
None.
None.
None.
None.
None.
None.
None.
None.


FrameCPP::Version_3_4_5::void