Ice 3.7 C++11 API Reference
Public Member Functions | Public Attributes | List of all members
IceGrid::NodeInfo Struct Reference

Information about an IceGrid node. More...

#include <IceGrid/IceGrid.h>

Public Member Functions

std::tuple< const ::std::string &, const ::std::string &, const ::std::string &, const ::std::string &, const ::std::string &, const ::std::string &, const int &, const ::std::string & > ice_tuple () const
 Obtains a tuple containing all of the struct's data members. More...
 

Public Attributes

::std::string dataDir
 The path to the node data directory. More...
 
::std::string hostname
 The network name of the host running this node (as defined in uname()). More...
 
::std::string machine
 The machine hardware type (as defined in uname()). More...
 
::std::string name
 The name of the node. More...
 
int nProcessors
 The number of processor threads on the node. More...
 
::std::string os
 The operating system name. More...
 
::std::string release
 The operation system release level (as defined in uname()). More...
 
::std::string version
 The operation system version (as defined in uname()). More...
 

Detailed Description

Information about an IceGrid node.

Member Function Documentation

◆ ice_tuple()

std::tuple<const ::std::string&, const ::std::string&, const ::std::string&, const ::std::string&, const ::std::string&, const ::std::string&, const int&, const ::std::string&> IceGrid::NodeInfo::ice_tuple ( ) const
inline

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

Returns
The data members in a tuple.

Member Data Documentation

◆ dataDir

::std::string IceGrid::NodeInfo::dataDir

The path to the node data directory.

◆ hostname

::std::string IceGrid::NodeInfo::hostname

The network name of the host running this node (as defined in uname()).

◆ machine

::std::string IceGrid::NodeInfo::machine

The machine hardware type (as defined in uname()).

◆ name

::std::string IceGrid::NodeInfo::name

The name of the node.

◆ nProcessors

int IceGrid::NodeInfo::nProcessors

The number of processor threads on the node.

For example, nProcessors is 8 on a computer with a single quad-core processor and two HT threads per core.

◆ os

::std::string IceGrid::NodeInfo::os

The operating system name.

◆ release

::std::string IceGrid::NodeInfo::release

The operation system release level (as defined in uname()).

◆ version

::std::string IceGrid::NodeInfo::version

The operation system version (as defined in uname()).


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