The common part of groups and parameters. More...

#include <uuc3d.hpp>

Inheritance diagram for UuIcsC3d::GroupParamCommon:

Public Member Functions
	GroupParamCommon ()
	Default constructor. Data needs to be filled in later.
	GroupParamCommon (bool locked, int id, std::string const &name, std::string const &description)
int	id () const
	Get the numeric identifier.
void	set_id (int id)
	Set the numeric identifier.
bool	is_locked () const
void	set_locked (bool value)
std::string	name () const
	Get the name of a group or parameter.
void	set_name (std::string name)
	Set the name of a group or parameter.
std::string	description () const
	Get the description of a group or parameter.
void	set_description (std::string const &description)
	Set the description of a group or parameter.
Protected Attributes
bool	m_locked
	locked value
int	m_id
	Group or parameter id.
std::string	m_name
	name value
std::string	m_description
	description value

Detailed Description

The common part of groups and parameters.

Constructor & Destructor Documentation

UuIcsC3d::GroupParamCommon::GroupParamCommon	(	bool	locked,
		int	id,
		std::string const &	name,
		std::string const &	description
	)		`[inline]`

Constructor.

Parameters:

locked	Whether this element is locked (only used when writing
id	A non negative integer identifier. a C3d file).
name	The name of the element.
description	A description of the parameter.

bool UuIcsC3d::GroupParamCommon::is_locked ( ) const [inline]

Whether this value is locked. This library doesn't restrict access to locked values. It is up to the library deal with locked parameters.

void UuIcsC3d::GroupParamCommon::set_locked ( bool value ) [inline]

Make this value locked. This only influences how a C3d file is written.

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