Ceylan::Network::IPAddress Class Reference

Handles abstract IP (Internet Protocol) addresses. More...

#include <CeylanIPAddress.h>

Inheritance diagram for Ceylan::Network::IPAddress:

[legend]

Collaboration diagram for Ceylan::Network::IPAddress:

[legend]

List of all members.

Public Types
enum	TextOutputFormat { rawText, html }
	Defines what text output formats for TextDisplayable instances are available. More...
Public Member Functions
	IPAddress ()
	Basic constructor.
virtual	~IPAddress () throw ()
	Basic virtual destructor.
virtual NetworkAddressType	getType () const =0
	Returns the actual type of the IP address, for example: IPv4.
virtual const std::string	toString (Ceylan::VerbosityLevels level=Ceylan::high) const
	Returns a user-friendly description of the state of this object.
Static Public Member Functions
static bool	IsValid (const std::string IPString)
	Tells whether the specified string is a valid IP address.
static const std::string	ToString (std::list< TextDisplayable * > displayables, Ceylan::VerbosityLevels level=Ceylan::high)
	Returns a user-friendly description of this list of pointers to text displayable instances.
static TextOutputFormat	GetOutputFormat ()
	Returns the current overall text format to be used by TextDisplayable instances.
static void	SetOutputFormat (TextOutputFormat newOutputFormat)
	Sets the current overall text format to be used by TextDisplayable instances.
Protected Member Functions
virtual void	validate () const =0
	Checks that internal IP is valid, raises a NetworkException otherwise.
Static Protected Attributes
static TextOutputFormat	_OutputFormat = rawText
	The text format to be used currently by TextDisplayable instances.
Private Member Functions
	IPAddress (const IPAddress &source)
	Copy constructor made private to ensure that it will never be called.
IPAddress &	operator= (const IPAddress &source)
	Assignment operator made private to ensure that it will never be called.

---

Detailed Description

Handles abstract IP (Internet Protocol) addresses.

Todo:

Add informations from netinet/in.h (ex: IN_CLASSA).

Definition at line 72 of file CeylanIPAddress.h.

---

Member Enumeration Documentation

enum Ceylan::TextDisplayable::TextOutputFormat [inherited]

Defines what text output formats for TextDisplayable instances are available.

Enumerator:

rawText
html

Definition at line 124 of file CeylanTextDisplayable.h.

---

Constructor & Destructor Documentation

IPAddress::IPAddress

(

)

Basic constructor.

Definition at line 37 of file CeylanIPAddress.cc.

IPAddress::~IPAddress

(

)

throw () [virtual]

Basic virtual destructor.

Definition at line 45 of file CeylanIPAddress.cc.

Ceylan::Network::IPAddress::IPAddress

(

const IPAddress &

source

)

[private]

Copy constructor made private to ensure that it will never be called.

The compiler should complain whenever this undefined constructor is called, implicitly or not.

---

Member Function Documentation

TextDisplayable::TextOutputFormat TextDisplayable::GetOutputFormat

(

)

[static, inherited]

Returns the current overall text format to be used by TextDisplayable instances.

Definition at line 63 of file CeylanTextDisplayable.cc.

References Ceylan::TextDisplayable::_OutputFormat.

Referenced by Ceylan::formatStringList(), Ceylan::formatStringMap(), Ceylan::XML::XMLMarkup::toString(), Ceylan::Maths::Linear::Vector3::toString(), Ceylan::Maths::Linear::Vector2::toString(), Ceylan::Maths::Linear::Tripoint::toString(), Ceylan::Module::toString(), Ceylan::Maths::Linear::Matrix3::toString(), Ceylan::Maths::Linear::Matrix2::toString(), Ceylan::Maths::Linear::HomogeneousMatrix3::toString(), and Ceylan::Maths::Linear::Bipoint::toString().

virtual NetworkAddressType Ceylan::Network::IPAddress::getType

(

)

const [pure virtual]

Returns the actual type of the IP address, for example: IPv4.

Implemented in Ceylan::Network::IPAddressvFour.

Referenced by Ceylan::Network::HostDNSEntry::HostDNSEntry().

bool IPAddress::IsValid

(

const std::string

IPString

)

[static]

Tells whether the specified string is a valid IP address.

Note:

For abstract IPAddress, always returns false.

Definition at line 61 of file CeylanIPAddress.cc.

References generalUtils::false.

IPAddress& Ceylan::Network::IPAddress::operator=

(

const IPAddress &

source

)

[private]

Assignment operator made private to ensure that it will never be called.

The compiler should complain whenever this undefined operator is called, implicitly or not.

void TextDisplayable::SetOutputFormat

(

TextOutputFormat

newOutputFormat

)

[static, inherited]

Sets the current overall text format to be used by TextDisplayable instances.

Parameters:

newOutputFormat

the new output format.

Definition at line 72 of file CeylanTextDisplayable.cc.

References Ceylan::TextDisplayable::_OutputFormat.

Referenced by Ceylan::Log::LogHolder::LogHolder().

const std::string TextDisplayable::ToString	(	std::list< TextDisplayable * >	displayables,
		Ceylan::VerbosityLevels	level = Ceylan::high
	)			[static, inherited]

Returns a user-friendly description of this list of pointers to text displayable instances.

Parameters:

	displayables	a list of pointers to TextDisplayable instances/
	level	the requested verbosity level.

Note:

Text output format is determined from overall settings.

See also:

toString, Ceylan::VerbosityLevels

Definition at line 45 of file CeylanTextDisplayable.cc.

References Ceylan::formatStringList().

const string IPAddress::toString

(

Ceylan::VerbosityLevels

level = Ceylan::high

)

const [virtual]

Returns a user-friendly description of the state of this object.

Parameters:

level

the requested verbosity level. For level 'Ceylanlow', the exact standard notation for IP address will be returned, depending on the actual address type.

Note:

Text output format is determined from overall settings.

See also:

TextDisplayable

Implements Ceylan::TextDisplayable.

Reimplemented in Ceylan::Network::IPAddressvFour.

Definition at line 52 of file CeylanIPAddress.cc.

Referenced by Ceylan::Network::HostDNSEntry::HostDNSEntry().

virtual void Ceylan::Network::IPAddress::validate

(

)

const [protected, pure virtual]

Checks that internal IP is valid, raises a NetworkException otherwise.

Implemented in Ceylan::Network::IPAddressvFour.

---

Member Data Documentation

TextDisplayable::TextOutputFormat TextDisplayable::_OutputFormat = rawText [static, protected, inherited]

The text format to be used currently by TextDisplayable instances.

Note:

Defaults to raw text.

Definition at line 158 of file CeylanTextDisplayable.h.

Referenced by Ceylan::TextDisplayable::GetOutputFormat(), and Ceylan::TextDisplayable::SetOutputFormat().

---

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

• CeylanIPAddress.h
• CeylanIPAddress.cc