Static Data Structure Definition.
More...
#include <FrStatData.hh>
Inherits FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, FrStatDataNPS, FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >, FrameCPP::Common::TOCInfo, FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, FrStatDataNPS, FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >, and FrameCPP::Common::TOCInfo.
|
| FrStatData () |
| Default constructor. More...
|
|
| FrStatData (const FrStatData &Source) |
| Copy Constructor. More...
|
|
| FrStatData (const std::string &name, const std::string &comment, const std::string &representation, INT_4U timeStart, INT_4U timeEnd, INT_4U version) |
| Constructor. More...
|
|
| FrStatData (const Previous::FrStatData &Source, istream_type *Stream) |
| Promotion Constructor. More...
|
|
virtual FrStatData * | Clone () const |
| Virtual constructor. More...
|
|
virtual fr_detector_type | GetDetector () const |
| Retrieve the detector associated with the object. More...
|
|
virtual const char * | ObjectStructName () const |
| The name structure name of this object. More...
|
|
FrStatData & | Merge (const FrStatData &RHS) |
| Merge with another FrAdcData. More...
|
|
bool | operator== (const FrStatData &RHS) const |
| equality operator More...
|
|
virtual bool | operator== (const Common::FrameSpec::Object &RHS) const |
| equality operator for abstract data type More...
|
|
| FrStatData () |
| Default constructor. More...
|
|
| FrStatData (const FrStatData &Source) |
| Copy Constructor. More...
|
|
| FrStatData (const std::string &name, const std::string &comment, const std::string &representation, INT_4U timeStart, INT_4U timeEnd, INT_4U version) |
| Constructor. More...
|
|
| FrStatData (const Previous::FrStatData &Source, istream_type *Stream) |
| Promotion Constructor. More...
|
|
virtual FrStatData * | Clone () const |
| Virtual constructor. More...
|
|
virtual fr_detector_type | GetDetector () const |
| Retrieve the detector associated with the object. More...
|
|
virtual const char * | ObjectStructName () const |
| The name structure name of this object. More...
|
|
FrStatData & | Merge (const FrStatData &RHS) |
| Merge with another FrAdcData. More...
|
|
bool | operator== (const FrStatData &RHS) const |
| equality operator More...
|
|
virtual bool | operator== (const Common::FrameSpec::Object &RHS) const |
| equality operator for abstract data type More...
|
|
virtual streamsize_type | Bytes (const StreamBase &Stream) const |
| Return the number of bytes for this object. More...
|
|
virtual streamsize_type | Bytes (const StreamBase &Stream) const |
| Return the number of bytes for this object. More...
|
|
virtual self_type * | Create (istream_type &Stream) const |
| Virtual constructor. More...
|
|
virtual self_type * | Create (istream_type &Stream) const |
| Virtual constructor. More...
|
|
virtual void | Write (ostream_type &Stream) const |
| Write object to the stream.
|
|
virtual void | Write (ostream_type &Stream) const |
| Write object to the stream.
|
|
|
static promote_ret_type | Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream) |
| Promote previous version of object to this version. More...
|
|
static const char * | StructName () |
| The name structure name of this object. More...
|
|
static const Common::Description * | StructDescription () |
| The description of structure. More...
|
|
static promote_ret_type | Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream) |
| Promote previous version of object to this version. More...
|
|
static const char * | StructName () |
| The name structure name of this object. More...
|
|
static const Common::Description * | StructDescription () |
| The description of structure. More...
|
|
static const char * | CheckSumDataClass () |
| Data class to be used in class field of FrSE.
|
|
static const char * | CheckSumDataClass () |
| Data class to be used in class field of FrSE.
|
|
static const char * | CheckSumDataComment () |
| Comment to be used in comment field of FrSE.
|
|
static const char * | CheckSumDataComment () |
| Comment to be used in comment field of FrSE.
|
|
|
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const |
| Demotes object to previous version of the frame spec. More...
|
|
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const |
| Promotes object to another version of the frame spec. More...
|
|
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
| Number of bytes needed to write this structure. More...
|
|
virtual FrStatData * | pCreate (istream_type &Stream) const |
| Virtual constructor. More...
|
|
virtual void | pWrite (ostream_type &Stream) const |
| Write the structure to the stream. More...
|
|
virtual void | vTOCQuery (int InfoClass, va_list vl) const |
| Answer requests for information as needed by TOC. More...
|
|
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const |
| Demotes object to previous version of the frame spec. More...
|
|
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const |
| Promotes object to another version of the frame spec. More...
|
|
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
| Number of bytes needed to write this structure. More...
|
|
virtual FrStatData * | pCreate (istream_type &Stream) const |
| Virtual constructor. More...
|
|
virtual void | pWrite (ostream_type &Stream) const |
| Write the structure to the stream. More...
|
|
virtual void | vTOCQuery (int InfoClass, va_list vl) const |
| Answer requests for information as needed by TOC. More...
|
|
virtual void | pWrite (ostream_type &Stream) const=0 |
| Write the structure to the stream. More...
|
|
Static Data Structure Definition.
◆ FrStatData() [1/8]
FrameCPP::Version_8::FrStatData::FrStatData |
( |
| ) |
|
Default constructor.
- Returns
- A new instance of this object.
◆ FrStatData() [2/8]
FrameCPP::Version_8::FrStatData::FrStatData |
( |
const FrStatData & |
Source | ) |
|
Copy Constructor.
- Parameters
-
[in] | Source | The object from which to copy the information. |
- Returns
- A new instance of this object.
◆ FrStatData() [3/8]
FrameCPP::Version_8::FrStatData::FrStatData |
( |
const std::string & |
name, |
|
|
const std::string & |
comment, |
|
|
const std::string & |
representation, |
|
|
INT_4U |
timeStart, |
|
|
INT_4U |
timeEnd, |
|
|
INT_4U |
version |
|
) |
| |
Constructor.
- Parameters
-
[in] | name | Static data name |
[in] | comment | Comemnt |
[in] | representation | Type of static data being represented |
[in] | timeStart | Start time of static data validity. |
[in] | timeEnd | End time of static data validity. |
[in] | version | Version number of this static structure. |
- Returns
- A new instance of the object.
◆ FrStatData() [4/8]
FrameCPP::Version_8::FrStatData::FrStatData |
( |
const Previous::FrStatData & |
Source, |
|
|
istream_type * |
Stream |
|
) |
| |
Promotion Constructor.
- Parameters
-
[in] | Source | An FrAdcData structure from a previous frame specification. |
[in] | Stream | The stream from which the earliest version of the FrAdcData structure was read. |
- Returns
- A new instance of the object.
◆ FrStatData() [5/8]
FrameCPP::Version_8::FrStatData::FrStatData |
( |
| ) |
|
Default constructor.
- Returns
- A new instance of this object.
◆ FrStatData() [6/8]
FrameCPP::Version_8::FrStatData::FrStatData |
( |
const FrStatData & |
Source | ) |
|
Copy Constructor.
- Parameters
-
[in] | Source | The object from which to copy the information. |
- Returns
- A new instance of this object.
◆ FrStatData() [7/8]
FrameCPP::Version_8::FrStatData::FrStatData |
( |
const std::string & |
name, |
|
|
const std::string & |
comment, |
|
|
const std::string & |
representation, |
|
|
INT_4U |
timeStart, |
|
|
INT_4U |
timeEnd, |
|
|
INT_4U |
version |
|
) |
| |
Constructor.
- Parameters
-
[in] | name | Static data name |
[in] | comment | Comemnt |
[in] | representation | Type of static data being represented |
[in] | timeStart | Start time of static data validity. |
[in] | timeEnd | End time of static data validity. |
[in] | version | Version number of this static structure. |
- Returns
- A new instance of the object.
◆ FrStatData() [8/8]
FrameCPP::Version_8::FrStatData::FrStatData |
( |
const Previous::FrStatData & |
Source, |
|
|
istream_type * |
Stream |
|
) |
| |
Promotion Constructor.
- Parameters
-
[in] | Source | An FrAdcData structure from a previous frame specification. |
[in] | Stream | The stream from which the earliest version of the FrAdcData structure was read. |
- Returns
- A new instance of the object.
◆ Bytes() [1/2]
Return the number of bytes for this object.
- Parameters
-
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
- Returns
- The number of bytes for this object
◆ Bytes() [2/2]
Return the number of bytes for this object.
- Parameters
-
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
- Returns
- The number of bytes for this object
◆ Clone() [1/2]
virtual FrStatData* FrameCPP::Version_8::FrStatData::Clone |
( |
| ) |
const |
|
virtual |
Virtual constructor.
- Returns
- A new instance of FrameH based on Obj
- Deprecated:
- Do not make this call as it will be gone by version 1.14.0.
◆ Clone() [2/2]
FrStatData * FrameCPP::Version_8::FrStatData::Clone |
( |
| ) |
const |
|
virtual |
Virtual constructor.
- Returns
- A new instance of FrameH based on Obj
- Deprecated:
- Do not make this call as it will be gone by version 1.14.0.
◆ Create() [1/2]
Virtual constructor.
- Parameters
-
[in] | Stream | The input stream from where the object is being read. |
- Returns
- Return pointer to the newly allocated resource.
◆ Create() [2/2]
Virtual constructor.
- Parameters
-
[in] | Stream | The input stream from where the object is being read. |
- Returns
- Return pointer to the newly allocated resource.
◆ demote() [1/2]
FrStatData::demote_ret_type FrameCPP::Version_8::FrStatData::demote |
( |
INT_2U |
Target, |
|
|
demote_arg_type |
Obj, |
|
|
istream_type * |
Stream |
|
) |
| const |
|
protectedvirtual |
Demotes object to previous version of the frame spec.
- Parameters
-
[in] | Target | The version of the frame specification to demote too. |
[in] | Obj | The version of the object to demote. |
[in] | Stream | The input stream from which the original object was read. |
- Returns
- An object of the previous generation.
◆ demote() [2/2]
virtual demote_ret_type FrameCPP::Version_8::FrStatData::demote |
( |
INT_2U |
Target, |
|
|
demote_arg_type |
Obj, |
|
|
istream_type * |
Stream |
|
) |
| const |
|
protectedvirtual |
Demotes object to previous version of the frame spec.
- Parameters
-
[in] | Target | The version of the frame specification to demote too. |
[in] | Obj | The version of the object to demote. |
[in] | Stream | The input stream from which the original object was read. |
- Returns
- An object of the previous generation.
◆ GetDetector() [1/2]
virtual fr_detector_type FrameCPP::Version_8::FrStatData::GetDetector |
( |
| ) |
const |
|
inlinevirtual |
Retrieve the detector associated with the object.
- Returns
- The detector associated with the object.
◆ GetDetector() [2/2]
virtual fr_detector_type FrameCPP::Version_8::FrStatData::GetDetector |
( |
| ) |
const |
|
inlinevirtual |
Retrieve the detector associated with the object.
- Returns
- The detector associated with the object.
◆ Merge() [1/2]
Merge with another FrAdcData.
- Parameters
-
[in] | RHS | The source of the information to append to this FrAdcData structure. |
- Returns
- A reference to this object
◆ Merge() [2/2]
Merge with another FrAdcData.
- Parameters
-
[in] | RHS | The source of the information to append to this FrAdcData structure. |
- Returns
- A reference to this object
- Todo:
- Need to implement Merge routine
◆ ObjectStructName() [1/2]
virtual const char* FrameCPP::Version_8::FrStatData::ObjectStructName |
( |
| ) |
const |
|
virtual |
The name structure name of this object.
- Returns
- The name of the structure as specified by the frame specification.
◆ ObjectStructName() [2/2]
const char * FrameCPP::Version_8::FrStatData::ObjectStructName |
( |
| ) |
const |
|
virtual |
The name structure name of this object.
- Returns
- The name of the structure as specified by the frame specification.
◆ operator==() [1/4]
bool FrameCPP::Version_8::FrStatData::operator== |
( |
const FrStatData & |
RHS | ) |
const |
|
inline |
equality operator
- Parameters
-
- Returns
- The value true is returned if this object is equivelent to the RHS instance; false otherwise.
◆ operator==() [2/4]
bool FrameCPP::Version_8::FrStatData::operator== |
( |
const FrStatData & |
RHS | ) |
const |
equality operator
- Parameters
-
- Returns
- The value true is returned if this object is equivelent to the RHS instance; false otherwise.
◆ operator==() [3/4]
equality operator for abstract data type
- Parameters
-
[in] | RHS | The object to be compared. |
- Returns
- The value true is returned if this object is equivelent to the RHS instance; false otherwise.
◆ operator==() [4/4]
equality operator for abstract data type
- Parameters
-
[in] | RHS | The object to be compared. |
- Returns
- The value true is returned if this object is equivelent to the RHS instance; false otherwise.
◆ pBytes() [1/2]
FrameCPP::cmn_streamsize_type FrameCPP::Version_8::FrStatData::pBytes |
( |
const Common::StreamBase & |
Stream | ) |
const |
|
protectedvirtual |
◆ pBytes() [2/2]
cmn_streamsize_type FrameCPP::Version_8::FrStatData::pBytes |
( |
const Common::StreamBase & |
Stream | ) |
const |
|
protectedvirtual |
◆ pCreate() [1/2]
virtual FrStatData* FrameCPP::Version_8::FrStatData::pCreate |
( |
istream_type & |
Stream | ) |
const |
|
protectedvirtual |
◆ pCreate() [2/2]
FrStatData * FrameCPP::Version_8::FrStatData::pCreate |
( |
istream_type & |
Stream | ) |
const |
|
protectedvirtual |
◆ Promote() [1/2]
static promote_ret_type FrameCPP::Version_8::FrStatData::Promote |
( |
INT_2U |
Source, |
|
|
promote_arg_type |
Obj, |
|
|
istream_type * |
Stream |
|
) |
| |
|
static |
Promote previous version of object to this version.
- Parameters
-
[in] | Source | The frame specification version of the object. |
[in] | Obj | The previous version of the object. |
[in] | Stream | Stream from which the origional object was created. |
- Returns
- A new instance of FrameH based on Obj
◆ Promote() [2/2]
FrStatData::promote_ret_type FrameCPP::Version_8::FrStatData::Promote |
( |
INT_2U |
Source, |
|
|
promote_arg_type |
Obj, |
|
|
istream_type * |
Stream |
|
) |
| |
|
inlinestatic |
Promote previous version of object to this version.
- Parameters
-
[in] | Source | The frame specification version of the object. |
[in] | Obj | The previous version of the object. |
[in] | Stream | Stream from which the origional object was created. |
- Returns
- A new instance of FrameH based on Obj
◆ promote() [1/2]
virtual promote_ret_type FrameCPP::Version_8::FrStatData::promote |
( |
INT_2U |
Target, |
|
|
promote_arg_type |
Obj, |
|
|
istream_type * |
Stream |
|
) |
| const |
|
protectedvirtual |
Promotes object to another version of the frame spec.
- Parameters
-
[in] | Target | The version of the promoted frame specification. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
- Returns
- An object promoted to the next generation.
◆ promote() [2/2]
FrStatData::promote_ret_type FrameCPP::Version_8::FrStatData::promote |
( |
INT_2U |
Target, |
|
|
promote_arg_type |
Obj, |
|
|
istream_type * |
Stream |
|
) |
| const |
|
protectedvirtual |
Promotes object to another version of the frame spec.
- Parameters
-
[in] | Target | The version of the promoted frame specification. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
- Returns
- An object promoted to the next generation.
◆ pWrite() [1/3]
virtual void FrameCPP::Version_8::FrStatData::pWrite |
( |
ostream_type & |
Stream | ) |
const |
|
protectedvirtual |
Write the structure to the stream.
- Parameters
-
[in] | Stream | The output stream where the object is to be written. |
◆ pWrite() [2/3]
void FrameCPP::Version_8::FrStatData::pWrite |
( |
ostream_type & |
Stream | ) |
const |
|
protectedvirtual |
Write the structure to the stream.
- Parameters
-
[in] | Stream | The output stream where the object is to be written. |
◆ pWrite() [3/3]
|
protectedpure virtualinherited |
Write the structure to the stream.
- Parameters
-
[in] | Stream | The output stream where the object is to be written. |
Implemented in FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, and FrameCPP::Version_8::FrSE.
◆ StructDescription() [1/2]
static const Common::Description* FrameCPP::Version_8::FrStatData::StructDescription |
( |
| ) |
|
|
static |
The description of structure.
- Returns
- A Description object which describes this structure as specified by the frame specification.
◆ StructDescription() [2/2]
const Description * FrameCPP::Version_8::FrStatData::StructDescription |
( |
| ) |
|
|
static |
The description of structure.
- Returns
- A Description object which describes this structure as specified by the frame specification.
◆ StructName() [1/2]
static const char* FrameCPP::Version_8::FrStatData::StructName |
( |
| ) |
|
|
static |
The name structure name of this object.
- Returns
- The name of the structure as specified by the frame specification.
◆ StructName() [2/2]
const char * FrameCPP::Version_8::FrStatData::StructName |
( |
| ) |
|
|
inlinestatic |
The name structure name of this object.
- Returns
- The name of the structure as specified by the frame specification.
◆ vTOCQuery() [1/2]
void FrameCPP::Version_8::FrStatData::vTOCQuery |
( |
int |
InfoClass, |
|
|
va_list |
vl |
|
) |
| const |
|
protectedvirtual |
Answer requests for information as needed by TOC.
- Parameters
-
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
◆ vTOCQuery() [2/2]
virtual void FrameCPP::Version_8::FrStatData::vTOCQuery |
( |
int |
InfoClass, |
|
|
va_list |
vl |
|
) |
| const |
|
protectedvirtual |
Answer requests for information as needed by TOC.
- Parameters
-
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
The documentation for this class was generated from the following files:
- /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-2.7.0/include/framecpp/Version8/FrStatData.hh
- Version8/FrStatData.cc