cli.argtypes.DpTypeParamType Class Reference

CLI argument type for use with arguments that represent a RTC Toolkit type object. More...

Inheritance diagram for cli.argtypes.DpTypeParamType:

Public Member Functions
	convert (self, value, param, ctx)
	Convert from string to corresponding RTC Toolkit type object, signalling a failure if the conversion was not possible.

Static Public Member Functions
	string_to_type (string)
	Convert from string to corresponding RTC Toolkit type object, or return None if the string is invalid.
	type_to_string (type)
	Converts back from a RTC Toolkit type object to a string.

Static Public Attributes
str	name = "type"
dict	type_map
	inverse_type_map = dict([(value, key) for key, value in type_map.items()])

Detailed Description

CLI argument type for use with arguments that represent a RTC Toolkit type object.

This is used with the click module.

Member Function Documentation

convert()

cli.argtypes.DpTypeParamType.convert	(		self,
			value,
			param,
			ctx )

Convert from string to corresponding RTC Toolkit type object, signalling a failure if the conversion was not possible.

string_to_type()

cli.argtypes.DpTypeParamType.string_to_type ( string )

static

Convert from string to corresponding RTC Toolkit type object, or return None if the string is invalid.

type_to_string()

cli.argtypes.DpTypeParamType.type_to_string ( type )

static

Converts back from a RTC Toolkit type object to a string.

i.e. the inverse of convert().

Member Data Documentation

inverse_type_map

cli.argtypes.DpTypeParamType.inverse_type_map = dict([(value, key) for key, value in type_map.items()])

static

name

str cli.argtypes.DpTypeParamType.name = "type"

static

type_map

dict cli.argtypes.DpTypeParamType.type_map

static

---

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

• clients/common/src/rtctk/common/cli/argtypes.py