Public Member Functions | Static Public Attributes | Private Attributes | Static Private Attributes
com.github.rosjava.android_remocons.common_tools.master.MasterDescription Class Reference
Inheritance diagram for com.github.rosjava.android_remocons.common_tools.master.MasterDescription:
Inheritance graph
[legend]

List of all members.

Public Member Functions

void copyFrom (MasterDescription other)
boolean equals (Object o)
String getAppsNameSpace ()
String getConnectionStatus ()
String getMasterFriendlyName ()
ChannelBuffer getMasterIconData ()
String getMasterIconFormat ()
MasterId getMasterId ()
String getMasterName ()
String getMasterType ()
String getMasterUri ()
Date getTimeLastSeen ()
int hashCode ()
boolean isUnknown ()
 MasterDescription ()
 MasterDescription (MasterId masterId, String masterName, String masterType, Icon masterIcon, String appsNameSpace, Date timeLastSeen)
void setConnectionStatus (String connectionStatus)
void setMasterIcon (Icon masterIcon)
void setMasterIconData (ChannelBuffer iconData)
void setMasterIconFormat (String iconFormat)
void setMasterId (MasterId masterId)
void setMasterName (String masterName)
void setMasterType (String masterType)
void setTimeLastSeen (Date timeLastSeen)

Static Public Attributes

static final String CONNECTING = "connecting..."
static final String CONTROL = "not started"
static final String ERROR = "exception"
static final String NAME_UNKNOWN = "Unknown"
static final String OK = "ok"
static final String TYPE_UNKNOWN = "Unknown"
static final String UNAVAILABLE = "unavailable"
static final String UNIQUE_KEY = "com.github.rosjava.android_remocons.master.MasterDescription"
static final String WIFI = "invalid wifi"

Private Attributes

String appsNameSpace
String connectionStatus
byte[] masterIconData
int masterIconDataLength
int masterIconDataOffset
String masterIconFormat
MasterId masterId
String masterName
String masterType
Date timeLastSeen

Static Private Attributes

static final long serialVersionUID = 1L

Detailed Description

Mostly a clone of RobotDescription but generic enough to work also for concert apps.

Author:
jorge@yujinrobot.com (Jorge Santos Simon)

Definition at line 51 of file MasterDescription.java.

Constructor & Destructor Documentation

com.github.rosjava.android_remocons.common_tools.master.MasterDescription.MasterDescription ( ) [inline]

Definition at line 81 of file MasterDescription.java.

com.github.rosjava.android_remocons.common_tools.master.MasterDescription.MasterDescription ( MasterId  masterId,
String  masterName,
String  masterType,
Icon  masterIcon,
String  appsNameSpace,
Date  timeLastSeen 
) [inline]

Definition at line 84 of file MasterDescription.java.

Member Function Documentation

void com.github.rosjava.android_remocons.common_tools.master.MasterDescription.copyFrom ( MasterDescription  other) [inline]

Definition at line 100 of file MasterDescription.java.

boolean com.github.rosjava.android_remocons.common_tools.master.MasterDescription.equals ( Object  o) [inline]

Definition at line 243 of file MasterDescription.java.

String com.github.rosjava.android_remocons.common_tools.master.MasterDescription.getAppsNameSpace ( ) [inline]

Definition at line 117 of file MasterDescription.java.

String com.github.rosjava.android_remocons.common_tools.master.MasterDescription.getConnectionStatus ( ) [inline]

Definition at line 218 of file MasterDescription.java.

String com.github.rosjava.android_remocons.common_tools.master.MasterDescription.getMasterFriendlyName ( ) [inline]

Provide a human-friendly interpretation of the master name

Often we use master names with a uuid suffix to ensure the master name in a multi-master group is unique. This checks for the suffix and if found, strips it.

It also converts '_'s to spaces and first character of each word to uppercase.

Returns:
human friendly string name

Definition at line 153 of file MasterDescription.java.

ChannelBuffer com.github.rosjava.android_remocons.common_tools.master.MasterDescription.getMasterIconData ( ) [inline]

Definition at line 196 of file MasterDescription.java.

String com.github.rosjava.android_remocons.common_tools.master.MasterDescription.getMasterIconFormat ( ) [inline]

Definition at line 192 of file MasterDescription.java.

MasterId com.github.rosjava.android_remocons.common_tools.master.MasterDescription.getMasterId ( ) [inline]

Definition at line 113 of file MasterDescription.java.

String com.github.rosjava.android_remocons.common_tools.master.MasterDescription.getMasterName ( ) [inline]

Definition at line 139 of file MasterDescription.java.

String com.github.rosjava.android_remocons.common_tools.master.MasterDescription.getMasterType ( ) [inline]

Definition at line 184 of file MasterDescription.java.

String com.github.rosjava.android_remocons.common_tools.master.MasterDescription.getMasterUri ( ) [inline]

Convenience accessor to dig into the master uri for this master.

Returns:
String : the ros master uri for this master.

Definition at line 126 of file MasterDescription.java.

Date com.github.rosjava.android_remocons.common_tools.master.MasterDescription.getTimeLastSeen ( ) [inline]

Definition at line 226 of file MasterDescription.java.

int com.github.rosjava.android_remocons.common_tools.master.MasterDescription.hashCode ( ) [inline]

Definition at line 267 of file MasterDescription.java.

boolean com.github.rosjava.android_remocons.common_tools.master.MasterDescription.isUnknown ( ) [inline]

Definition at line 234 of file MasterDescription.java.

void com.github.rosjava.android_remocons.common_tools.master.MasterDescription.setConnectionStatus ( String  connectionStatus) [inline]

Definition at line 222 of file MasterDescription.java.

void com.github.rosjava.android_remocons.common_tools.master.MasterDescription.setMasterIcon ( Icon  masterIcon) [inline]

Definition at line 213 of file MasterDescription.java.

void com.github.rosjava.android_remocons.common_tools.master.MasterDescription.setMasterIconData ( ChannelBuffer  iconData) [inline]

Definition at line 209 of file MasterDescription.java.

void com.github.rosjava.android_remocons.common_tools.master.MasterDescription.setMasterIconFormat ( String  iconFormat) [inline]

Definition at line 205 of file MasterDescription.java.

void com.github.rosjava.android_remocons.common_tools.master.MasterDescription.setMasterId ( MasterId  masterId) [inline]

Definition at line 130 of file MasterDescription.java.

void com.github.rosjava.android_remocons.common_tools.master.MasterDescription.setMasterName ( String  masterName) [inline]

Definition at line 175 of file MasterDescription.java.

void com.github.rosjava.android_remocons.common_tools.master.MasterDescription.setMasterType ( String  masterType) [inline]

Definition at line 188 of file MasterDescription.java.

void com.github.rosjava.android_remocons.common_tools.master.MasterDescription.setTimeLastSeen ( Date  timeLastSeen) [inline]

Definition at line 230 of file MasterDescription.java.

Member Data Documentation

String com.github.rosjava.android_remocons.common_tools.master.MasterDescription.appsNameSpace [private]

Definition at line 68 of file MasterDescription.java.

final String com.github.rosjava.android_remocons.common_tools.master.MasterDescription.CONNECTING = "connecting..." [static]

Definition at line 56 of file MasterDescription.java.

String com.github.rosjava.android_remocons.common_tools.master.MasterDescription.connectionStatus [private]

Definition at line 77 of file MasterDescription.java.

final String com.github.rosjava.android_remocons.common_tools.master.MasterDescription.CONTROL = "not started" [static]

Definition at line 61 of file MasterDescription.java.

final String com.github.rosjava.android_remocons.common_tools.master.MasterDescription.ERROR = "exception" [static]

Definition at line 58 of file MasterDescription.java.

byte [] com.github.rosjava.android_remocons.common_tools.master.MasterDescription.masterIconData [private]

Definition at line 73 of file MasterDescription.java.

int com.github.rosjava.android_remocons.common_tools.master.MasterDescription.masterIconDataLength [private]

Definition at line 75 of file MasterDescription.java.

int com.github.rosjava.android_remocons.common_tools.master.MasterDescription.masterIconDataOffset [private]

Definition at line 74 of file MasterDescription.java.

String com.github.rosjava.android_remocons.common_tools.master.MasterDescription.masterIconFormat [private]

Icon stored piecemeal because msg arrays (stored as jboss ChannelBuffers) can't be dumped and reloaded by the snakeyaml library.

Definition at line 72 of file MasterDescription.java.

MasterId com.github.rosjava.android_remocons.common_tools.master.MasterDescription.masterId [private]

Definition at line 65 of file MasterDescription.java.

String com.github.rosjava.android_remocons.common_tools.master.MasterDescription.masterName [private]

Definition at line 66 of file MasterDescription.java.

String com.github.rosjava.android_remocons.common_tools.master.MasterDescription.masterType [private]

Definition at line 67 of file MasterDescription.java.

final String com.github.rosjava.android_remocons.common_tools.master.MasterDescription.NAME_UNKNOWN = "Unknown" [static]

Definition at line 62 of file MasterDescription.java.

final String com.github.rosjava.android_remocons.common_tools.master.MasterDescription.OK = "ok" [static]

Definition at line 57 of file MasterDescription.java.

final long com.github.rosjava.android_remocons.common_tools.master.MasterDescription.serialVersionUID = 1L [static, private]

Reimplemented in com.github.rosjava.android_remocons.common_tools.master.RoconDescription.

Definition at line 54 of file MasterDescription.java.

Date com.github.rosjava.android_remocons.common_tools.master.MasterDescription.timeLastSeen [private]

Definition at line 78 of file MasterDescription.java.

final String com.github.rosjava.android_remocons.common_tools.master.MasterDescription.TYPE_UNKNOWN = "Unknown" [static]

Definition at line 63 of file MasterDescription.java.

final String com.github.rosjava.android_remocons.common_tools.master.MasterDescription.UNAVAILABLE = "unavailable" [static]

Definition at line 60 of file MasterDescription.java.

final String com.github.rosjava.android_remocons.common_tools.master.MasterDescription.UNIQUE_KEY = "com.github.rosjava.android_remocons.master.MasterDescription" [static]

Definition at line 53 of file MasterDescription.java.

final String com.github.rosjava.android_remocons.common_tools.master.MasterDescription.WIFI = "invalid wifi" [static]

Definition at line 59 of file MasterDescription.java.

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

android_remocons
Author(s): Daniel Stonier, Kazuto Murase
autogenerated on Sat Jun 8 2019 19:32:24