Class: Sensor_msgs::TimeReference

Inherits:
ROS::Message
  • Object
show all
Defined in:
lib/sensor_msgs/TimeReference.rb

Constant Summary collapse

@@struct_L3 = 
::ROS::Struct.new("L3")
@@struct_L2 = 
::ROS::Struct.new("L2")
@@struct_L = 
::ROS::Struct.new("L")
@@slot_types = 
['Header','time','string']

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args = {}) ⇒ TimeReference

Constructor. You can set the default values using keyword operators.

Parameters:

  • args (Hash) (defaults to: {}) —

    keyword for initializing values

Options Hash (args):

  • :header (Header) —

    initialize value

  • :time_ref (time) —

    initialize value

  • :source (string) —

    initialize value



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/sensor_msgs/TimeReference.rb', line 65

def initialize(args={})
  # message fields cannot be None, assign default values for those that are
  if args[:header]
    @header = args[:header]
  else
    @header = Std_msgs::Header.new
  end
  if args[:time_ref]
    @time_ref = args[:time_ref]
  else
    @time_ref = ROS::Time.new
  end
  if args[:source]
    @source = args[:source]
  else
    @source = ''
  end
end

Instance Attribute Details

#header ⇒ Object

Returns the value of attribute header.



51
52
53
 
# File 'lib/sensor_msgs/TimeReference.rb', line 51

def header
  @header
end

#source ⇒ Object

Returns the value of attribute source.



51
52
53
 
# File 'lib/sensor_msgs/TimeReference.rb', line 51

def source
  @source
end

#time_ref ⇒ Object

Returns the value of attribute time_ref.



51
52
53
 
# File 'lib/sensor_msgs/TimeReference.rb', line 51

def time_ref
  @time_ref
end

Class Method Details

.md5sum ⇒ Object 



10
11
12
 
# File 'lib/sensor_msgs/TimeReference.rb', line 10

def self.md5sum
  "fded64a0265108ba86c3d38fb11c0c16"
end

.type ⇒ Object 



14
15
16
 
# File 'lib/sensor_msgs/TimeReference.rb', line 14

def self.type
  "sensor_msgs/TimeReference"
end

Instance Method Details

#_get_types ⇒ String

internal API method

Returns:

  • (String) —

    Message type string.



86
87
88
 
# File 'lib/sensor_msgs/TimeReference.rb', line 86

def _get_types
  @slot_types
end

#deserialize(str) ⇒ Object

unpack serialized message in str into this message instance

@param [String] str: byte array of serialized message



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/sensor_msgs/TimeReference.rb', line 110

def deserialize(str)

  begin
    if @header == nil
      @header = Std_msgs::Header.new
    end
    if @time_ref == nil
      @time_ref = ROS::Time.new
    end
    end_point = 0
    start = end_point
    end_point += ROS::Struct::calc_size('L3')
    (@header.seq, @header.stamp.secs, @header.stamp.nsecs,) = @@struct_L3.unpack(str[start..(end_point-1)])
    start = end_point
    end_point += 4
    (length,) = @@struct_L.unpack(str[start..(end_point-1)])
    start = end_point
    end_point += length
    @header.frame_id = str[start..(end_point-1)]
    start = end_point
    end_point += ROS::Struct::calc_size('L2')
    (@time_ref.secs, @time_ref.nsecs,) = @@struct_L2.unpack(str[start..(end_point-1)])
    start = end_point
    end_point += 4
    (length,) = @@struct_L.unpack(str[start..(end_point-1)])
    start = end_point
    end_point += length
    @source = str[start..(end_point-1)]
    return self
  rescue => exception
    raise "message DeserializationError: #{exception}" #most likely buffer underfill
  end
end

#has_header? ⇒ Boolean

Returns:

  • (Boolean) 


18
19
20
 
# File 'lib/sensor_msgs/TimeReference.rb', line 18

def has_header?
  true
end

#message_definition ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/sensor_msgs/TimeReference.rb', line 22

def message_definition
  "# Measurement from an external time source not actively synchronized with the system clock.

Header header    # stamp is system time for which measurement was valid
               # frame_id is not used 

time   time_ref  # corresponding time from this external source
string source    # (optional) name of time source

================================================================================
MSG: std_msgs/Header
# Standard metadata for higher-level stamped data types.
# This is generally used to communicate timestamped data 
# in a particular coordinate frame.
# 
# sequence ID: consecutively increasing ID 
uint32 seq
#Two-integer timestamp that is expressed as:
# * stamp.secs: seconds (stamp_secs) since epoch
# * stamp.nsecs: nanoseconds since stamp_secs
# time-handling sugar is provided by the client library
time stamp
#Frame this data is associated with
# 0: no frame
# 1: global frame
string frame_id

"
end

#serialize(buff) ⇒ Object

serialize message into buffer

Parameters:

  • buff (IO) —

    buffer



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/sensor_msgs/TimeReference.rb', line 92

def serialize(buff)
  begin
    buff.write(@@struct_L3.pack(@header.seq, @header.stamp.secs, @header.stamp.nsecs))
    _x = @header.frame_id
    length = _x.length
    buff.write([length, _x].pack("La#{length}"))
    buff.write(@@struct_L2.pack(@time_ref.secs, @time_ref.nsecs))
    _x = @source
    length = _x.length
    buff.write([length, _x].pack("La#{length}"))
  rescue => exception
    raise "some erro in serialize: #{exception}"

  end
end