Class ObjectTypeMsg
ROS object_recognition_msgs/ObjectType message.
Implements
Inherited Members
Namespace: Unity.SimulationPro.Foundation.ObjectRecognitionMessages
Assembly: Unity.SimulationPro.Foundation.dll
Syntax
[Serializable]
public class ObjectTypeMsg : IMessage
Constructors
ObjectTypeMsg()
Initializes a new instance with default values.
Declaration
public ObjectTypeMsg()
ObjectTypeMsg(string, string)
Initializes a new instance with default values.
Declaration
public ObjectTypeMsg(string key, string db)
Parameters
| Type | Name | Description |
|---|---|---|
| string | key | Lookup key in a key-value pair. |
| string | db | The db. |
Fields
db
The db parameters stored as a JSON/compressed YAML string. An object id does not make sense without the corresponding database. E.g., in object_recognition, it can look like: "{'type':'CouchDB', 'root':'http://localhost'}" There is no conventional format for those parameters and it's nice to keep that flexibility. The object_recognition_core as a generic DB type that can read those fields Current examples: For CouchDB: type: 'CouchDB' root: 'http://localhost:5984' collection: 'object_recognition' For SQL household database: type: 'SqlHousehold' host: 'wgs36' port: 5432 user: 'willow' password: 'willow' name: 'household_objects' module: 'tabletop'
Declaration
public string db
Field Value
| Type | Description |
|---|---|
| string |
k_MessageTypeId
Identifier for this message type.
Declaration
public static readonly MessageTypeId k_MessageTypeId
Field Value
| Type | Description |
|---|---|
| MessageTypeId |
k_MessageTypeName
The ROS message type name string used for serialization and topic matching.
Declaration
public const string k_MessageTypeName = "object_recognition_msgs/ObjectType"
Field Value
| Type | Description |
|---|---|
| string |
key
################################################# OBJECT ID ######################################################### Contains information about the type of a found object. Those two sets of parameters together uniquely define an object The key of the found object: the unique identifier in the given db
Declaration
public string key
Field Value
| Type | Description |
|---|---|
| string |
Properties
MessageTypeId
Gets the unique runtime identifier for this message type.
Declaration
public MessageTypeId MessageTypeId { get; }
Property Value
| Type | Description |
|---|---|
| MessageTypeId |
MessageTypeName
Gets the ROS message type name for this message.
Declaration
public string MessageTypeName { get; }
Property Value
| Type | Description |
|---|---|
| string |
Methods
Deserialize(IMessageDeserializer)
Deserializes a ObjectTypeMsg from the given deserializer.
Declaration
public static ObjectTypeMsg Deserialize(IMessageDeserializer deserializer)
Parameters
| Type | Name | Description |
|---|---|---|
| IMessageDeserializer | deserializer | The deserializer. |
Returns
| Type | Description |
|---|---|
| ObjectTypeMsg | A new ObjectTypeMsg instance. |
Register()
Registers this message type with the MessageTypeRegistry.
Declaration
[InitializeOnLoadMethod]
public static void Register()
ToString()
Returns a human-readable string representation of this message.
Declaration
public override string ToString()
Returns
| Type | Description |
|---|---|
| string | A string representation of this instance. |
Overrides
WriteTo(IMessageSerializer)
Serializes this message to the given serializer.
Declaration
public void WriteTo(IMessageSerializer serializer)
Parameters
| Type | Name | Description |
|---|---|---|
| IMessageSerializer | serializer | The serializer. |