ldas-tools-framecpp
2.6.2
|
#include <FrSH.hh>
Public Types | |
typedef INT_2U | cmn_classId_type |
typedef IStringStream | assign_stream_type |
typedef FrameSpec::version_type | frame_spec_version_type |
typedef boost::shared_ptr< Object > | object_type |
typedef std::unique_ptr< Object > | unique_object_type |
typedef object_type | demote_arg_type |
typedef object_type | demote_ret_type |
typedef object_type | promote_arg_type |
typedef object_type | promote_ret_type |
enum | { DT_CHAR_PTR, DT_STRING_2, DT_INT_2S, DT_INT_2U, DT_INT_4S, DT_INT_4U, DT_INT_8S, DT_INT_8U, DT_REAL_4, DT_REAL_8 } |
enum | { IC_EOQ, IC_AMPLITUDE, IC_CHANNEL_ID, IC_DATA_QUALITY, IC_DATA_VALID, IC_DETECTOR, IC_DETECTOR_PREFIX, IC_DT, IC_END, IC_FRAME, IC_GROUP_ID, IC_GTIME_N, IC_GTIME_S, IC_ID, IC_LOCAL_TIME, IC_NAME, IC_RUN, IC_START, IC_ULEAP_S, IC_VERSION } |
typedef STRING< INT_2U > | string_2_type |
Public Member Functions | |
FrSH () | |
FrSH (const std::string &Name, INT_2U ClassId, const std::string &Comment) | |
virtual | ~FrSH () |
virtual INT_8U | Bytes (const Common::StreamBase &Stream) const |
Return the number of bytes for this object. More... | |
virtual const char * | ObjectStructName () const |
Retrieve the class name of the object. More... | |
INT_2U | GetClass () const |
const std::string & | GetComment () const |
const STRING & | GetName () const |
virtual FrSH * | Clone () const |
constructor - virtual copy constructor More... | |
virtual FrSH * | Create (istream_type &Stream) const |
constructor - virtual More... | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. More... | |
bool | operator== (const FrSH &RHS) const |
comparison operator More... | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
comparison operator 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... | |
virtual Object * | Create () const |
constructor - virtual More... | |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual 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... | |
void | TOCQuery (int InfoClass,...) const |
Static Public Member Functions | |
static const char * | StructName () |
static object_type | DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream) |
Down grade an object. More... | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream) |
Upgrade an object. More... | |
template<typename PreviousType , typename CurrentType > | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream) |
Upgrade an object. More... | |
template<class T > | |
static int | DataType (const T *Data) |
template<class T > | |
static int | DataType (const T &Data) |
Protected Member Functions | |
virtual const std::string & | name () const |
virtual INT_2U | classId () const |
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 void | vTOCQuery (int InfoClass, va_list vl) const |
virtual void | assign (assign_stream_type &Stream) |
Assign the contents of the instance. More... | |
virtual class_type | getClass () const |
Retrieve the class identifier. More... | |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
FrameCPP::Version_3::FrSH::FrSH | ( | ) |
FrameCPP::Version_3::FrSH::FrSH | ( | const std::string & | Name, |
INT_2U | ClassId, | ||
const std::string & | Comment | ||
) |
|
virtual |
|
protectedvirtual |
Assign the contents of the instance.
[in] | Stream | An input stream from which to read information for the instance. |
Implements FrameCPP::Common::FrSH.
|
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.
|
protectedvirtual |
Implements FrameCPP::Common::FrSH.
|
virtual |
constructor - virtual copy constructor
Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
constructor - virtual
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtualinherited |
constructor - virtual
Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_6::FrTOC, and FrameCPP::Version_4::FrTOC.
|
virtualinherited |
constructor - virtual
Reimplemented in FrameCPP::Version_8::FrHeader, and FrameCPP::Version_3::FrHeader.
|
staticinherited |
|
staticinherited |
|
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. |
|
inline |
|
protectedvirtualinherited |
Retrieve the class identifier.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inline |
|
inlinevirtualinherited |
Retrieve FrSH/FrSE description of the parent object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inline |
|
protectedvirtual |
Implements FrameCPP::Common::FrSH.
|
virtual |
Retrieve the class name of the object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
bool FrameCPP::Version_3::FrSH::operator== | ( | const FrSH & | RHS | ) | const |
comparison operator
|
virtual |
comparison operator
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. |
|
inherited |
|
inlinestatic |
|
inlineinherited |
|
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_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_8::FrameH, FrameCPP::Version_6::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_4::FrEndOfFile, and FrameCPP::Version_3::FrEndOfFile.
|
protectedvirtual |
Implements FrameCPP::Common::TOCInfo.
|
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. |