Class Index | Cross Index | Namespace Index |
CheckSum | CheckSumCRC | Container | ContainerBase | ContainerBasic |
DETECTOR_MAP | FrAdcDataBase | FrEndOfFileBase | FrameFilename | FrameHBase |
FrameReader | FrameWriterTOC | VFrameReader | Verify |
Typedef for STRING type in frames
Supports version 6 of spec Typedef for version information
class FrameFilename
Parameters:
Name | Type | Description |
INT_8U | establish the size in bytes of the I/O buffer. A value of 0 sets the buffer size to the system specified default. |
Return value:
bool - state of checking that the data valid field is zero
Parameters:
Name | Type | Description |
Check | bool | true if the data valid field must be zero, false otherwise. |
Return value:
bool - true if checksums for frame files need to be performed, false otherwise.
Parameters:
Name | Type | Description |
Check | bool | true if checksums for frame files need to be performed, false otherwise. |
Return value:
bool - true if checksums for individual frames need to be performed, false otherwise.
Parameters:
Name | Type | Description |
Check | bool | true if checksums for individual frames need to be performed, false otherwise. |
Return value:
bool - true if md5sum for the frame file will be performed, false otherwise.
Parameters:
Name | Type | Description |
Check | bool | true if md5sum for the frame file should be performed, false otherwise. |
Sets the ownsership for the element at the given index.
Parameters:
Name | Type | Description |
c | const ContainerBasic< T >& | The container to copy from |
c | const ContainerBasic< T >& | The container to assign from. |
c | const ContainerBasic< T >& | The container to compare with. |
c | const ContainerBasic< T >& | The container to compare with. |
index | size_t | The index of the desired element. |
iter | const_iterator | A constant iterator pointing to an element in the container. |
index | size_t | Index. |
iter | iterator | The element whose ownership will be modified. |
owns | bool | true if the container should own the data, false otherwise. |
index | size_t | The element whose ownership will be modified. |
owns | bool | True if the container should own the data, false otherwise. |
Return value:
const ContainerBasic< 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. ContainerBasic< T >::iterator -- Beginning iterator.
Exceptions:
Exception | Description |
None. | |
std::bad_alloc | Memory allocation failed. |
None. | |
std::bad_alloc | Memory allocation failed. |
frame_mismatch | `T' mismatch. |
None. | |
None. | |
None. | |
None. | |
None. | |
None. |
Return value:
const std::string& - Additional error information
This may be one larger than the current frame specification
Return value:
std::string - The string representation of when the library was built
The time information that is returned by this function is based on when the top level configure.in ( ldas/configure.in) file was committed to CVS. The time value is in UTC time as that is what CVS uses internally.
Return value:
std::string - The string representation of the cvs date
Return value:
INT_2U - current version of frame spec.
Return value:
INT_2U - current minor version for the frame library
Return value:
std::string - The string representation of the version of frameCPP
Return value:
bool - true if the frame file must have the EOF checksum structure, false otherwise
Parameters:
Name | Type | Description |
Conformance | bool | true if the frame file must have the EOF checksum structure, false otherwise |
Return value:
bool - state of strictness. True for strict conformance to the frame spec; false otherwise.
Parameters:
Name | Type | Description |
Strictness | bool | true if the frame file must conform to all details of the frame spec; false otherwise. |
Parameters:
Name | Type | Description |
index | size_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:
Exception | Description |
None. | |
None. | |
None. |
Return value:
bool - true if memory mapped I/O will be used
Parameters:
Name | Type | Description |
UseMemoryMappedIO | bool | true if memory mapped I/O should be used; false otherwise. |
Return value:
bool - true if metadata should be validated
Parameters:
Name | Type | Description |
ValidateMetadata | bool | true if frame metadata to be verified against against the filename |
Memory for the element will be allocated and the container will own the new element.
Parameters:
Name | Type | Description |
data | const T& | The item to append. |
Return value:
iterator - - The iterator correspinding to the appended object.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Memory for the element will be allocated and the container will own the new element.
Parameters:
Name | Type | Description |
data | const T* | The item to append. |
Return value:
iterator - - The iterator corresponding to the appended object.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
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:
Name | Type | Description |
data | const T& | The item to append. |
copy | bool | True if memory should be allocated and the element copied into the container (default: true). |
owns | bool | True if the container will own the element (default: true). |
Return value:
iterator - - The iterator corresponding to the appended object.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Return value:
ContainerBasic< T >::const_iterator - - Beginning iterator.
Exceptions:
Exception | Description |
None. |
Return value:
ContainerBasic< T >::iterator - - End iterator.
Exceptions:
Exception | Description |
None. |
Return value:
ContainerBasic< T >::const_iterator - - End iterator.
Exceptions:
Exception | Description |
None. |
This erases an element at the specified index. If the index is out of range then nothing happens.
Parameters:
Name | Type | Description |
index | unsigned int | Element index. |
Exceptions:
Exception | Description |
None. |
If end is less thatn start or any of the iterators are out of range then nothing will happen.
Parameters:
Name | Type | Description |
start | iterator | Range start. |
finish | iterator | Range end. |
Exceptions:
Exception | Description |
None. |
The element will be copied and the container will own the new element.
Parameters:
Name | Type | Description |
iter | iterator | An iterator pointing to the location where the element should be added. |
data | const T& | The item to add. |
Return value:
iterator - - An iterator pointing to the added item.
Exceptions:
Exception | Description |
std::bad_alloc | Memory could not be allocated for the element. |
The element will be copied and the container will own the new element.
Parameters:
Name | Type | Description |
iter | iterator | An iterator pointing to the location where the element should be added. |
data | const T* | The item to add. |
Return value:
iterator - - An iterator pointing to the added item.
Exceptions:
Exception | Description |
std::bad_alloc | Memory could not be allocated for the element. |
Parameters:
Name | Type | Description |
iter | iterator | An iterator pointing to the location where the element should be added. |
data | T* | The item to add. |
copy | bool | Duplicate passed data or not. |
owns | bool | Destroy the data when container is destroyed or not. |
Return value:
iterator - - An iterator pointing to the added item.
Exceptions:
Exception | Description |
std::bad_alloc | Memory could not be allocated for the element. |
The element will be copied and the container will own the new element.
Parameters:
Name | Type | Description |
index | size_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. |
data | const T& | The item to add. |
Return value:
iterator - - An iterator pointing to the added item.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
The element will be copied and the container will own the new element.
Parameters:
Name | Type | Description |
index | size_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. |
data | const T* | The item to add. |
Return value:
iterator - - An iterator pointing to the added item.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Parameters:
Name | Type | Description |
index | size_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. |
data | T* | The item to add. |
copy | bool | Duplicate passed data or not. |
owns | bool | Destroy the data when container is destroyed or not. |
Return value:
iterator - - An iterator pointing to the added item.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Return value:
size_t - - The number of objects in the container.
Exceptions:
Exception | Description |
None. |
This copies another container to this one. Ownership is handled in the same manner as in the copy constructor.
Parameters:
Name | Type | Description |
c | const ContainerBasic< T >& | The container to assign from. |
Return value:
const ContainerBasic< T >& - - This container.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |