#include <base.h>

Inheritance diagram for cgv::base::base:

Public Member Functions
virtual std::string	get_type_name () const
	overload to return the type name of this object. By default the type interface is queried over get_type. More...

virtual std::string	get_default_options () const
	overload to provide default options for registration

virtual void	on_register ()
	overload to handle register events that is sent after the instance has been registered More...

virtual void	unregister ()
	overload to handle unregistration of instances

virtual void	stream_stats (std::ostream &)
	overload to show the content of this object

virtual data::ref_ptr< named, true >	get_named ()
	cast upward to named

virtual data::ref_ptr< node, true >	get_node ()
	cast upward to node

virtual data::ref_ptr< group, true >	get_group ()
	cast upward to group

template<class T >
data::ref_ptr< T, true >	cast ()
	cast to arbitrary class, but use the casts to named, node and group from the interface

template<class T >
T *	get_interface ()
	use dynamic type cast to check for the given interface

template<class T >
const T *	get_const_interface () const
	use dynamic type cast to check for the given interface

virtual void	update ()
	this virtual update allows for example to ask a view to update the viewed value. The default implementation is empty.

virtual void *	get_user_data () const
	this virtual method allows to pass application specific data for internal purposes More...

int	get_ref_count () const
	read access to current count

Protected Member Functions
virtual	~base ()
	make destructor virtual and not accessible from outside

void	set_ref_count (int c) const
	write access is also const to allow ref counted pointers to const instances

Static Protected Member Functions
template<class T >
static data::ref_ptr< T, true >	cast_dynamic (base *b)
	use dynamic cast for upcast to given class

Friends
class	data::ref_ptr_impl< base, true >
	give ref_ptr access to destructor

struct	cast_helper_base
	give cast_helper_base access to cast_dynamic

property interface
virtual bool	self_reflect (cgv::reflect::reflection_handler &)
	used for simple self reflection More...

virtual std::string	get_property_declarations ()
	return a semicolon separated list of property declarations More...

virtual bool	set_void (const std::string &property, const std::string &value_type, const void *value_ptr)
	abstract interface for the setter of a dynamic property. More...

virtual void	on_set (void *member_ptr)
	this callback is called when the set_void method has changed a member and can be overloaded in derived class

virtual bool	get_void (const std::string &property, const std::string &value_type, void *value_ptr)
	abstract interface for the getter of a dynamic property. More...

virtual bool	call_void (const std::string &method, const std::vector< std::string > &param_value_types, const std::vector< const void * > &param_value_ptrs, const std::string &result_type="", void *result_value_ptr=0)
	abstract interface to call an action More...

void	set (const std::string &property, const char *value)
	specialization of set method to support const char* as strings

template<typename T >
void	set (const std::string &property, const T &value)
	set a property of the element to the given value and perform standard conversions if necessary. More...

template<typename T >
T	get (const std::string &property)
	query a property of the element and perform standard conversions if necessary. More...

void	multi_set (const std::string &property_assignments, bool report_error=true)
	set several properties More...

bool	is_property (const std::string &property_name, std::string *type_name=0)
	check if the given name specifies a property. More...

void *	find_member_ptr (const std::string &property_name, std::string *type_name=0)
	find a member pointer by name. More...

Detailed Description

base class for all classes that can be registered with support for dynamic properties (see also section Base Hierarchy of page Namespace cgv::base).

Member Function Documentation

◆ call_void()

bool cgv::base::base::call_void	(	const std::string &	method,
		const std::vector< std::string > &	param_value_types,
		const std::vector< const void * > &	param_value_ptrs,
		const std::string &	result_type = `""`,
		void *	result_value_ptr = `0`
	)

virtual

abstract interface to call an action

overload to implement the execution of a method based on the method name and the given parameters

, i.e. a class method based on the action name and the given parameters. The default implementation uses the self_reflect() method to dispatch this call. If not found, the get_void method returns false.

◆ find_member_ptr()

void * cgv::base::base::find_member_ptr	(	const std::string &	property_name,
		std::string *	type_name = `0`
	)

find a member pointer by name.

If not found the null pointer is returned. If the type name string pointer is provided, the type of the property is copied to the referenced string.

◆ get()

template<typename T >

T cgv::base::base::get ( const std::string & property )

inline

query a property of the element and perform standard conversions if necessary.

This templated version simply extracts the type of the value from the reference and calls the set_void() method. Note that this only works if the template cgv::type::info::type_name<T> is overloaded for the value type.

◆ get_property_declarations()

std::string cgv::base::base::get_property_declarations ( )

virtual

return a semicolon separated list of property declarations

return a semicolon separated list of property declarations of the form "name:type", by default an empty list is returned

of the form "name1:type1;name2:type2;...", by default an empty list is returned. The types should by consistent with the names returned by cgv::type::info::type_name::get_name. The default implementation extracts names and types from the self_reflect() method and the meta type information provided by the get_type() method.

Reimplemented in cgv::base::factory, cgv::base::base_generator, cgv::media::image::image_reader, cgv::media::video::video_writer, cgv::media::image::image_writer, cgv::media::video::video_reader, and cgv::base::console.

◆ get_type_name()

std::string cgv::base::base::get_type_name ( ) const

virtual

overload to return the type name of this object. By default the type interface is queried over get_type.

overload to return the type name of this object

Reimplemented in cgv::render::render_config, cgv::base::test, cgv::base::factory_impl_2< T, CA1, CA2 >, cgv::base::factory_impl_1< T, CA >, cgv::base::factory_impl< T >, cgv::base::object_constructor, cgv::base::base_generator, cgv::media::image::image_reader, cgv::media::video::video_writer, cgv::media::image::image_writer, cgv::media::font::font, cgv::media::image::reader_listener, cgv::media::video::video_reader, cgv::gui::gui_group, cgv::base::group, cgv::media::video::video_writer_listener, cgv::render::shader_config, cgv::media::font::font_face, cgv::base::node, cgv::base::named, cgv::base::console, cgv::media::image::bmp_reader, cgv::media::video::video_reader_listener, cgv::media::image::bmp_writer, cgv::media::image::writer_listener, cgv::gui::window, and cgv::gui::button.

◆ get_user_data()

void * cgv::base::base::get_user_data ( ) const

virtual

this virtual method allows to pass application specific data for internal purposes

this virtual method allows derived classes to pass application specific data

◆ get_void()

bool cgv::base::base::get_void	(	const std::string &	property,
		const std::string &	value_type,
		void *	value_ptr
	)

virtual

abstract interface for the getter of a dynamic property.

abstract interface for the getter, by default it simply returns false

The default implementation uses the self_reflect() method to find a member with the given property as name. If not found, the get_void method returns false.

Reimplemented in cgv::base::factory, cgv::base::base_generator, cgv::base::console, cgv::media::image::image_reader, cgv::media::image::image_writer, cgv::media::video::video_reader, and cgv::media::video::video_writer.

◆ is_property()

bool cgv::base::base::is_property	(	const std::string &	property_name,
		std::string *	type_name = `0`
	)

check if the given name specifies a property.

If the type name string pointer is provided, the type of the property is copied to the referenced string.

◆ multi_set()

void cgv::base::base::multi_set	(	const std::string &	property_assignments,
		bool	report_error = `true`
	)

set several properties

set several properties, which are defined as colon separated assignments, where the types are derived automatically

, which are defined as colon separated assignments, where the types are derived automatically to bool, int, double or std::string.

◆ on_register()

void cgv::base::base::on_register ( )

virtual

overload to handle register events that is sent after the instance has been registered

overload to return a type info structure. By default an empty pointer is returned.

◆ self_reflect()

bool cgv::base::base::self_reflect ( cgv::reflect::reflection_handler & )

virtual

used for simple self reflection

is used by default implementation of set_void, get_void and get_property_declarations

The overloaded implementation is used by the default implementations of set_void, get_void and get_property_declarations with corresponding reflection handlers. The default implementation of self_reflect is empty.

Reimplemented in cgv::render::render_config, and cgv::render::shader_config.

◆ set()

template<typename T >

void cgv::base::base::set	(	const std::string &	property,
		const T &	value
	)

inline

set a property of the element to the given value and perform standard conversions if necessary.

This templated version simply extracts the type of the value from the reference and calls the set_void() method. Note that this only works if the template cgv::type::info::type_name<T> is overloaded for the value type.

◆ set_void()

bool cgv::base::base::set_void	(	const std::string &	property,
		const std::string &	value_type,
		const void *	value_ptr
	)

virtual

abstract interface for the setter of a dynamic property.

abstract interface for the setter, by default it simply returns false

The default implementation uses the self_reflect() method to find a member with the given property as name. If not found, the set_void method returns false.

Reimplemented in cgv::base::factory, cgv::base::base_generator, cgv::base::console, cgv::media::image::image_reader, cgv::media::image::image_writer, cgv::media::video::video_reader, and cgv::media::video::video_writer.

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

D:/develop/projects/git/cgv/cgv/base/base.h
D:/develop/projects/git/cgv/cgv/base/base.cxx

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Friends

property interface

Detailed Description

Member Function Documentation

◆ call_void()

◆ find_member_ptr()

◆ get()

◆ get_property_declarations()

◆ get_type_name()

◆ get_user_data()

◆ get_void()

◆ is_property()

◆ multi_set()

◆ on_register()

◆ self_reflect()

◆ set()

◆ set_void()