Interface to Objects.
More...
#include <FrameSpec.hh>
|
virtual | ~ObjectInterface () |
| Destructor.
|
|
virtual | ~ObjectInterface () |
| Destructor.
|
|
virtual streamsize_type | Bytes (const stream_base_type &Stream) const=0 |
| Return the number of bytes for this object.
|
|
virtual streamsize_type | Bytes (const stream_base_type &Stream) const=0 |
| Return the number of bytes for this object.
|
|
virtual Object * | Create () const |
| constructor - virtual
|
|
virtual Object * | Create (istream_type &Stream) const=0 |
| constructor - virtual
|
|
virtual Object * | Create (std::istream &Buffer) const |
| constructor - virtual
|
|
virtual Object * | Create () const |
| constructor - virtual
|
|
virtual Object * | Create (istream_type &Stream) const=0 |
| constructor - virtual
|
|
virtual Object * | Create (std::istream &Buffer) const |
| constructor - virtual
|
|
virtual bool | operator== (const Object &Obj) const=0 |
| comparison operator
|
|
virtual bool | operator== (const Object &Obj) const=0 |
| comparison operator
|
|
virtual Object * | Clone () const |
| constructor - virtual copy constructor
|
|
virtual Object * | Clone () const |
| constructor - virtual copy constructor
|
|
virtual const Description * | GetDescription () const=0 |
| Get FrSH/FrSE description of object.
|
|
virtual const Description * | GetDescription () const=0 |
| Get FrSH/FrSE description of object.
|
|
virtual const char * | ObjectStructName () const=0 |
| Retrieve the class name of the object.
|
|
virtual const char * | ObjectStructName () const=0 |
| Retrieve the class name of the object.
|
|
virtual void | VerifyObject (Verify &Verifier, IFrameStream &Stream) const |
| Verify an object.
|
|
virtual void | VerifyObject (Verify &Verifier, IFrameStream &Stream) const |
| Verify an object.
|
|
virtual void | Write (ostream_type &Stream) const=0 |
| Write object to the stream.
|
|
virtual void | Write (ostream_type &Stream) const=0 |
| Write object to the stream.
|
|
|
static object_type | DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream) |
| Down grade an object.
|
|
static object_type | DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream) |
| Down grade an object.
|
|
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_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, stream_base_type *Stream) |
| Upgrade an object.
|
|
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_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, stream_base_type *Stream) |
| Upgrade an object.
|
|
|
virtual demote_ret_type | demote (frame_spec_version_type Target, demote_arg_type Obj, demote_stream_type *Stream) const=0 |
| Demotes object to previous version of the frame spec.
|
|
virtual demote_ret_type | demote (frame_spec_version_type Target, demote_arg_type Obj, demote_stream_type *Stream) const=0 |
| Demotes object to previous version of the frame spec.
|
|
virtual promote_ret_type | promote (frame_spec_version_type Target, promote_arg_type Obj, promote_stream_type *Stream) const=0 |
| Promotes object to another version of the frame spec.
|
|
virtual promote_ret_type | promote (frame_spec_version_type Target, promote_arg_type Obj, promote_stream_type *Stream) const=0 |
| Promotes object to another version of the frame spec.
|
|
virtual class_type | getClass () const=0 |
| Retrieve the class name associated with the object.
|
|
virtual class_type | getClass () const=0 |
| Retrieve the class name associated with the object.
|
|
Interface to Objects.
This interface should be the base of all frame objects. It allows for generic handling of frame objects.
◆ ~ObjectInterface()
FrameCPP::Common::FrameSpec::ObjectInterface::~ObjectInterface |
( |
| ) |
|
|
virtual |
Destructor.
Release the resources back to the system. By being virtual, all the resources associated with any derived class are given a chance for proper cleanup.
◆ Bytes() [1/2]
virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectInterface::Bytes |
( |
const stream_base_type & | Stream | ) |
const |
|
pure virtual |
Return the number of bytes for this object.
- Parameters
-
[in] | Stream | The stream on which the object will be written or read. |
- Returns
- The number of bytes required by this object for the specified stream.
◆ Bytes() [2/2]
virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectInterface::Bytes |
( |
const stream_base_type & | Stream | ) |
const |
|
pure virtual |
Return the number of bytes for this object.
- Parameters
-
[in] | Stream | The stream on which the object will be written or read. |
- Returns
- The number of bytes required by this object for the specified stream.
◆ demote() [1/2]
virtual demote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::demote |
( |
frame_spec_version_type | Target, |
|
|
demote_arg_type | Obj, |
|
|
demote_stream_type * | Stream ) const |
|
protectedpure virtual |
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::Common::FrameSpec::ObjectInterface::demote |
( |
frame_spec_version_type | Target, |
|
|
demote_arg_type | Obj, |
|
|
demote_stream_type * | Stream ) const |
|
protectedpure virtual |
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.
◆ DemoteObject() [1/2]
FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject |
( |
frame_spec_version_type | Target, |
|
|
object_type | Obj, |
|
|
demote_stream_type * | Stream ) |
|
static |
Down grade an object.
- Parameters
-
[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. |
- Returns
- A pointer to the objected derived by demoting Obj.
◆ DemoteObject() [2/2]
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject |
( |
frame_spec_version_type | Target, |
|
|
object_type | Obj, |
|
|
demote_stream_type * | Stream ) |
|
static |
Down grade an object.
- Parameters
-
[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. |
- Returns
- A pointer to the objected derived by demoting Obj.
◆ ObjectStructName() [1/2]
virtual const char * FrameCPP::Common::FrameSpec::ObjectInterface::ObjectStructName |
( |
| ) |
const |
|
pure virtual |
Retrieve the class name of the object.
- Returns
- The name of the class associated with the object.
◆ ObjectStructName() [2/2]
virtual const char * FrameCPP::Common::FrameSpec::ObjectInterface::ObjectStructName |
( |
| ) |
const |
|
pure virtual |
Retrieve the class name of the object.
- Returns
- The name of the class associated with the object.
◆ promote() [1/2]
virtual promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::promote |
( |
frame_spec_version_type | Target, |
|
|
promote_arg_type | Obj, |
|
|
promote_stream_type * | Stream ) const |
|
protectedpure virtual |
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]
virtual promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::promote |
( |
frame_spec_version_type | Target, |
|
|
promote_arg_type | Obj, |
|
|
promote_stream_type * | Stream ) const |
|
protectedpure virtual |
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.
◆ PromoteObject() [1/4]
FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject |
( |
frame_spec_version_type | Target, |
|
|
frame_spec_version_type | Source, |
|
|
object_type | Obj, |
|
|
stream_base_type * | Stream ) |
|
static |
Upgrade an object.
- Parameters
-
[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. |
- Returns
- A pointer to the objected derived by promoting Obj.
◆ PromoteObject() [2/4]
template<typename PreviousType, typename CurrentType>
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject |
( |
frame_spec_version_type | Target, |
|
|
frame_spec_version_type | Source, |
|
|
object_type | Obj, |
|
|
stream_base_type * | Stream ) |
|
static |
Upgrade an object.
- Parameters
-
[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. |
- Returns
- A pointer to the objected derived by promoting Obj.
◆ PromoteObject() [3/4]
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject |
( |
frame_spec_version_type | Target, |
|
|
frame_spec_version_type | Source, |
|
|
object_type | Obj, |
|
|
stream_base_type * | Stream ) |
|
static |
Upgrade an object.
- Parameters
-
[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. |
- Returns
- A pointer to the objected derived by promoting Obj.
◆ PromoteObject() [4/4]
template<typename PreviousType, typename CurrentType>
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject |
( |
frame_spec_version_type | Target, |
|
|
frame_spec_version_type | Source, |
|
|
object_type | Obj, |
|
|
stream_base_type * | Stream ) |
|
static |
Upgrade an object.
- Parameters
-
[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. |
- Returns
- A pointer to the objected derived by promoting Obj.
◆ VerifyObject() [1/2]
void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject |
( |
Verify & | Verifier, |
|
|
IFrameStream & | Stream ) const |
|
virtual |
Verify an object.
- Parameters
-
[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. |
◆ VerifyObject() [2/2]
virtual void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject |
( |
Verify & | Verifier, |
|
|
IFrameStream & | Stream ) const |
|
virtual |
Verify an object.
- Parameters
-
[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. |
◆ Write() [1/2]
virtual void FrameCPP::Common::FrameSpec::ObjectInterface::Write |
( |
ostream_type & | Stream | ) |
const |
|
pure virtual |
Write object to the stream.
- Parameters
-
[in,out] | Stream | The stream being written with the contents of object. |
◆ Write() [2/2]
virtual void FrameCPP::Common::FrameSpec::ObjectInterface::Write |
( |
ostream_type & | Stream | ) |
const |
|
pure virtual |
Write object to the stream.
- Parameters
-
[in,out] | Stream | The stream being written with the contents of object. |
The documentation for this class was generated from the following files:
- /home/abuild/rpmbuild/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/src/Common/FrameSpec.cc