AMOS::IMessagable_t Class Reference

Interface for classes that can interpret messages. More...

#include <Message_AMOS.hh>

Inheritance diagram for AMOS::IMessagable_t:

[legend]List of all members.

Public Member Functions
	IMessagable_t ()
	Constructs a Messagable object with null message type.
virtual	~IMessagable_t ()
	Virtual destructor for Messagable objects.
virtual NCode_t	getNCode () const =0
	Get the AMOS NCode type identifier.
virtual void	readMessage (const Message_t &msg)=0
	Reads in data from a Message object.
virtual void	writeMessage (Message_t &msg) const =0
	Writes data to a Message object.

---

Detailed Description

Interface for classes that can interpret messages.

Provides an interface for classes that can input and output messages. This allows in-memory classes to read and write messages to a stream via the Message_t class.

Definition at line 489 of file Message_AMOS.hh.

---

Constructor & Destructor Documentation

AMOS::IMessagable_t::IMessagable_t

(

)

[inline]

Constructs a Messagable object with null message type.

Definition at line 497 of file Message_AMOS.hh.

virtual AMOS::IMessagable_t::~IMessagable_t

(

)

[inline, virtual]

Virtual destructor for Messagable objects.

Definition at line 506 of file Message_AMOS.hh.

---

Member Function Documentation

virtual NCode_t AMOS::IMessagable_t::getNCode

(

)

const [pure virtual]

Get the AMOS NCode type identifier.

Returns:

The AMOS NCode type identifier

Implemented in AMOS::Contig_t, AMOS::ContigEdge_t, AMOS::ContigLink_t, AMOS::Distribution_t, AMOS::Tile_t, AMOS::Edge_t, AMOS::Feature_t, AMOS::Fragment_t, AMOS::Group_t, AMOS::IDMap_t, AMOS::Index_t, AMOS::Kmer_t, AMOS::Layout_t, AMOS::Library_t, AMOS::Link_t, AMOS::Overlap_t, AMOS::Read_t, AMOS::Scaffold_t, AMOS::ScaffoldEdge_t, AMOS::ScaffoldLink_t, AMOS::Sequence_t, and AMOS::Universal_t.

virtual void AMOS::IMessagable_t::readMessage

(

const Message_t &

msg

)

[pure virtual]

Reads in data from a Message object.

Reads the data contained in a Message object and stores it in the Messagable object. Will not complain if incoming message is of the wrong type, will only try and suck out the fields it recognizes. All previous data in the Messagable object will be cleared or overwritten.

Parameters:

msg

The Message to read from

Precondition:

The expected fields are formatted properly

Exceptions:

ArgumentException_t

Returns:

void

Implemented in AMOS::Contig_t, AMOS::ContigEdge_t, AMOS::ContigLink_t, AMOS::Distribution_t, AMOS::Tile_t, AMOS::Edge_t, AMOS::Feature_t, AMOS::Fragment_t, AMOS::Group_t, AMOS::IDMap_t, AMOS::Index_t, AMOS::Kmer_t, AMOS::Layout_t, AMOS::Library_t, AMOS::Link_t, AMOS::Overlap_t, AMOS::Read_t, AMOS::Scaffold_t, AMOS::ScaffoldEdge_t, AMOS::ScaffoldLink_t, AMOS::Sequence_t, and AMOS::Universal_t.

virtual void AMOS::IMessagable_t::writeMessage

(

Message_t &

msg

)

const [pure virtual]

Writes data to a Message object.

Writes the data contained in a Messagable object to a Message object. All previous data in the Message will be cleared or overwritten.

Parameters:

msg

The Message to write to

Returns:

void

Implemented in AMOS::Contig_t, AMOS::ContigEdge_t, AMOS::ContigLink_t, AMOS::Distribution_t, AMOS::Tile_t, AMOS::Edge_t, AMOS::Feature_t, AMOS::Fragment_t, AMOS::Group_t, AMOS::IDMap_t, AMOS::Index_t, AMOS::Kmer_t, AMOS::Layout_t, AMOS::Library_t, AMOS::Link_t, AMOS::Overlap_t, AMOS::Read_t, AMOS::Scaffold_t, AMOS::ScaffoldEdge_t, AMOS::ScaffoldLink_t, AMOS::Sequence_t, and AMOS::Universal_t.

---

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

• Message_AMOS.hh

---