ldas-tools-framecpp
2.7.0
|
#include <FrEndOfFrame.hh>
Classes | |
struct | data_type |
Public Types | |
typedef INT_4S | run_type |
typedef INT_4U | frame_type |
typedef INT_4U | chkType_type |
typedef INT_4U | chkSum_type |
typedef INT_4S | run_type |
typedef INT_4U | frame_type |
typedef INT_4U | chkType_type |
typedef INT_4U | chkSum_type |
typedef FrameSpec::version_type | frame_spec_version_type |
typedef FrameSpec::version_type | frame_spec_version_type |
typedef boost::shared_ptr< Object > | object_type |
typedef boost::shared_ptr< Object > | object_type |
typedef std::unique_ptr< Object > | unique_object_type |
typedef std::unique_ptr< Object > | unique_object_type |
typedef object_type | demote_arg_type |
typedef object_type | demote_arg_type |
typedef object_type | demote_ret_type |
typedef object_type | demote_ret_type |
typedef object_type | promote_arg_type |
typedef object_type | promote_arg_type |
typedef object_type | promote_ret_type |
typedef object_type | promote_ret_type |
Public Member Functions | |
FrEndOfFrame () | |
FrEndOfFrame (INT_4S Run, INT_4U Frame) | |
virtual | ~FrEndOfFrame () |
INT_8U | Bytes () const |
INT_4S | GetRun () const |
INT_4U | GetFrame () const |
INT_4U | GetChkType () const |
INT_4U | GetChkSum () const |
virtual cmn_streamsize_type | Bytes (const Common::StreamBase &Stream) const |
Return the number of bytes for this object. More... | |
virtual FrEndOfFrame * | Create (istream_type &Stream) const |
constructor - virtual More... | |
virtual const char * | ObjectStructName () const |
Retrieve the class name of the object. More... | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. More... | |
bool | operator== (const FrEndOfFrame &RHS) const |
comparison operator More... | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
comparison operator More... | |
FrEndOfFrame () | |
FrEndOfFrame (INT_4S Run, INT_4U Frame) | |
virtual | ~FrEndOfFrame () |
INT_8U | Bytes () const |
INT_4S | GetRun () const |
INT_4U | GetFrame () const |
INT_4U | GetChkType () const |
INT_4U | GetChkSum () const |
virtual cmn_streamsize_type | Bytes (const Common::StreamBase &Stream) const |
Return the number of bytes for this object. More... | |
virtual FrEndOfFrame * | Create (istream_type &Stream) const |
constructor - virtual More... | |
virtual const char * | ObjectStructName () const |
Retrieve the class name of the object. More... | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. More... | |
bool | operator== (const FrEndOfFrame &RHS) const |
comparison operator More... | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
comparison operator More... | |
class_type | GetClass () const |
Retrieve the class identifier. More... | |
class_type | GetClass () const |
Retrieve the class identifier. More... | |
const Description * | GetDescription () const |
Retrieve FrSH/FrSE description of the parent object. More... | |
const Description * | GetDescription () const |
Retrieve FrSH/FrSE description of the parent object. More... | |
ostream_type & | WriteNext (ostream_type &Stream) const |
Write a next pointer to the parent to the stream. More... | |
ostream_type & | WriteNext (ostream_type &Stream) const |
Write a next pointer to the parent to the stream. More... | |
virtual Object * | Create () const |
constructor - virtual More... | |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual More... | |
virtual Object * | Clone () const |
constructor - virtual copy constructor More... | |
virtual Object * | Clone () const |
constructor - virtual copy constructor More... | |
template<typename PreviousType , typename CurrentType > | |
FrameSpec::ObjectInterface::promote_ret_type | PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, IStream *Stream) |
virtual void | VerifyObject (Verify &Verifier, IFrameStream &Stream) const |
Verify an object. More... | |
virtual void | VerifyObject (Verify &Verifier, IFrameStream &Stream) const |
Verify an object. More... | |
Protected Member Functions | |
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const |
Down grade an object. More... | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const |
Upgrade an object. More... | |
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const |
Down grade an object. More... | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const |
Upgrade an object. More... | |
virtual class_type | getClass () const |
Retrieve the class identifier. More... | |
virtual class_type | getClass () const |
Retrieve the class identifier. More... | |
Private Member Functions | |
FrEndOfFrame (istream_type &Stream) | |
FrEndOfFrame (istream_type &Stream) | |
Private Attributes | |
struct data_type | m_data |
const class_type | m_class |
Storage for the class identifier. More... | |
const Description *const | m_desc |
Description for parent class. More... | |
typedef INT_4U FrameCPP::Version_6::FrEndOfFrame::chkSum_type |
typedef INT_4U FrameCPP::Version_6::FrEndOfFrame::chkSum_type |
typedef INT_4U FrameCPP::Version_6::FrEndOfFrame::chkType_type |
typedef INT_4U FrameCPP::Version_6::FrEndOfFrame::chkType_type |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
typedef INT_4U FrameCPP::Version_6::FrEndOfFrame::frame_type |
typedef INT_4U FrameCPP::Version_6::FrEndOfFrame::frame_type |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
typedef INT_4S FrameCPP::Version_6::FrEndOfFrame::run_type |
typedef INT_4S FrameCPP::Version_6::FrEndOfFrame::run_type |
|
inherited |
|
inherited |
FrameCPP::Version_6::FrEndOfFrame::FrEndOfFrame | ( | ) |
FrameCPP::Version_6::FrEndOfFrame::FrEndOfFrame | ( | INT_4S | Run, |
INT_4U | Frame | ||
) |
|
virtual |
|
private |
FrameCPP::Version_6::FrEndOfFrame::FrEndOfFrame | ( | ) |
FrameCPP::Version_6::FrEndOfFrame::FrEndOfFrame | ( | INT_4S | Run, |
INT_4U | Frame | ||
) |
|
virtual |
|
private |
INT_8U FrameCPP::Version_6::FrEndOfFrame::Bytes | ( | ) | const |
INT_8U FrameCPP::Version_6::FrEndOfFrame::Bytes | ( | ) | const |
|
virtual |
Return the number of bytes for this object.
[in] | Stream | The stream on which the object will be written or read. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Return the number of bytes for this object.
[in] | Stream | The stream on which the object will be written or read. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtualinherited |
constructor - virtual copy constructor
Reimplemented in FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrameH, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrameH, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef< LT, CT, IT >, and FrameCPP::Common::PTR_STRUCT< DC, DI >.
|
virtualinherited |
constructor - virtual copy constructor
Reimplemented in FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrameH, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrameH, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef< LT, CT, IT >, and FrameCPP::Common::PTR_STRUCT< DC, DI >.
|
virtualinherited |
constructor - virtual
Reimplemented in FrameCPP::Version_6::FrTOC, FrameCPP::Version_4::FrTOC, FrameCPP::Version_6::FrTOC, and FrameCPP::Version_4::FrTOC.
|
virtual |
constructor - virtual
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
constructor - virtual
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtualinherited |
constructor - virtual
Reimplemented in FrameCPP::Version_8::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_8::FrHeader, and FrameCPP::Version_3::FrHeader.
|
protectedvirtual |
Down grade an object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
protectedvirtual |
Down grade an object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
Down grade an object.
[in] | Target | This is the version of the frame specification of the demoted object. |
[in] | Obj | The base object. |
[in] | Stream | Stream from which Obj was created. |
|
staticinherited |
Down grade an object.
[in] | Target | This is the version of the frame specification of the demoted object. |
[in] | Obj | The base object. |
[in] | Stream | Stream from which Obj was created. |
|
inline |
INT_4U FrameCPP::Version_6::FrEndOfFrame::GetChkSum | ( | ) | const |
|
inline |
INT_4U FrameCPP::Version_6::FrEndOfFrame::GetChkType | ( | ) | const |
|
inlineinherited |
Retrieve the class identifier.
|
protectedvirtualinherited |
Retrieve the class identifier.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inherited |
Retrieve the class identifier.
|
protectedvirtualinherited |
Retrieve the class identifier.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inlinevirtualinherited |
Retrieve FrSH/FrSE description of the parent object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtualinherited |
Retrieve FrSH/FrSE description of the parent object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inline |
INT_4U FrameCPP::Version_6::FrEndOfFrame::GetFrame | ( | ) | const |
|
inline |
INT_4S FrameCPP::Version_6::FrEndOfFrame::GetRun | ( | ) | const |
|
virtual |
Retrieve the class name of the object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Retrieve the class name of the object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
comparison operator
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
comparison operator
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
bool FrameCPP::Version_6::FrEndOfFrame::operator== | ( | const FrEndOfFrame & | RHS | ) | const |
comparison operator
bool FrameCPP::Version_6::FrEndOfFrame::operator== | ( | const FrEndOfFrame & | RHS | ) | const |
comparison operator
|
protectedvirtual |
Upgrade an object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
protectedvirtual |
Upgrade an object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
inherited |
|
static |
|
static |
|
inlinestatic |
|
static |
|
virtualinherited |
Verify an object.
[in,out] | Verifier | Set of rules to use in verification of the object. If an error occurs, the violation is logged here. |
[in] | Stream | The stream that is being used to read the object. |
Reimplemented in FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrEndOfFile, and FrameCPP::Version_3::FrameH.
|
virtualinherited |
Verify an object.
[in,out] | Verifier | Set of rules to use in verification of the object. If an error occurs, the violation is logged here. |
[in] | Stream | The stream that is being used to read the object. |
Reimplemented in FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrEndOfFile, and FrameCPP::Version_3::FrameH.
|
virtual |
Write object to the stream.
[in,out] | Stream | The stream being written with the contents of object. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Write object to the stream.
[in,out] | Stream | The stream being written with the contents of object. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inherited |
Write a next pointer to the parent to the stream.
[in,out] | Stream | The output stream to receive the next pointer. |
|
inherited |
Write a next pointer to the parent to the stream.
[in,out] | Stream | The output stream to receive the next pointer. |
|
privateinherited |
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.
|
private |
|
privateinherited |
Description for parent class.
The description for the parent class composed of one FrSH and one or more FrSE elements.