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

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

#include <yarp/os/PortInfo.h>

Detailed Description

Information about a port connection or event.

Definition at line 30 of file PortInfo.h.

Public Types

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

Public Member Functions

 PortInfo ()
 Constructor. More...
 
 YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG (std::string) portName
 Name of port. More...
 
 YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG (std::string) sourceName
 Name of connection source, if any. More...
 
 YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG (std::string) targetName
 Name of connection target, if any. More...
 
 YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG (std::string) carrierName
 Name of protocol type, if releveant. More...
 
 YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG (std::string) message
 A human-readable description of contents. 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...
 

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Possible tag values.

Enumerator
PORTINFO_NULL 

No information.

PORTINFO_CONNECTION 

Information about an incoming or outgoing connection.

PORTINFO_MISC 

Unspecified information.

Definition at line 38 of file PortInfo.h.

Constructor & Destructor Documentation

◆ PortInfo()

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

Constructor.

Definition at line 13 of file PortInfo.cpp.

Member Function Documentation

◆ YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG() [1/5]

yarp::os::PortInfo::YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG ( std::string  )

Name of port.

◆ YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG() [2/5]

yarp::os::PortInfo::YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG ( std::string  )

Name of connection source, if any.

◆ YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG() [3/5]

yarp::os::PortInfo::YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG ( std::string  )

Name of connection target, if any.

◆ YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG() [4/5]

yarp::os::PortInfo::YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG ( std::string  )

Name of protocol type, if releveant.

◆ YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG() [5/5]

yarp::os::PortInfo::YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG ( std::string  )

A human-readable description of contents.

Member Data Documentation

◆ created

bool yarp::os::PortInfo::created

True if a connection is created, false if destroyed.

Definition at line 57 of file PortInfo.h.

◆ incoming

bool yarp::os::PortInfo::incoming

True if a connection is incoming, false if outgoing.

Definition at line 54 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 51 of file PortInfo.h.


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