Base for all frame objects.
More...
#include <FrameSpec.hh>
Inherits FrameCPP::Common::FrameSpec::ObjectInterface, and FrameCPP::Common::FrameSpec::ObjectInterface.
Inherited by FrameCPP::Common::FrDetector, FrameCPP::Common::FrDetector, FrameCPP::Common::FrEndOfFile, FrameCPP::Common::FrEndOfFile, FrameCPP::Common::FrSH, FrameCPP::Common::FrSH, FrameCPP::Common::FrStatData, FrameCPP::Common::FrStatData, FrameCPP::Common::FrTOC, FrameCPP::Common::FrTOC, FrameCPP::Common::FrameH, FrameCPP::Common::FrameH, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::StreamRefInterface, FrameCPP::Common::StreamRefInterface, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHistory, FrameCPP::Version_3::FrHistory, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSerData, FrameCPP::Version_3::FrSerData, FrameCPP::Version_3::FrSimData, FrameCPP::Version_3::FrSimData, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_4::FrProcData, FrameCPP::Version_4::FrProcData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_4::FrSummary, FrameCPP::Version_4::FrSummary, FrameCPP::Version_4::FrTable, FrameCPP::Version_4::FrTable, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_6::FrEvent, FrameCPP::Version_6::FrEvent, FrameCPP::Version_6::FrMsg, FrameCPP::Version_6::FrMsg, FrameCPP::Version_6::FrProcData, FrameCPP::Version_6::FrProcData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSimData, FrameCPP::Version_6::FrSimData, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrSummary, FrameCPP::Version_6::FrSummary, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrRawData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_7::FrSerData, FrameCPP::Version_7::FrSerData, FrameCPP::Version_7::FrSimData, FrameCPP::Version_7::FrSimData, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_9::FrHeader, and FrameCPP::Version_9::FrHeader.
Base for all frame objects.
This is the base class for all frame objects that need to be written to or read from a frame stream.
◆ Object() [1/4]
constructor
Allocation of the object's resources.
- Parameters
-
◆ Object() [2/4]
FrameCPP::Common::FrameSpec::Object::Object |
( |
const Object & | Source | ) |
|
copy constructor
- Parameters
-
◆ Object() [3/4]
◆ Object() [4/4]
FrameCPP::Common::FrameSpec::Object::Object |
( |
const Object & | Source | ) |
|
copy constructor
- Parameters
-
◆ ~Object() [1/2]
FrameCPP::Common::FrameSpec::Object::~Object |
( |
| ) |
|
|
virtual |
◆ ~Object() [2/2]
virtual FrameCPP::Common::FrameSpec::Object::~Object |
( |
| ) |
|
|
virtual |
◆ FrameSpecVersion() [1/2]
◆ FrameSpecVersion() [2/2]
◆ GetClass() [1/2]
Retrieve the class identifier.
- Returns
- The class identifier.
◆ GetClass() [2/2]
class_type FrameCPP::Common::FrameSpec::Object::GetClass |
( |
| ) |
const |
Retrieve the class identifier.
- Returns
- The class identifier.
◆ getClass() [1/2]
◆ getClass() [2/2]
virtual class_type FrameCPP::Common::FrameSpec::Object::getClass |
( |
| ) |
const |
|
protectedvirtual |
◆ GetDescription() [1/4]
const Description * FrameCPP::Common::FrameSpec::Object::GetDescription |
( |
| ) |
const |
|
inlinevirtual |
◆ GetDescription() [2/4]
virtual const Description * FrameCPP::Common::FrameSpec::Object::GetDescription |
( |
| ) |
const |
|
virtual |
◆ GetDescription() [3/4]
const Description * FrameCPP::Common::FrameSpec::Object::GetDescription |
( |
ostream_type & | Stream | ) |
const |
|
virtual |
◆ GetDescription() [4/4]
virtual const Description * FrameCPP::Common::FrameSpec::Object::GetDescription |
( |
ostream_type & | Stream | ) |
const |
|
virtual |
◆ operator=() [1/2]
Assignement operator.
Assignment operator.
- Parameters
-
[in] | Source | The instance to replicate. |
- Returns
- The modified object.
◆ operator=() [2/2]
const Object & FrameCPP::Common::FrameSpec::Object::operator= |
( |
const Object & | Source | ) |
|
Assignement operator.
- Parameters
-
[in] | Source | The instance to replicate. |
- Returns
- The modified object.
◆ WriteNext() [1/2]
ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext |
( |
ostream_type & | Stream | ) |
const |
Write a next pointer to the parent to the stream.
- Parameters
-
[in,out] | Stream | The output stream to receive the next pointer. |
- Returns
- The output stream.
◆ WriteNext() [2/2]
ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext |
( |
ostream_type & | Stream | ) |
const |
Write a next pointer to the parent to the stream.
- Parameters
-
[in,out] | Stream | The output stream to receive the next pointer. |
- Returns
- The output stream.
◆ frame_spec_version
Version of the frame specification.
The version of the frame specification for which this object was created.
◆ m_class
const class_type FrameCPP::Common::FrameSpec::Object::m_class |
|
private |
Storage for the class identifier.
The class identifier uniquely identifies the parent class within the frame specification. All instances of parent class will have the same class identifier.
◆ m_desc
const Description *const FrameCPP::Common::FrameSpec::Object::m_desc |
|
private |
Description for parent class.
The description for the parent class composed of one FrSH and one or more FrSE elements.
The documentation for this class was generated from the following files:
- /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Common/FrameSpec.hh
- Common/FrameSpec.hh
- /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Common/FrameSpec.cc