IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Member Functions | Protected Attributes | List of all members
ipsdk::core::LocalNetworkDescription Class Reference

Class encapsulating network description for multi-machine processings has seen by local machine. More...

#include <LocalNetworkDescription.h>

Inheritance diagram for ipsdk::core::LocalNetworkDescription:
ipsdk::BaseDynamicObject

Public Member Functions

bool isInit () const
 retrieve object initialization flag
 
BoolResult init (const NetworkDescription &networkDescription, const LocalComputerInfo &localComputerInfo)
 initialization of object More...
 
ipUInt32 getPortNumber () const
 
const tcpip::eIPAddressTypegetIPAddressType () const
 
const tcpip::AddressgetLocalIPAddress () const
 retrieve local ip address used for remote processings More...
 
const tcpip::AddressgetMasterIPAddress () const
 retrieve master ip address for local computer More...
 
const AddressCollgetRemoteAddressColl () const
 retrieve collection of all ip addresses associated to remote network More...
 
const AddressCollgetSlavesAddressColl () const
 retrieve slave ip addresses associated to local computer More...
 
void clear ()
 remove data from object
 
Constructors and destructors
 LocalNetworkDescription ()
 
 ~LocalNetworkDescription ()
 
- Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string & getClassName () const
 method allowing to retrieve object class name
 
virtual BaseDynamicObjectcreateNew () const =0
 method allowing to create new instance of current object type
 
virtual DynamicObjectPtr createShared () const =0
 method allowing to create new shared instance of current object type
 
virtual bool hasCopySupport () const =0
 check whether objet has copy support
 
virtual BaseDynamicObjectduplicate () const =0
 method allowing to duplicate current object More...
 
virtual DynamicObjectPtr duplicateShared () const =0
 method allowing shared duplication of current object More...
 
 BaseDynamicObject ()
 
virtual ~BaseDynamicObject ()=0
 

Protected Attributes

ipUInt32 _portNumber
 port number used for connections
 
tcpip::eIPAddressType _ipAddressType
 type of ip addresses used
 
tcpip::Address _localIPAddress
 used ip address for local machine
 
tcpip::Address _masterIPAddress
 master address for local machine
 
AddressColl _remoteAddressColl
 collection of all ip addresses associated to remote network
 
AddressColl _slavesAddressColl
 collection of slave ip addresses associated to local computer
 
bool _bInit
 object initialization flag
 

Additional Inherited Members

- Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string & getTypeName ()
 method allowing to retrieve name associated to class
 
- Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void initCtorCopy (const BaseDynamicObject &object)
 
virtual void copy (const BaseDynamicObject &object)
 method allowing to copy data from another object
 

Detailed Description

Class encapsulating network description for multi-machine processings has seen by local machine.

Author
E. Noirfalise
Date
2013/12/9

Member Function Documentation

◆ init()

BoolResult ipsdk::core::LocalNetworkDescription::init ( const NetworkDescription networkDescription,
const LocalComputerInfo localComputerInfo 
)

initialization of object

Returns
false if network description contains more than one ip address associated to local machine or if it doesn't contain any address associated to local machine

◆ getPortNumber()

ipUInt32 ipsdk::core::LocalNetworkDescription::getPortNumber ( ) const

retrieve port number associated to object

Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

◆ getIPAddressType()

const tcpip::eIPAddressType& ipsdk::core::LocalNetworkDescription::getIPAddressType ( ) const

retrieve ip address type associated to object

Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

◆ getLocalIPAddress()

const tcpip::Address& ipsdk::core::LocalNetworkDescription::getLocalIPAddress ( ) const

retrieve local ip address used for remote processings

Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

◆ getMasterIPAddress()

const tcpip::Address& ipsdk::core::LocalNetworkDescription::getMasterIPAddress ( ) const

retrieve master ip address for local computer

Note
if local computer has no master this address is left uninitialized
Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

◆ getRemoteAddressColl()

const AddressColl& ipsdk::core::LocalNetworkDescription::getRemoteAddressColl ( ) const

retrieve collection of all ip addresses associated to remote network

Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

◆ getSlavesAddressColl()

const AddressColl& ipsdk::core::LocalNetworkDescription::getSlavesAddressColl ( ) const

retrieve slave ip addresses associated to local computer

Exceptions
ipsdk::core::IPSDKCoreExceptionif isInit() == false

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