serial_port_address Class Reference

#include <address.h>

Inheritance diagram for serial_port_address:

[legend]Collaboration diagram for serial_port_address:


Public Types
enum	parity_type { NONE = 'N', EVEN = 'E', ODD = 'O', MARK = 'M', SPACE = 'S' }
enum	stop_bits_type { ZERO_SB = 0, ONE_SB = 1, ONE_POINT_FIVE_SB = 9, TWO_SB = 2 }
Public Member Functions
	serial_port_address ()
	serial_port_address (int port, int baud_rate, byte data_bits, char parity, byte stop_bits)
void	fill (int port, int baud_rate, byte data_bits, char parity, byte stop_bits)
	IMPLEMENT_CLASS_NAME ("serial_port_address")
bool	same_host (const address_base &to_compare) const
bool	same_port (const address_base &to_compare) const
bool	shareable (const address_base &to_compare) const
istring	text_form () const
	Provides a text view of all the important info owned by this object.
istring	tokenize () const
bool	detokenize (const istring &info)
address_base *	create_copy () const
void	pack (byte_array &packed_form) const
	Creates a packed form of the packable object in "packed_form".
bool	unpack (byte_array &packed_form)
	Restores the packable from the "packed_form".
virtual machine_uid	convert () const
virtual int	packed_size () const
	Estimates the space needed for the packed structure.
Static Public Member Functions
static istring	GET_DSR ()
static istring	GET_CTS ()
static istring	SET_DTR ()
static istring	SET_RTS ()
static istring	USE_MARK_SPACE ()
Public Attributes
int	port
int	baud_rate
byte	data_bits
char	parity
byte	stop_bits

Detailed Description

Definition at line 152 of file address.h.

Member Enumeration Documentation

enum serial_port_address::parity_type

Enumerator:

NONE
EVEN
ODD
MARK
SPACE

Definition at line 155 of file address.h.

enum serial_port_address::stop_bits_type

Enumerator:

ZERO_SB
ONE_SB
ONE_POINT_FIVE_SB
TWO_SB

Definition at line 158 of file address.h.

Constructor & Destructor Documentation

serial_port_address::serial_port_address ( )

Definition at line 722 of file address.cpp.

References fill().

Referenced by create_copy().

serial_port_address::serial_port_address	(	int	port,
		int	baud_rate,
		byte	data_bits,
		char	parity,
		byte	stop_bits
	)

Definition at line 724 of file address.cpp.

References fill().

Member Function Documentation

void serial_port_address::fill	(	int	port,
		int	baud_rate,
		byte	data_bits,
		char	parity,
		byte	stop_bits
	)

Definition at line 800 of file address.cpp.

References baud_rate, data_bits, parity, port, and stop_bits.

Referenced by detokenize(), and serial_port_address().

serial_port_address::IMPLEMENT_CLASS_NAME ( "serial_port_address" )

bool serial_port_address::same_host ( const address_base & to_compare ) const [virtual]

Implements address_base.

Definition at line 751 of file address.cpp.

bool serial_port_address::same_port ( const address_base & to_compare ) const [virtual]

Implements address_base.

Definition at line 754 of file address.cpp.

References CAST_UP, and port.

bool serial_port_address::shareable ( const address_base & to_compare ) const [virtual]

Implements address_base.

Definition at line 760 of file address.cpp.

References baud_rate, CAST_UP, data_bits, parity, and stop_bits.

istring serial_port_address::text_form ( ) const [virtual]

Provides a text view of all the important info owned by this object.

It is understood that there could be a large amount of information and that this function might take a relatively long time to complete. The information can be provided in multiple lines if desired (it is good to use log_base::platform_ending() for the line breaks to help to ensure that the text is formatted appropriately). the default is quite lame and should be overridden.

Implements address_base.

Definition at line 745 of file address.cpp.

References baud_rate, data_bits, parity, port, and stop_bits.

istring serial_port_address::tokenize ( ) const [virtual]

Implements address_base.

Definition at line 825 of file address.cpp.

References ADD, baud_rate, data_bits, DUMP_EXIT, parity, port, stop_bits, and STORER_ENTRY.

bool serial_port_address::detokenize ( const istring & info ) [virtual]

Implements address_base.

Definition at line 811 of file address.cpp.

References fill(), FIND, GRAB, LOADER_ENTRY, LOADER_EXIT, parity, and port.

address_base * serial_port_address::create_copy ( ) const [virtual]

Implements address_base.

Definition at line 728 of file address.cpp.

References baud_rate, data_bits, parity, port, serial_port_address(), and stop_bits.

void serial_port_address::pack ( byte_array & packed_form ) const [virtual]

Creates a packed form of the packable object in "packed_form".

This must append to the data in "packed_form" rather than clearing prior contents.

Implements packable.

Definition at line 777 of file address.cpp.

References basis::attach(), baud_rate, data_bits, parity, port, and stop_bits.

bool serial_port_address::unpack ( byte_array & packed_form ) [virtual]

Restores the packable from the "packed_form".

This object becomes the unpacked form, and therefore must lose any of its prior contents that depend on the data in "packed_form". This is up to the derived unpack function to figure out. The "packed_form" is modified by extracting all of the pieces that are used for this object; the remainder stays in "packed_form". true is returned if the unpacking was successful.

Implements packable.

Definition at line 786 of file address.cpp.

References baud_rate, data_bits, basis::detach(), array< contents >::length(), parity, port, stop_bits, and array< contents >::zap().