This is a schema registration class. More...

#include <tesseract/common/schema_registration.h>
#include <tesseract/common/schema_registry.h>
#include <tesseract/common/property_tree.h>

Functions
void	tesseract::common::registerSchema (const std::string &key, const std::string &path)
	Register a schema from a file path.

void	tesseract::common::registerSchema (const std::string &key, const std::function< PropertyTree()> &fn)
	Register a schema from a function.

void	tesseract::common::registerSchemaDerivedType (const std::string &base_type, const std::string &derived_type)
	Register that a derived type schema can be used where a base type is expected.

Detailed Description

This is a schema registration class.

: Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

: Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Function Documentation

void tesseract::common::registerSchema	(	const std::string &	key,
		const std::string &	path
	)

Register a schema from a file path.

Parameters

key	Unique identifier for this schema.
path	Path to a .yaml schema file.

void tesseract::common::registerSchema	(	const std::string &	key,
		const std::function< PropertyTree()> &	fn
	)

Register a schema from a function.

Parameters

key	Unique identifier for this schema.
fn	Function that returns a PropertyTree schema.

void tesseract::common::registerSchemaDerivedType	(	const std::string &	base_type,
		const std::string &	derived_type
	)

Register that a derived type schema can be used where a base type is expected.

Parameters

base_type	The base type name
derived_type	The derived type name