UuIcsC3d::Group Struct Reference

#include <uuc3d.hpp>

Inheritance diagram for UuIcsC3d::Group:

List of all members.

Public Member Functions
	Group ()
	Group (int id)
	Group (bool locked, int id, std::string name, std::string const &description)
void	add_parameter (Parameter const &param)
bool	has_parameter (std::string const &name) const
Parameter const &	get_parameter (std::string const &name) const
Parameter &	get_parameter (std::string const &name)
Parameter const *	get_parameter_checked (std::string const &name) const
Parameter *	get_parameter_checked (std::string const &name)
std::vector< Parameter > const &	the_parameters () const
int	total_representation_size () const
int	group_representation_size () const

---

Detailed Description

A group of C3d parameters. Every parameter in a C3d file belongs to a group.

---

Constructor & Destructor Documentation

UuIcsC3d::Group::Group

(

)

[inline]

Construct a group without data. At least the id and name of the group should be set later.

UuIcsC3d::Group::Group

(

int

id

)

[inline]

Construct a group with only its id. At least the name of the group should be set later.

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

Construct a group with all of its attributes.

---

Member Function Documentation

void UuIcsC3d::Group::add_parameter

(

Parameter const &

param

)

Add a aparmeter to this group.

Parameter& UuIcsC3d::Group::get_parameter

(

std::string const &

name

)

Retrieves a parameter of this group by name.

Parameters:

[in]

name

The name of the parameter.

Returns:

The parameter with this name.

Precondition:

A parameter with this name exists.

Parameter const& UuIcsC3d::Group::get_parameter

(

std::string const &

name

)

const

Retrieves a parameter of this group by name.

Parameters:

[in]

name

The name of the parameter.

Returns:

The parameter with this name.

Precondition:

A parameter with this name exists.

Parameter const* UuIcsC3d::Group::get_parameter_checked

(

std::string const &

name

)

const

Retrieves a parameter of this group by name.

Parameters:

[in]

name

The name of the parameter.

Returns:

Pointer to the parameter with this name. Null pointer if this parameter does not exist.

Parameter* UuIcsC3d::Group::get_parameter_checked

(

std::string const &

name

)

Retrieves a parameter of this group by name.

Parameters:

[in]

name

The name of the parameter.

Returns:

Pointer to the parameter with this name. Null pointer if this parameter does not exist.

int UuIcsC3d::Group::group_representation_size

(

)

const

The size (in bytes) that this group will take in a C3d file, not including the parameters belonging to this group.

bool UuIcsC3d::Group::has_parameter

(

std::string const &

name

)

const

Whether this group has a parameter with this name.

std::vector<Parameter> const& UuIcsC3d::Group::the_parameters

(

)

const [inline]

Get all parameters in this group.

int UuIcsC3d::Group::total_representation_size

(

)

const

The size (in bytes) that this group and all its parameters will take in a C3d file.

---

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

• uuc3dlib/uuc3d.hpp