FrameCPP::Version_4::FrameSpec::Object Class Reference

Base for all frame objects. More...

#include <FrameSpec.hh>

Inheritance diagram for FrameCPP::Version_4::FrameSpec::Object:

Collaboration diagram for FrameCPP::Version_4::FrameSpec::Object:

Public Member Functions
	Object (class_type Class, const Description *Description, frame_spec_version_type FrameSpec)
	constructor
	Object (const Object &Source)
	copy constructor
	Object (class_type Class, const Description *Description, frame_spec_version_type FrameSpec)
	constructor
	Object (const Object &Source)
	copy constructor
virtual	~Object ()
	destructor
virtual	~Object ()
	destructor
class_type	GetClass () const
	Retrieve the class identifier.
class_type	GetClass () const
	Retrieve the class identifier.
virtual const Description *	GetDescription () const
	Retrieve FrSH/FrSE description of the parent object.
virtual const Description *	GetDescription () const
	Retrieve FrSH/FrSE description of the parent object.
const Object &	operator= (const Object &Source)
	Assignement operator.
const Object &	operator= (const Object &Source)
	Assignement operator.
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.

Protected Member Functions
virtual class_type	getClass () const
	Retrieve the class identifier.
virtual class_type	getClass () const
	Retrieve the class identifier.

Detailed Description

Base for all frame objects.

This is the base class for all frame objects that need to be written to or read from a frame stream.

Constructor & Destructor Documentation

Object() [1/4]

FrameCPP::Common::FrameSpec::Object::Object	(	class_type	Class,
		const Description *	Description,
		frame_spec_version_type	FrameSpec )

constructor

Allocation of the object's resources.

Parameters

[in]	Class	A unique identifier that identifies the class of object.
[in]	Description	Description of the class

Object() [2/4]

FrameCPP::Common::FrameSpec::Object::Object

(

const Object &

Source

)

copy constructor

Parameters

[in]

Source

Object to duplicate

Object() [3/4]

FrameCPP::Common::FrameSpec::Object::Object	(	class_type	Class,
		const Description *	Description,
		frame_spec_version_type	FrameSpec )

constructor

Parameters

[in]	Class	A unique identifier that identifies the class of object.
[in]	Description	Description of the class

Object() [4/4]

FrameCPP::Common::FrameSpec::Object::Object

(

const Object &

Source

)

copy constructor

Parameters

[in]

Source

Object to duplicate

Member Function Documentation

GetClass() [1/2]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const

inline

Retrieve the class identifier.

Returns

The class identifier.

GetClass() [2/2]

class_type FrameCPP::Common::FrameSpec::Object::GetClass

(

)

const

Retrieve the class identifier.

Returns

The class identifier.

GetDescription() [1/2]

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const

inlinevirtual

Retrieve FrSH/FrSE description of the parent object.

Returns

The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

GetDescription() [2/2]

virtual const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const

virtual

Retrieve FrSH/FrSE description of the parent object.

Returns

The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

operator=() [1/2]

const FrameSpec::Object & FrameCPP::Common::FrameSpec::Object::operator= ( const Object & Source )

inline

Assignement operator.

Assignment operator.

Parameters

[in]

Source

The instance to replicate.

Returns

The modified object.

operator=() [2/2]

const Object & FrameCPP::Common::FrameSpec::Object::operator=

(

const Object &

Source

)

Assignement operator.

Parameters

[in]

Source

The instance to replicate.

Returns

The modified object.

WriteNext() [1/2]

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext

(

ostream_type &

Stream

)

const

Write a next pointer to the parent to the stream.

Parameters

[in,out]

Stream

The output stream to receive the next pointer.

Returns

The output stream.

WriteNext() [2/2]

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext

(

ostream_type &

Stream

)

const

Write a next pointer to the parent to the stream.

Parameters

[in,out]

Stream

The output stream to receive the next pointer.

Returns

The output stream.

---

The documentation for this class was generated from the following files:

• /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-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-build/ldas-tools-framecpp-3.0.4/src/Common/FrameSpec.cc