Matrix Science header
Public Member Functions

ms_computeraddress Class Reference
[Mascot configuration files module]

The class serves as a container for computer address parameters for cluster mode. More...

#include <ms_computeraddress.hpp>

List of all members.

Public Member Functions

 ms_computeraddress ()
 Default constructor.
 ms_computeraddress (const ms_computeraddress &src)
 Copying constructor.
 ~ms_computeraddress ()
 Destructor.
void copyFrom (const ms_computeraddress *right)
 Can be used to create a copy of another object.
void defaultValues ()
 Initialises the instance with default values.
std::string getHostName () const
 Returns the host name.
std::string getInetAddress () const
 Returns IP address of the host.
unsigned int getPort () const
 Returns the port number for the host.
ms_computeraddressoperator= (const ms_computeraddress &right)
 Assignment operator for C++ client applications.
void setHostName (const char *name)
 Change the host name.
void setInetAddress (const char *address)
 Change the IP address of the host.
void setPort (const unsigned int value)
 Change the port number for the host.

Detailed Description

The class serves as a container for computer address parameters for cluster mode.


Member Function Documentation

std::string getHostName (  ) const

Returns the host name.

Default is localhost.

Returns:
Host name
std::string getInetAddress (  ) const

Returns IP address of the host.

Default is "127.0.0.1".

Returns:
IP address
unsigned int getPort (  ) const

Returns the port number for the host.

Default is 0.

Returns:
Port number
void setHostName ( const char *  name )

Change the host name.

Parameters:
nameNew host name to set
void setInetAddress ( const char *  address )

Change the IP address of the host.

Parameters:
addressNew address to set
void setPort ( const unsigned int  value )

Change the port number for the host.

Parameters:
valueNew port number to set

The documentation for this class was generated from the following files:
Copyright © 2016 Matrix Science Ltd.  All Rights Reserved. Generated on Fri Jun 2 2017 01:44:51