ldas-tools-framecpp 2.7.0
|
#include <FrSE.hh>
Classes | |
struct | image_t |
Public Types | |
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 | |
FrSE () | |
Default constructor. | |
FrSE (const std::string &Name, const std::string &ClassId, const std::string &Comment="") | |
constructor | |
virtual | ~FrSE () |
Desctructor. | |
INT_8U | Bytes (const Common::StreamBase &Stream) const |
Return the number of bytes needed to write this object. | |
virtual const char * | ObjectStructName () const |
Retrieve the class name of the object. | |
std::string | GetClass () const |
Return class of object. | |
std::string | GetComment () const |
Return comment of object. | |
std::string | GetName () const |
Return name of object. | |
virtual FrSE * | Create (istream_type &Stream) const |
Create a new instance of the object based on the input stream. | |
virtual FrSE * | Clone () const |
Create a new instance of the object based on an instance. | |
virtual void | Write (ostream_type &Stream) const |
Write the structure to the stream. | |
bool | operator== (const FrSE &RHS) const |
comparison operator | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
comparison operator | |
FrSE () | |
Default constructor. | |
FrSE (const std::string &Name, const std::string &ClassId, const std::string &Comment="") | |
constructor | |
virtual | ~FrSE () |
Desctructor. | |
INT_8U | Bytes (const Common::StreamBase &Stream) const |
Return the number of bytes needed to write this object. | |
virtual const char * | ObjectStructName () const |
Retrieve the class name of the object. | |
std::string | GetClass () const |
Return class of object. | |
std::string | GetComment () const |
Return comment of object. | |
std::string | GetName () const |
Return name of object. | |
virtual FrSE * | Create (istream_type &Stream) const |
Create a new instance of the object based on the input stream. | |
virtual FrSE * | Clone () const |
Create a new instance of the object based on an instance. | |
virtual void | Write (ostream_type &Stream) const |
Write the structure to the stream. | |
bool | operator== (const FrSE &RHS) const |
comparison operator | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
comparison operator | |
const Description * | GetDescription () const |
Retrieve FrSH/FrSE description of the parent object. | |
const Description * | GetDescription () const |
Retrieve FrSH/FrSE description of the parent object. | |
ostream_type & | WriteNext (ostream_type &Stream) const |
Write a next pointer to the parent to the stream. | |
ostream_type & | WriteNext (ostream_type &Stream) const |
Write a next pointer to the parent to the stream. | |
virtual Object * | Create () const |
constructor - virtual | |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual | |
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. | |
virtual void | VerifyObject (Verify &Verifier, IFrameStream &Stream) const |
Verify an object. | |
Static Public Member Functions | |
static const char * | StructName () |
static const char * | StructName () |
static object_type | DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream) |
Down grade an object. | |
static object_type | DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream) |
Down grade an object. | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream) |
Upgrade an object. | |
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. | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream) |
Upgrade an object. | |
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. | |
Protected Member Functions | |
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const |
Down grade an object. | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const |
Upgrade an object. | |
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const |
Down grade an object. | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const |
Upgrade an object. | |
virtual class_type | getClass () const |
Retrieve the class identifier. | |
virtual class_type | getClass () const |
Retrieve the class identifier. | |
Private Member Functions | |
FrSE (istream_type &Stream) | |
FrSE (istream_type &Stream) | |
Private Attributes | |
struct FrameCPP::Version_3::FrSE::image_t | m_data |
const class_type | m_class |
Storage for the class identifier. | |
const Description *const | m_desc |
Description for parent class. | |
Static Private Attributes | |
static const Common::FrameSpec::Info::frame_object_types | s_object_id = Common::FrameSpec::Info::FSI_FR_SE |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
FrameCPP::Version_3::FrSE::FrSE | ( | ) |
Default constructor.
FrameCPP::Version_3::FrSE::FrSE | ( | const std::string & | Name, |
const std::string & | ClassId, | ||
const std::string & | Comment = "" |
||
) |
constructor
|
virtual |
Desctructor.
|
private |
FrameCPP::Version_3::FrSE::FrSE | ( | ) |
Default constructor.
FrameCPP::Version_3::FrSE::FrSE | ( | const std::string & | Name, |
const std::string & | ClassId, | ||
const std::string & | Comment = "" |
||
) |
constructor
|
virtual |
Desctructor.
|
private |
|
virtual |
Return the number of bytes needed to write this object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Return the number of bytes needed to write this object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Create a new instance of the object based on an instance.
Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Create a new instance of the object based on an instance.
Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtualinherited |
constructor - virtual
Reimplemented in FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Version_4::FrTOC, FrameCPP::Version_6::FrTOC, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Version_4::FrTOC, and FrameCPP::Version_6::FrTOC.
|
virtual |
Create a new instance of the object based on the input stream.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Create a new instance of the object based on the input stream.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtualinherited |
constructor - virtual
Reimplemented in FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Version_3::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_3::FrHeader, and FrameCPP::Version_8::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. |
|
protectedvirtualinherited |
Retrieve the class identifier.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inline |
Return class of object.
|
protectedvirtualinherited |
Retrieve the class identifier.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
std::string FrameCPP::Version_3::FrSE::GetClass | ( | ) | const |
Return class of object.
|
inline |
Return comment of object.
std::string FrameCPP::Version_3::FrSE::GetComment | ( | ) | const |
Return comment of object.
|
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.
std::string FrameCPP::Version_3::FrSE::GetName | ( | ) | const |
Return name of object.
std::string FrameCPP::Version_3::FrSE::GetName | ( | ) | const |
Return name of object.
|
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_3::FrSE::operator== | ( | const FrSE & | RHS | ) | const |
comparison operator
bool FrameCPP::Version_3::FrSE::operator== | ( | const FrSE & | 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 |
|
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_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, and FrameCPP::Version_8::FrHeader.
|
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_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, and FrameCPP::Version_8::FrHeader.
|
virtual |
Write the structure to the stream.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtual |
Write the structure to the stream.
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.
|
staticprivate |