Ice 3.7 C++11 API Reference
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
IceGrid::CommunicatorDescriptor Class Reference

A communicator descriptor. More...

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::CommunicatorDescriptor:
Inheritance graph
[legend]
Collaboration diagram for IceGrid::CommunicatorDescriptor:
Collaboration graph
[legend]

Public Member Functions

 CommunicatorDescriptor ()=default
 
 CommunicatorDescriptor (CommunicatorDescriptor &&)=default
 
 CommunicatorDescriptor (const ::IceGrid::AdapterDescriptorSeq &adapters, const ::IceGrid::PropertySetDescriptor &propertySet, const ::IceGrid::DbEnvDescriptorSeq &dbEnvs, const ::Ice::StringSeq &logs, const ::std::string &description)
 One-shot constructor to initialize all data members. More...
 
 CommunicatorDescriptor (const CommunicatorDescriptor &)=default
 
std::tuple< const ::IceGrid::AdapterDescriptorSeq &, const ::IceGrid::PropertySetDescriptor &, const ::IceGrid::DbEnvDescriptorSeq &, const ::Ice::StringSeq &, const ::std::string & > ice_tuple () const
 Obtains a tuple containing all of the value's data members. More...
 
CommunicatorDescriptoroperator= (CommunicatorDescriptor &&)=default
 
CommunicatorDescriptoroperator= (const CommunicatorDescriptor &)=default
 
virtual ~CommunicatorDescriptor ()
 

Static Public Member Functions

static const ::std::string & ice_staticId ()
 Obtains the Slice type ID of this value. More...
 

Public Attributes

::IceGrid::AdapterDescriptorSeq adapters
 The object adapters. More...
 
::IceGrid::DbEnvDescriptorSeq dbEnvs
 The database environments. More...
 
::std::string description
 A description of this descriptor. More...
 
::Ice::StringSeq logs
 The path of each log file. More...
 
::IceGrid::PropertySetDescriptor propertySet
 The property set. More...
 

Detailed Description

A communicator descriptor.

Constructor & Destructor Documentation

◆ ~CommunicatorDescriptor()

virtual IceGrid::CommunicatorDescriptor::~CommunicatorDescriptor ( )
virtual

◆ CommunicatorDescriptor() [1/4]

IceGrid::CommunicatorDescriptor::CommunicatorDescriptor ( )
default

◆ CommunicatorDescriptor() [2/4]

IceGrid::CommunicatorDescriptor::CommunicatorDescriptor ( const CommunicatorDescriptor )
default

◆ CommunicatorDescriptor() [3/4]

IceGrid::CommunicatorDescriptor::CommunicatorDescriptor ( CommunicatorDescriptor &&  )
default

◆ CommunicatorDescriptor() [4/4]

IceGrid::CommunicatorDescriptor::CommunicatorDescriptor ( const ::IceGrid::AdapterDescriptorSeq adapters,
const ::IceGrid::PropertySetDescriptor propertySet,
const ::IceGrid::DbEnvDescriptorSeq dbEnvs,
const ::Ice::StringSeq logs,
const ::std::string &  description 
)
inline

One-shot constructor to initialize all data members.

Parameters
adaptersThe object adapters.
propertySetThe property set.
dbEnvsThe database environments.
logsThe path of each log file.
descriptionA description of this descriptor.

Member Function Documentation

◆ ice_staticId()

static const ::std::string& IceGrid::CommunicatorDescriptor::ice_staticId ( )
static

Obtains the Slice type ID of this value.

Returns
The fully-scoped type ID.

◆ ice_tuple()

std::tuple<const ::IceGrid::AdapterDescriptorSeq&, const ::IceGrid::PropertySetDescriptor&, const ::IceGrid::DbEnvDescriptorSeq&, const ::Ice::StringSeq&, const ::std::string&> IceGrid::CommunicatorDescriptor::ice_tuple ( ) const
inline

Obtains a tuple containing all of the value's data members.

Returns
The data members in a tuple.

◆ operator=() [1/2]

CommunicatorDescriptor& IceGrid::CommunicatorDescriptor::operator= ( CommunicatorDescriptor &&  )
default

◆ operator=() [2/2]

CommunicatorDescriptor& IceGrid::CommunicatorDescriptor::operator= ( const CommunicatorDescriptor )
default

Member Data Documentation

◆ adapters

::IceGrid::AdapterDescriptorSeq IceGrid::CommunicatorDescriptor::adapters

The object adapters.

◆ dbEnvs

::IceGrid::DbEnvDescriptorSeq IceGrid::CommunicatorDescriptor::dbEnvs

The database environments.

◆ description

::std::string IceGrid::CommunicatorDescriptor::description

A description of this descriptor.

◆ logs

::Ice::StringSeq IceGrid::CommunicatorDescriptor::logs

The path of each log file.

◆ propertySet

::IceGrid::PropertySetDescriptor IceGrid::CommunicatorDescriptor::propertySet

The property set.


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