apollo::cyber Namespace Reference

Namespaces
	base
	binary
	blocker
	class_loader
	common
	croutine
	data
	event
	io
	logger
	mainboard
	message
	proto
	record
	scheduler
	service_discovery
	transport

Classes
class	Client
	Client get Response from a responding Service by sending a Request. More...
class	ClientBase
	Base class of Client. More...
class	Clock
	a singleton clock that can be used to get the current timestamp. The source can be either system(cyber) clock or a mock clock. Mock clock is for testing purpose mainly. More...
class	Component
	The Component can process up to four channels of messages. The message type is specified when the component is created. The Component is inherited from ComponentBase. Your component can inherit from Component, and implement Init() & Proc(...), They are picked up by the CyberRT. There are 4 specialization implementations. More...
class	Component< M0, M1, M2, NullType >
class	Component< M0, M1, NullType, NullType >
class	Component< M0, NullType, NullType, NullType >
class	Component< NullType, NullType, NullType, NullType >
class	ComponentBase
class	Duration
class	Node
	Node is the fundamental building block of Cyber RT. every module contains and communicates through the node. A module can have different types of communication by defining read/write and/or service/client in a node. More...
class	NodeChannelImpl
	The implementation for Node to create Objects connected by Channels. e.g. Channel Reader and Writer. More...
class	NodeServiceImpl
	The implementation for Node to create Objects connected by Param. e.g. Param Server and Client. More...
class	NullType
class	Parameter
	A Parameter holds an apollo::cyber::proto::Param, It's more human-readable, you can use basic-value type and Protobuf values to construct a paramter. Parameter is identified by their name, and you can get Parameter content by call value() More...
class	ParameterClient
	Parameter Client is used to set/get/list parameter(s) by sending a request to ParameterServer. More...
class	ParameterServer
	Parameter Service is a very important function of auto-driving. If you want to set a key-value, and hope other nodes to get the value, Routing, sensor internal/external references are set by Parameter Service ParameterServer can set a parameter, and then you can get/list paramter(s) by start a ParameterClient to send responding request. More...
class	PyChannelUtils
class	PyClient
class	PyDuration
class	PyNode
class	PyNodeUtils
class	PyParameter
class	PyParameterClient
class	PyParameterServer
class	PyRate
class	PyReader
class	PyService
class	PyServiceUtils
class	PyTime
class	PyTimer
class	PyWriter
class	Rate
class	Reader
	Reader subscribes a channel, it has two main functions: More...
class	ReaderBase
	Base Class for Reader Reader is identified by one apollo::cyber::proto::RoleAttribute, it contains the channel_name, channel_id that we subscribe, and host_name, process_id and node that we are located, and qos that describes our transportation quality. More...
struct	ReaderConfig
class	ReceiverManager
	One Channel is related to one Receiver. ReceiverManager is in charge of attaching one Receiver to its responding Channel. We pass a DataDispatche's callback func to this Receiver so when a message is received, it will be push to the ChannelBuffer, and DataVisitor will Fetch data and pass to Reader's callback func. More...
class	Service
	Service handles Request from the Client, and send a Response to it. More...
class	ServiceBase
	Base class for Service. More...
class	SysMo
class	TaskManager
class	Time
	Cyber has builtin time type Time. More...
class	Timer
	Used to perform oneshot or periodic timing tasks. More...
class	TimerBucket
class	TimerComponent
	TimerComponent is a timer component. Your component can inherit from Component, and implement Init() & Proc(), They are called by the CyberRT frame. More...
struct	TimerOption
	The options of timer. More...
struct	TimerTask
class	TimingWheel
class	Writer
class	WriterBase
	Base class for a Writer. A Writer is an object to send messages through a 'Channel'. More...

Typedefs
template<typename M0 >
using	CallbackFunc = std::function< void(const std::shared_ptr< M0 > &)>
using	PyMsgWrapPtr = std::shared_ptr< message::PyMessageWrap >

Enumerations
enum	ReturnCode { SUCC = 0, FAIL = 1 }
enum	Relation : std::uint8_t { NO_RELATION = 0, DIFF_HOST, DIFF_PROC, SAME_PROC }
	Describe relation between nodes, writers/readers... More...
enum	State : std::uint8_t { STATE_UNINITIALIZED = 0, STATE_INITIALIZED, STATE_SHUTTING_DOWN, STATE_SHUTDOWN }

Functions
std::unique_ptr< Node >	CreateNode (const std::string &node_name, const std::string &name_space="")
bool	Init (const char *binary_name)
void	Clear ()
bool	py_init (const std::string &module_name)
bool	py_ok ()
void	py_shutdown ()
bool	py_is_shutdown ()
void	py_waitforshutdown ()
State	GetState ()
void	SetState (const State &state)
bool	OK ()
bool	IsShutdown ()
void	WaitForShutdown ()
void	AsyncShutdown ()
std::ostream &	operator<< (std::ostream &os, const Duration &rhs)
std::ostream &	operator<< (std::ostream &os, const Time &rhs)

Variables
const uint32_t	DEFAULT_PENDING_QUEUE_SIZE = 1
constexpr auto	SERVICE_NAME_DELIMITER = "/"
constexpr auto	GET_PARAMETER_SERVICE_NAME = "get_parameter"
constexpr auto	SET_PARAMETER_SERVICE_NAME = "set_parameter"
constexpr auto	LIST_PARAMETERS_SERVICE_NAME = "list_parameters"
const char	RAWDATATYPE [] = "RawData"

Typedef Documentation

CallbackFunc

template<typename M0 >

using apollo::cyber::CallbackFunc = typedef std::function<void(const std::shared_ptr<M0>&)>

PyMsgWrapPtr

using apollo::cyber::PyMsgWrapPtr = typedef std::shared_ptr<message::PyMessageWrap>

Enumeration Type Documentation

Relation

enum apollo::cyber::Relation : std::uint8_t

Describe relation between nodes, writers/readers...

Enumerator
NO_RELATION
DIFF_HOST
DIFF_PROC
SAME_PROC

ReturnCode

enum apollo::cyber::ReturnCode

Enumerator
SUCC
FAIL

State

enum apollo::cyber::State : std::uint8_t

Enumerator
STATE_UNINITIALIZED
STATE_INITIALIZED
STATE_SHUTTING_DOWN
STATE_SHUTDOWN

Function Documentation

AsyncShutdown()

void apollo::cyber::AsyncShutdown ( )

inline

Clear()

void apollo::cyber::Clear

(

)

CreateNode()

std::unique_ptr<Node> apollo::cyber::CreateNode	(	const std::string &	node_name,
		const std::string &	name_space = ""
	)

GetState()

State apollo::cyber::GetState

(

)

Init()

bool apollo::cyber::Init

(

const char *

binary_name

)

IsShutdown()

bool apollo::cyber::IsShutdown ( )

inline

OK()

bool apollo::cyber::OK ( )

inline

operator<<() [1/2]

std::ostream& apollo::cyber::operator<<	(	std::ostream &	os,
		const Duration &	rhs
	)

operator<<() [2/2]

std::ostream& apollo::cyber::operator<<	(	std::ostream &	os,
		const Time &	rhs
	)

py_init()

bool apollo::cyber::py_init ( const std::string &  module_name )

inline

py_is_shutdown()

bool apollo::cyber::py_is_shutdown ( )

inline

py_ok()

bool apollo::cyber::py_ok ( )

inline

py_shutdown()

void apollo::cyber::py_shutdown ( )

inline

py_waitforshutdown()

void apollo::cyber::py_waitforshutdown ( )

inline

SetState()

void apollo::cyber::SetState

(

const State &

state

)

WaitForShutdown()

void apollo::cyber::WaitForShutdown ( )

inline

Variable Documentation

DEFAULT_PENDING_QUEUE_SIZE

const uint32_t apollo::cyber::DEFAULT_PENDING_QUEUE_SIZE = 1

GET_PARAMETER_SERVICE_NAME

constexpr auto apollo::cyber::GET_PARAMETER_SERVICE_NAME = "get_parameter"

LIST_PARAMETERS_SERVICE_NAME

constexpr auto apollo::cyber::LIST_PARAMETERS_SERVICE_NAME = "list_parameters"

RAWDATATYPE

const char apollo::cyber::RAWDATATYPE[] = "RawData"

SERVICE_NAME_DELIMITER

constexpr auto apollo::cyber::SERVICE_NAME_DELIMITER = "/"

SET_PARAMETER_SERVICE_NAME

constexpr auto apollo::cyber::SET_PARAMETER_SERVICE_NAME = "set_parameter"