Foundry::Katana::DataAttribute Class Reference

The base class of attributes containing data, possibly at multiple samples in time. More...

#include <FnAttribute.h>

Inheritance diagram for Foundry::Katana::DataAttribute:

List of all members.

Public Member Functions
	DataAttribute ()
int64_t	getTupleSize () const
int64_t	getNumberOfValues () const
int64_t	getNumberOfTuples () const
int64_t	getNumberOfTimeSamples () const
float	getSampleTime (int64_t index) const
bool	getBoundingSampleTimes (float *ltime, float *rtime, float sampletime) const

---

Detailed Description

The base class of attributes containing data, possibly at multiple samples in time.

The data are organised in tuples of a fixed size of 1 or greater per attribute. DataAttribute implements common, data-agnostic functionality, such as querying them number and orientation of values and time samples.

DataAttributes enforce some limits on the amount of data they can store. These are as follows:

value count (per sample): [0, 2^63) time count: [0, 2^13) tuple size: [0, 2^16)

An invalid attribute will be returned should you attempt to create an attribute with values outside of these limits.

---

Constructor & Destructor Documentation

Foundry::Katana::DataAttribute::DataAttribute

(

)

[inline]

Create empty attribute class (isValid() == false).

---

Member Function Documentation

bool Foundry::Katana::DataAttribute::getBoundingSampleTimes	(	float *	ltime,
		float *	rtime,
		float	sampletime
	)		const [inline]

For the specified sampletime, return the two bounding samples. (left bounds, right bounds). If the sampletime exactly falls on a single sample, ltime == rtime (this is also the case at extrema, or for attrs with only a single sample. For attrs with 0 samples, the return value is false (signifying failure) For attrs >0 samples, return value is true

int64_t Foundry::Katana::DataAttribute::getNumberOfTimeSamples

(

)

const [inline]

Return the number of time samples at which data is recorded in this attribute.

int64_t Foundry::Katana::DataAttribute::getNumberOfTuples

(

)

const [inline]

Return the number of tuples in this attribute.

int64_t Foundry::Katana::DataAttribute::getNumberOfValues

(

)

const [inline]

Return the total number of data values for this attribute. This will be equal to getNumberOfTuples() * getTupleSize()

float Foundry::Katana::DataAttribute::getSampleTime

(

int64_t

index

)

const [inline]

Returns a float value containing the time at a particular index for this attribute. If the index is not valid 0.0 is returned.

int64_t Foundry::Katana::DataAttribute::getTupleSize

(

)

const [inline]

Return the number of data values per tuple for this attribute.

---

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

• FnAttribute.h