YARP  2.3.70.1
Yet Another Robot Platform
yarp::os::PortInfo Class Reference

Information about a port connection or event. More...

#include <yarp/os/PortInfo.h>

Public Types

enum  {
  PORTINFO_NULL = 0,
  PORTINFO_CONNECTION = VOCAB4(99, 'o', 'n', 'n'),
  PORTINFO_MISC = VOCAB4('m', 'i', 's', 'c')
}
 Possible tag values. More...
 

Public Member Functions

 PortInfo ()
 Constructor. More...
 

Public Attributes

int tag
 Type of information. More...
 
bool incoming
 True if a connection is incoming, false if outgoing. More...
 
bool created
 True if a connection is created, false if destroyed. More...
 
ConstString portName
 Name of port. More...
 
ConstString sourceName
 Name of connection source, if any. More...
 
ConstString targetName
 Name of connection target, if any. More...
 
ConstString carrierName
 Name of protocol type, if releveant. More...
 
ConstString message
 A human-readable description of contents. More...
 

Detailed Description

Information about a port connection or event.

Definition at line 26 of file PortInfo.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Possible tag values.

Enumerator
PORTINFO_NULL 

No information.

PORTINFO_CONNECTION 

Information about an incoming or outgoing connection.

SWIG currently has bug if 'c' used in this macro!

PORTINFO_MISC 

Unspecified information.

Definition at line 34 of file PortInfo.h.

Constructor & Destructor Documentation

◆ PortInfo()

yarp::os::PortInfo::PortInfo ( )
explicit

Constructor.

Definition at line 10 of file PortInfo.cpp.

Member Data Documentation

◆ carrierName

ConstString yarp::os::PortInfo::carrierName

Name of protocol type, if releveant.

Definition at line 66 of file PortInfo.h.

◆ created

bool yarp::os::PortInfo::created

True if a connection is created, false if destroyed.

Definition at line 54 of file PortInfo.h.

◆ incoming

bool yarp::os::PortInfo::incoming

True if a connection is incoming, false if outgoing.

Definition at line 51 of file PortInfo.h.

◆ message

ConstString yarp::os::PortInfo::message

A human-readable description of contents.

Definition at line 69 of file PortInfo.h.

◆ portName

ConstString yarp::os::PortInfo::portName

Name of port.

Definition at line 57 of file PortInfo.h.

◆ sourceName

ConstString yarp::os::PortInfo::sourceName

Name of connection source, if any.

Definition at line 60 of file PortInfo.h.

◆ tag

int yarp::os::PortInfo::tag

Type of information.

PORTINFO_CONNECTION for information about an incoming or outgoing connection.

Definition at line 48 of file PortInfo.h.

◆ targetName

ConstString yarp::os::PortInfo::targetName

Name of connection target, if any.

Definition at line 63 of file PortInfo.h.


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