Interface to Objects. More...
#include <FrameSpec.hh>
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 stream_base_type | demote_stream_type |
typedef stream_base_type | demote_stream_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 |
typedef stream_base_type | promote_stream_type |
typedef stream_base_type | promote_stream_type |
Public Member Functions | |
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 (ostream_type &Stream) const=0 |
virtual const Description * | GetDescription () const=0 |
Get FrSH/FrSE description of object. | |
virtual const Description * | GetDescription (ostream_type &Stream) const=0 |
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. | |
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, promote_stream_type *Stream) |
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. | |
Protected Member Functions | |
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.
typedef FrameSpec::version_type FrameCPP::Common::FrameSpec::ObjectInterface::frame_spec_version_type |
typedef FrameSpec::version_type FrameCPP::Common::FrameSpec::ObjectInterface::frame_spec_version_type |
typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type |
typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type |
typedef std::unique_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::unique_object_type |
typedef std::unique_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::unique_object_type |
|
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.
|
virtual |
Destructor.
|
pure virtual |
Return the number of bytes for this object.
[in] | Stream | The stream on which the object will be written or read. |
|
pure virtual |
Return the number of bytes for this object.
[in] | Stream | The stream on which the object will be written or read. |
|
virtual |
constructor - virtual copy constructor
|
virtual |
constructor - virtual copy constructor
|
virtual |
constructor - virtual
|
virtual |
constructor - virtual
|
pure virtual |
constructor - virtual
|
pure virtual |
constructor - virtual
|
virtual |
constructor - virtual
|
virtual |
constructor - virtual
|
protectedpure virtual |
Demotes object to previous version of the frame spec.
[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. |
|
protectedpure virtual |
Demotes object to previous version of the frame spec.
[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. |
|
static |
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. |
|
static |
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. |
|
protectedpure virtual |
Retrieve the class name associated with the object.
|
protectedpure virtual |
Retrieve the class name associated with the object.
|
pure virtual |
Get FrSH/FrSE description of object.
|
pure virtual |
Get FrSH/FrSE description of object.
|
pure virtual |
|
pure virtual |
|
pure virtual |
Retrieve the class name of the object.
|
pure virtual |
Retrieve the class name of the object.
|
pure virtual |
comparison operator
|
pure virtual |
comparison operator
|
protectedpure virtual |
Promotes object to another version of the frame spec.
[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. |
|
protectedpure virtual |
Promotes object to another version of the frame spec.
[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. |
|
static |
|
static |
|
static |
|
static |
FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject | ( | FrameSpec::ObjectInterface::frame_spec_version_type | Target, |
FrameSpec::ObjectInterface::frame_spec_version_type | Source, | ||
FrameSpec::ObjectInterface::promote_arg_type | Obj, | ||
promote_stream_type * | Stream ) |
|
virtual |
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. |
|
virtual |
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. |
|
pure virtual |
Write object to the stream.
[in,out] | Stream | The stream being written with the contents of object. |
|
pure virtual |
Write object to the stream.
[in,out] | Stream | The stream being written with the contents of object. |