Class Index Cross Index Namespace Index

Namespace FrameCPP


Index:

Members of type class

CheckSum CheckSumCRC Container ContainerBase ContainerBasic
DETECTOR_MAP FrAdcDataBase FrEndOfFileBase FrameFilename FrameHBase
FrameReader FrameWriterTOC VFrameReader Verify

Members of type typedef

Base Dimension FrAdcData FrDetector FrEndOfFile
FrEndOfFrame FrEvent FrHeader FrHistory FrMsg
FrProcData FrRawData FrSE FrSH FrSerData
FrSimData FrSimEvent FrStatData FrSummary FrTOC
FrTable FrVect FrameH FrameWriterImage IFrameStream
OFrameStream STRING Time version_type

Members of type function

Base BufferSize BufferSize CheckDataValid CheckDataValid
CheckFileChecksum CheckFileChecksum CheckFrameChecksum CheckFrameChecksum CheckMD5Sum
CheckMD5Sum ContainerBasic D Dir ErrorInfo
Ext FrAdcDataBase FrameHBase FrameSpecCurrent FrameSpecMaximum
FrameSpecMinimum G GetBuildDate GetCVSDate GetDataFormatVersion
GetFrameLibraryMinorVersion GetType GetVersion HostByteOrder MustHaveEOFChecksum
MustHaveEOFChecksum S Strict Strict T
T UseMemoryMappedIO UseMemoryMappedIO VFrameReader ValidateMetadata
ValidateMetadata append append append begin
end end erase erase insert
insert insert insert insert insert
int operator = p p rbegin
rend rend set_channel_site value

Member Descriptions:

Members of type typedef


FrameCPP::Base

FrameCPP::Dimension

FrameCPP::FrAdcData

FrameCPP::FrDetector

FrameCPP::FrEndOfFile

FrameCPP::FrEndOfFrame

FrameCPP::FrEvent

FrameCPP::FrHeader

FrameCPP::FrHistory

FrameCPP::FrMsg

FrameCPP::FrProcData

FrameCPP::FrRawData

FrameCPP::FrSE

FrameCPP::FrSH

FrameCPP::FrSerData

FrameCPP::FrSimData

FrameCPP::FrSimEvent

FrameCPP::FrStatData

FrameCPP::FrSummary

FrameCPP::FrTOC

FrameCPP::FrTable

FrameCPP::FrVect

FrameCPP::FrameH

FrameCPP::FrameWriterImage

FrameCPP::IFrameStream

FrameCPP::OFrameStream

FrameCPP::STRING
Typedef for STRING type in frames


FrameCPP::Time

FrameCPP::version_type
Supports version 6 of spec Typedef for version information

Members of type function


FrameCPP::Base
class FrameFilename


FrameCPP::BufferSize

FrameCPP::BufferSize

Parameters:
NameTypeDescription
INT_8Uestablish the size in bytes of the I/O buffer. A value of 0 sets the buffer size to the system specified default.


FrameCPP::CheckDataValid

Return value:
bool - state of checking that the data valid field is zero


FrameCPP::CheckDataValid

Parameters:
NameTypeDescription
Checkbool true if the data valid field must be zero, false otherwise.


FrameCPP::CheckFileChecksum

Return value:
bool - true if checksums for frame files need to be performed, false otherwise.


FrameCPP::CheckFileChecksum

Parameters:
NameTypeDescription
Checkbool true if checksums for frame files need to be performed, false otherwise.


FrameCPP::CheckFrameChecksum

Return value:
bool - true if checksums for individual frames need to be performed, false otherwise.


FrameCPP::CheckFrameChecksum

Parameters:
NameTypeDescription
Checkbool true if checksums for individual frames need to be performed, false otherwise.


FrameCPP::CheckMD5Sum

Return value:
bool - true if md5sum for the frame file will be performed, false otherwise.


FrameCPP::CheckMD5Sum

Parameters:
NameTypeDescription
Checkbool true if md5sum for the frame file should be performed, false otherwise.


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

Parameters:
NameTypeDescription
cconst ContainerBasic< T >& The container to copy from
cconst ContainerBasic< T >& The container to assign from.
cconst ContainerBasic< T >& The container to compare with.
cconst ContainerBasic< 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 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:
ExceptionDescription
None.
std::bad_allocMemory allocation failed.
None.
std::bad_allocMemory allocation failed.
frame_mismatch`T' mismatch.
None.
None.
None.
None.
None.
None.


FrameCPP::D

FrameCPP::Dir

FrameCPP::ErrorInfo

Return value:
const std::string& - Additional error information


FrameCPP::Ext

FrameCPP::FrAdcDataBase

FrameCPP::FrameHBase

FrameCPP::FrameSpecCurrent - Currentently supported frame specification

FrameCPP::FrameSpecMaximum - Maximum supported frame spec
This may be one larger than the current frame specification


FrameCPP::FrameSpecMinimum - The earliest supported frame specification

FrameCPP::G

FrameCPP::GetBuildDate - Get the date when frameCPP was built.

Return value:
std::string - The string representation of when the library was built


FrameCPP::GetCVSDate - Get the CVS date for this version of frameCPP
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


FrameCPP::GetDataFormatVersion - Return the data format version

Return value:
INT_2U - current version of frame spec.


FrameCPP::GetFrameLibraryMinorVersion - Return the minor version of the frame library

Return value:
INT_2U - current minor version for the frame library


FrameCPP::GetType

FrameCPP::GetVersion - Get the version of frameCPP

Return value:
std::string - The string representation of the version of frameCPP


FrameCPP::HostByteOrder - Byte ordering of host

FrameCPP::MustHaveEOFChecksum

Return value:
bool - true if the frame file must have the EOF checksum structure, false otherwise


FrameCPP::MustHaveEOFChecksum

Parameters:
NameTypeDescription
Conformancebool true if the frame file must have the EOF checksum structure, false otherwise


FrameCPP::S

FrameCPP::Strict

Return value:
bool - state of strictness. True for strict conformance to the frame spec; false otherwise.


FrameCPP::Strict

Parameters:
NameTypeDescription
Strictnessbool true if the frame file must conform to all details of the frame spec; false otherwise.


FrameCPP::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::T

FrameCPP::UseMemoryMappedIO

Return value:
bool - true if memory mapped I/O will be used


FrameCPP::UseMemoryMappedIO

Parameters:
NameTypeDescription
UseMemoryMappedIObool true if memory mapped I/O should be used; false otherwise.


FrameCPP::VFrameReader

FrameCPP::ValidateMetadata

Return value:
bool - true if metadata should be validated


FrameCPP::ValidateMetadata

Parameters:
NameTypeDescription
ValidateMetadatabool true if frame metadata to be verified against against the filename


FrameCPP::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::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::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::begin - Returns an iterator at the beginning of the container.

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

Exceptions:
ExceptionDescription
None.


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

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

Exceptions:
ExceptionDescription
None.


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

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

Exceptions:
ExceptionDescription
None.


FrameCPP::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::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::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::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::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::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::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::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::int - Returns the size of the container.

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

Exceptions:
ExceptionDescription
None.


FrameCPP::operator = - Assignment operator.
This copies another container to this one. Ownership is handled in the same manner as in the copy constructor.

Parameters:
NameTypeDescription
cconst ContainerBasic< T >& The container to assign from.

Return value:
const ContainerBasic< T >& - - This container.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.


FrameCPP::p

FrameCPP::p

FrameCPP::rbegin

FrameCPP::rend

FrameCPP::rend

FrameCPP::set_channel_site

FrameCPP::value