YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::os::SystemInfoData Class Reference

Aggregates all the system (platform) status information, such as available memory, storage, CPU load, etc. More...

#include <idl_generated_code/yarp/os/SystemInfoData.h>

+ Inheritance diagram for yarp::os::SystemInfoData:

Public Types

typedef yarp::os::idl::Unwrapped< SystemInfoData > unwrapped
 

Public Member Functions

 SystemInfoData ()=default
 
 SystemInfoData (const MemoryInfoData &memory, const StorageInfoData &storage, const ProcessorInfoData &processor, const LoadInfoData &load, const PlatformInfoData &platform, const UserInfoData &user, const ProcessInfoData &process)
 
bool read (yarp::os::idl::WireReader &reader) override
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection.
 
bool write (const yarp::os::idl::WireWriter &writer) const override
 
bool write (yarp::os::ConnectionWriter &connection) const override
 Write this object to a network connection.
 
std::string toString () const
 
- Public Member Functions inherited from yarp::os::idl::WirePortable
virtual bool readBare (yarp::os::ConnectionReader &reader)
 
virtual bool writeBare (yarp::os::ConnectionWriter &writer) const
 
virtual bool readBottle (yarp::os::ConnectionReader &reader)
 
virtual bool writeBottle (yarp::os::ConnectionWriter &writer) const
 
- Public Member Functions inherited from yarp::os::Portable
virtual Type getType () const
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor.
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
 Destructor.
 
virtual void onCompletion () const
 This is called when the port has finished all writing operations.
 
virtual void onCommencement () const
 This is called when the port is about to begin writing operations.
 
virtual yarp::os::Type getWriteType () const
 

Public Attributes

MemoryInfoData memory {}
 
StorageInfoData storage {}
 
ProcessorInfoData processor {}
 
LoadInfoData load {}
 
PlatformInfoData platform {}
 
UserInfoData user {}
 
ProcessInfoData process {}
 

Additional Inherited Members

- Static Public Member Functions inherited from yarp::os::Portable
static bool copyPortable (const PortWriter &writer, PortReader &reader)
 Copy one portable to another, via writing and reading.
 

Detailed Description

Aggregates all the system (platform) status information, such as available memory, storage, CPU load, etc.

Definition at line 32 of file SystemInfoData.h.

Member Typedef Documentation

◆ unwrapped

Constructor & Destructor Documentation

◆ SystemInfoData() [1/2]

yarp::os::SystemInfoData::SystemInfoData ( )
default

◆ SystemInfoData() [2/2]

yarp::os::SystemInfoData::SystemInfoData ( const MemoryInfoData &  memory,
const StorageInfoData &  storage,
const ProcessorInfoData &  processor,
const LoadInfoData &  load,
const PlatformInfoData &  platform,
const UserInfoData &  user,
const ProcessInfoData &  process 
)

Definition at line 16 of file SystemInfoData.cpp.

Member Function Documentation

◆ read() [1/2]

bool yarp::os::SystemInfoData::read ( yarp::os::ConnectionReader &  reader)
overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters
readeran interface to the network connection for reading
Returns
true iff the object is successfully read

Implements yarp::os::Portable.

Definition at line 65 of file SystemInfoData.cpp.

◆ read() [2/2]

bool yarp::os::SystemInfoData::read ( yarp::os::idl::WireReader &  reader)
overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 35 of file SystemInfoData.cpp.

◆ toString()

std::string yarp::os::SystemInfoData::toString ( ) const

Definition at line 121 of file SystemInfoData.cpp.

◆ write() [1/2]

bool yarp::os::SystemInfoData::write ( const yarp::os::idl::WireWriter &  writer) const
overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 78 of file SystemInfoData.cpp.

◆ write() [2/2]

bool yarp::os::SystemInfoData::write ( yarp::os::ConnectionWriter &  writer) const
overridevirtual

Write this object to a network connection.

Override this for your particular class. Be aware that depending on the nature of the connections a port has, and what protocol they use, and how efficient the YARP implementation is, this method may be called once, twice, or many times, as the result of a single call to Port::write

Parameters
writeran interface to the network connection for writing
Returns
true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 108 of file SystemInfoData.cpp.

Member Data Documentation

◆ load

LoadInfoData yarp::os::SystemInfoData::load {}

Definition at line 40 of file SystemInfoData.h.

◆ memory

MemoryInfoData yarp::os::SystemInfoData::memory {}

Definition at line 37 of file SystemInfoData.h.

◆ platform

PlatformInfoData yarp::os::SystemInfoData::platform {}

Definition at line 41 of file SystemInfoData.h.

◆ process

ProcessInfoData yarp::os::SystemInfoData::process {}

Definition at line 43 of file SystemInfoData.h.

◆ processor

ProcessorInfoData yarp::os::SystemInfoData::processor {}

Definition at line 39 of file SystemInfoData.h.

◆ storage

StorageInfoData yarp::os::SystemInfoData::storage {}

Definition at line 38 of file SystemInfoData.h.

◆ user

UserInfoData yarp::os::SystemInfoData::user {}

Definition at line 42 of file SystemInfoData.h.


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