All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::DataType Class Reference

#include <DataType.h>

+ Inheritance diagram for Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::DataType:

Public Member Functions

 DataType ()
 DataType (PlainOldDataType iPod, uint8_t iExtent=1)
PlainOldDataType getPod () const
void setPod (PlainOldDataType iPod)
uint8_t getExtent () const
void setExtent (uint8_t iExtent)
size_t getNumBytes () const
bool operator== (const DataType &b) const
bool operator< (const DataType &b) const

Detailed Description

The DataType class is a description of how an element of a sample in a Scalar or an Array property is stored. It does not contain an interpretation this is left to the metadata of the properties themselves.

Definition at line 50 of file DataType.h.

Constructor & Destructor Documentation

Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::DataType::DataType ( )

Default constructor Sets the DataType to an unknown DataType with extent 0. This is obviously an invalid storage description, and is used in cases where we need to indicated that a DataType could not be determined.

Definition at line 59 of file DataType.h.

Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::DataType::DataType ( PlainOldDataType  iPod,
uint8_t  iExtent = 1 

Explicit constructor. Takes a pod and an extent. By default the extent is 1. For String and Wstring types, the extent must be 1.

Definition at line 66 of file DataType.h.

Member Function Documentation

uint8_t Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::DataType::getExtent ( ) const

Return the 8-bit extent ...

Definition at line 82 of file DataType.h.

size_t Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::DataType::getNumBytes ( ) const

Returns the number of bytes occupied by a single datum. (element) The assumption that each element has a fixed size in memory is a core assumption in Alembic.

String DataTypes are a troublesome problem. A single string datum does not have a fixed number of bytes associated with it. So we are returning, here, the size of the std::string and std::wstring datatypes, respectively.

Definition at line 96 of file DataType.h.

PlainOldDataType Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::DataType::getPod ( ) const

Default copy constructor used. Default assignment operator used. Return the PlainOldDataType enum ...

Definition at line 74 of file DataType.h.

bool Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::DataType::operator< ( const DataType b) const

Returns whether one datatype is lexigraphically "less" than another - this has meaning only so that DataType instances can be meaningfully sorted.

Definition at line 113 of file DataType.h.

bool Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::DataType::operator== ( const DataType b) const

Equality operator ...

Definition at line 103 of file DataType.h.

void Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::DataType::setExtent ( uint8_t  iExtent)

Set the 8-bit extent ...

Definition at line 86 of file DataType.h.

void Alembic::AbcCoreAbstract::ALEMBIC_VERSION_NS::DataType::setPod ( PlainOldDataType  iPod)

Set the PlainOldDataType ...

Definition at line 78 of file DataType.h.

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