YARP
Yet Another Robot Platform
yarp::os::SystemInfoSerializer Class Reference

A helper class to pass the SystemInfo object around the YARP network. More...

#include <yarp/os/SystemInfoSerializer.h>

+ Inheritance diagram for yarp::os::SystemInfoSerializer:

Classes

class  Private
 

Public Member Functions

 SystemInfoSerializer ()
 SystemInfoSerializer constructor. More...
 
virtual ~SystemInfoSerializer ()
 ~SystemInfoSerializer deconstructor More...
 
bool read (yarp::os::ConnectionReader &connection) override
 reads from a ConnectionReader and fill into the SystemInfo structs. More...
 
bool write (yarp::os::ConnectionWriter &connection) const override
 write the SystemInfo structs using a ConnectionWriter. More...
 
- Public Member Functions inherited from yarp::os::Portable
bool read (ConnectionReader &reader) override=0
 Read this object from a network connection. More...
 
bool write (ConnectionWriter &writer) const override=0
 Write this object to a network connection. More...
 
virtual Type getType () const
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor. More...
 
virtual bool read (ConnectionReader &reader)=0
 Read this object from a network connection. More...
 
virtual Type getReadType () const
 
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
 Destructor. More...
 
virtual bool write (ConnectionWriter &writer) const =0
 Write this object to a network connection. More...
 
virtual void onCompletion () const
 This is called when the port has finished all writing operations. More...
 
virtual void onCommencement () const
 This is called when the port is about to begin writing operations. More...
 
virtual yarp::os::Type getWriteType () const
 

Public Attributes

yarp::os::SystemInfo::MemoryInfo memory
 system memory information More...
 
yarp::os::SystemInfo::StorageInfo storage
 system storage information More...
 
yarp::os::SystemInfo::ProcessorInfo processor
 system processor type information More...
 
yarp::os::SystemInfo::PlatformInfo platform
 operating system information More...
 
yarp::os::SystemInfo::LoadInfo load
 current cpu load information More...
 
yarp::os::SystemInfo::UserInfo user
 current user information More...
 

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. More...
 

Detailed Description

A helper class to pass the SystemInfo object around the YARP network.

Definition at line 19 of file SystemInfoSerializer.h.

Constructor & Destructor Documentation

◆ SystemInfoSerializer()

SystemInfoSerializer::SystemInfoSerializer ( )

SystemInfoSerializer constructor.

Definition at line 39 of file SystemInfoSerializer.cpp.

◆ ~SystemInfoSerializer()

SystemInfoSerializer::~SystemInfoSerializer ( )
virtual

~SystemInfoSerializer deconstructor

Definition at line 47 of file SystemInfoSerializer.cpp.

Member Function Documentation

◆ read()

bool SystemInfoSerializer::read ( yarp::os::ConnectionReader connection)
overridevirtual

reads from a ConnectionReader and fill into the SystemInfo structs.

Parameters
connectiona ConnectionReader
Returns
true/false upon success or failure

Implements yarp::os::Portable.

Definition at line 52 of file SystemInfoSerializer.cpp.

◆ write()

bool SystemInfoSerializer::write ( yarp::os::ConnectionWriter connection) const
overridevirtual

write the SystemInfo structs using a ConnectionWriter.

Parameters
connectiona ConnectionWriter
Returns
true/false upon success or failure

Implements yarp::os::Portable.

Definition at line 100 of file SystemInfoSerializer.cpp.

Member Data Documentation

◆ load

yarp::os::SystemInfo::LoadInfo yarp::os::SystemInfoSerializer::load

current cpu load information

Definition at line 69 of file SystemInfoSerializer.h.

◆ memory

yarp::os::SystemInfo::MemoryInfo yarp::os::SystemInfoSerializer::memory

system memory information

Definition at line 49 of file SystemInfoSerializer.h.

◆ platform

yarp::os::SystemInfo::PlatformInfo yarp::os::SystemInfoSerializer::platform

operating system information

Definition at line 64 of file SystemInfoSerializer.h.

◆ processor

yarp::os::SystemInfo::ProcessorInfo yarp::os::SystemInfoSerializer::processor

system processor type information

Definition at line 59 of file SystemInfoSerializer.h.

◆ storage

yarp::os::SystemInfo::StorageInfo yarp::os::SystemInfoSerializer::storage

system storage information

Definition at line 54 of file SystemInfoSerializer.h.

◆ user

yarp::os::SystemInfo::UserInfo yarp::os::SystemInfoSerializer::user

current user information

Definition at line 74 of file SystemInfoSerializer.h.


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