Global

Members

(constant) ClockType :number

Enum for ClockType
Type:
  • number
Properties:
Name Type Description
ROS_TIME number
SYSTEM_TIME number
STEADY_TIME number
Source:

(readonly) DurabilityPolicy :number

Enum for DurabilityPolicy
Type:
  • number
Properties:
Name Type Description
RMW_QOS_POLICY_DURABILITY_SYSTEM_DEFAULT number
RMW_QOS_POLICY_DURABILITY_TRANSIENT_LOCAL number
RMW_QOS_POLICY_DURABILITY_VOLATILE number
Source:

(readonly) HistoryPolicy :number

Enum for HistoryPolicy
Type:
  • number
Properties:
Name Type Description
RMW_QOS_POLICY_HISTORY_SYSTEM_DEFAULT number
RMW_QOS_POLICY_HISTORY_KEEP_LAST number
RMW_QOS_POLICY_HISTORY_KEEP_ALL number
Source:

(readonly) LoggingSeverity :number

Enum for LoggingSeverity
Type:
  • number
Properties:
Name Type Description
UNSET number
DEBUG number
INFO number
WARN number
ERROR number
FATAL number
Source:

(constant) ParameterType :number

Enum for ParameterType
Type:
  • number
Properties:
Name Type Description
PARAMETER_NOT_SET number
PARAMETER_BOOL number
PARAMETER_INTEGER number
PARAMETER_DOUBLE number
PARAMETER_STRING number
PARAMETER_BYTE_ARRAY number
PARAMETER_BOOL_ARRAY number
PARAMETER_INTEGER_ARRAY number
PARAMETER_DOUBLE_ARRAY number
PARAMETER_STRING_ARRAY number
Source:

(readonly) ReliabilityPolicy :number

Enum for ReliabilityPolicy
Type:
  • number
Properties:
Name Type Description
RMW_QOS_POLICY_RELIABILITY_SYSTEM_DEFAULT number
RMW_QOS_POLICY_RELIABILITY_RELIABLE number
RMW_QOS_POLICY_RELIABILITY_BEST_EFFORT number
Source:

Methods

parameterTypeFromValue(value) → {ParameterType}

Infer a ParameterType for JS primitive types: string, boolean, number and arrays of these types. A TypeError is thrown for a value who's type is not one of the set listed.
Parameters:
Name Type Description
value any The value to infer it's ParameterType
Source:
Returns:
- The ParameterType that best scribes the value.
Type
ParameterType

validType(parameterType) → {boolean}

Determine if a number maps to is a valid ParameterType.
Parameters:
Name Type Description
parameterType ParameterType The value to test.
Source:
Returns:
- True if value is a valid ParameterType; false otherwise.
Type
boolean

validValue(value, type) → {boolean}

Test if value can be represented by a ParameterType.
Parameters:
Name Type Description
value number The value to test.
type ParameterType The ParameterType to test value against.
Source:
Returns:
- True if value can be represented by type.
Type
boolean

Type Definitions

RequestCallback(request, response) → {undefined}

This callback is called when a request is sent to service
Parameters:
Name Type Description
request Object The request sent to the service
response Response The response to client. Use response.send() to send response object to client
Source:
See:
Returns:
Type
undefined

ResponseCallback(response)

This callback is called when a resopnse is sent back from service
Parameters:
Name Type Description
response Object The response sent from the service
Source:
See:

SubscriptionCallback(message)

This callback is called when a message is published
Parameters:
Name Type Description
message Object The message published
Source:
See: