UuIcsC3d::Content Class Reference

Stores the header and parameter data of a C3d file. More...

#include <uuc3d.hpp>

List of all members.

Public Member Functions
void	open (std::string const &filename)
Header const &	header () const
Header &	header ()
boost::shared_ptr< BasicIO >	io () const
bool	has_group (std::string const &name) const
Group const &	get_group (std::string const &name) const
Group &	get_group (std::string const &name)
Group const *	get_group_checked (std::string const &name) const
Group *	get_group_checked (std::string const &name)
std::vector< Group > const &	the_groups () const
std::string	filename () const

---

Detailed Description

Stores the header and parameter data of a C3d file.

---

Member Function Documentation

std::string UuIcsC3d::Content::filename

(

)

const [inline]

The name of the file as supplied to the last call to open.

Group const& UuIcsC3d::Content::get_group

(

std::string const &

name

)

const

Retrieves a group by name.

Parameters:

[in]

name

The name of the group.

Returns:

The group with this name.

Precondition:

has_group(name).

Group& UuIcsC3d::Content::get_group

(

std::string const &

name

)

Retrieves a group by name.

Parameters:

[in]

name

The name of the group.

Returns:

The group with this name.

Precondition:

has_group(name).

Group* UuIcsC3d::Content::get_group_checked

(

std::string const &

name

)

Retrieves a group by name.

Parameters:

[in]

name

The name of the group.

Returns:

A pointer to the group with this name if this group exists, else a null pointer.

Group const* UuIcsC3d::Content::get_group_checked

(

std::string const &

name

)

const

Retrieves a group by name.

Parameters:

[in]

name

The name of the group.

Returns:

A pointer to the group with this name if this group exists, else a null pointer.

bool UuIcsC3d::Content::has_group

(

std::string const &

name

)

const

Checks whether a group with this name exists.

Header const& UuIcsC3d::Content::header

(

)

const [inline]

Get the header (first block) of the C3d file.

Header& UuIcsC3d::Content::header

(

)

[inline]

Get the header (first block) of the C3d file.

boost::shared_ptr<BasicIO> UuIcsC3d::Content::io

(

)

const [inline]

Get the encoder/decoder for this C3d file.

void UuIcsC3d::Content::open

(

std::string const &

filename

)

Opens a C3d file and reads the header and parameter section.

Parameters:

[in]

filename

Name of the file. This name will be stored.

Exceptions:

UuIcsC3d::OpenError	if file cannot be opened.
UuIcsC3d::ContentError	if file contains erroneous content.

std::vector<Group> const& UuIcsC3d::Content::the_groups

(

)

const [inline]

Returns:

Get all groups.

---

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

• uuc3dlib/uuc3d.hpp