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

Holds the current user information. More...

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

+ Inheritance diagram for yarp::os::UserInfoData:

Public Types

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

Public Member Functions

 UserInfoData ()=default
 
 UserInfoData (const std::string &userName, const std::string &realName, const std::string &homeDir, const std::int32_t userID)
 
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

std::string userName {}
 
std::string realName {}
 
std::string homeDir {}
 
std::int32_t userID {0}
 

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

Holds the current user information.

Definition at line 24 of file UserInfoData.h.

Member Typedef Documentation

◆ unwrapped

Constructor & Destructor Documentation

◆ UserInfoData() [1/2]

yarp::os::UserInfoData::UserInfoData ( )
default

◆ UserInfoData() [2/2]

yarp::os::UserInfoData::UserInfoData ( const std::string &  userName,
const std::string &  realName,
const std::string &  homeDir,
const std::int32_t  userID 
)

Definition at line 16 of file UserInfoData.cpp.

Member Function Documentation

◆ read() [1/2]

bool yarp::os::UserInfoData::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 50 of file UserInfoData.cpp.

◆ read() [2/2]

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

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

Definition at line 29 of file UserInfoData.cpp.

◆ toString()

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

Definition at line 97 of file UserInfoData.cpp.

◆ write() [1/2]

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

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

Definition at line 63 of file UserInfoData.cpp.

◆ write() [2/2]

bool yarp::os::UserInfoData::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 84 of file UserInfoData.cpp.

Member Data Documentation

◆ homeDir

std::string yarp::os::UserInfoData::homeDir {}

Definition at line 31 of file UserInfoData.h.

◆ realName

std::string yarp::os::UserInfoData::realName {}

Definition at line 30 of file UserInfoData.h.

◆ userID

std::int32_t yarp::os::UserInfoData::userID {0}

Definition at line 32 of file UserInfoData.h.

◆ userName

std::string yarp::os::UserInfoData::userName {}

Definition at line 29 of file UserInfoData.h.


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