cartodata  5.0.5
carto::VolumeProxy< T > Class Template Reference

VolumeProxy is the base class for volumes. More...

#include <cartodata/volume/volumeproxy.h>

Inheritance diagram for carto::VolumeProxy< T >:
Collaboration diagram for carto::VolumeProxy< T >:

Public Member Functions

 VolumeProxy (int sizeX=1, int sizeY=1, int sizeZ=1, int sizeT=1)
 
 VolumeProxy (const std::vector< int > &size)
 
 VolumeProxy (const VolumeProxy< T > &other)
 
virtual ~VolumeProxy ()
 
int getSizeX () const
 
int getSizeY () const
 
int getSizeZ () const
 
int getSizeT () const
 
std::vector< int > getSize () const
 get the 4 dimensions in a vector More...
 
std::vector< float > getVoxelSize () const
 get the voxel size from the header, with 4 values defaulting to 1.mm if not present More...
 
VolumeProxy< T > & operator= (const VolumeProxy< T > &other)
 
virtual void copyHeaderFrom (const PropertySet &other)
 copy properties from other to this, avoiding forbidden properties like size. More...
 
virtual void copyHeaderFrom (const Object &other)
 
- Public Member Functions inherited from carto::Headered
 Headered ()
 
 Headered (const Headered &other)
 
virtual ~Headered ()
 
Headeredoperator= (const Headered &other)
 
const PropertySetheader () const
 
PropertySetheader ()
 
void addPropertyFilter (const rc_ptr< PropertyFilter > &propertyFilter)
 
bool hasPropertyFilter (const std::string &propertyFilterName) const
 
bool connect (const std::string &propertyFilterName, const PropertyFilter::Slot &slot)
 
bool disconnect (const std::string &propertyFilterName, const PropertyFilter::Slot &slot)
 
std::set< rc_ptr< PropertyFilter > > getPropertyFilters (const std::string &propertyName) const
 
void delay ()
 
void flush ()
 
void blockSignals (bool)
 
bool signalsBlocked () const
 
virtual void initialize ()
 
std::string uuid ()
 
bool copyUuid (const PropertySet &)
 
bool copyUuid (const Headered &)
 
- Public Member Functions inherited from carto::RCObject
 RCObject ()
 
 RCObject (const RCObject &)
 
RCObjectoperator= (const RCObject &)
 
virtual ~RCObject ()
 
- Public Member Functions inherited from carto::Observer
virtual ~Observer ()
 

Protected Attributes

std::vector< int > _size
 

Additional Inherited Members

- Public Types inherited from carto::RCObject
typedef int RefCounterType
 
- Protected Member Functions inherited from carto::Observer
 Observer ()
 

Detailed Description

template<typename T>
class carto::VolumeProxy< T >

VolumeProxy is the base class for volumes.

It handles the management of the volume size, but not its contents (it has no data block).

Definition at line 49 of file volumeproxy.h.

Constructor & Destructor Documentation

◆ VolumeProxy() [1/3]

template<typename T >
carto::VolumeProxy< T >::VolumeProxy ( int  sizeX = 1,
int  sizeY = 1,
int  sizeZ = 1,
int  sizeT = 1 
)
explicit

◆ VolumeProxy() [2/3]

template<typename T >
carto::VolumeProxy< T >::VolumeProxy ( const std::vector< int > &  size)
explicit

◆ VolumeProxy() [3/3]

◆ ~VolumeProxy()

template<typename T >
carto::VolumeProxy< T >::~VolumeProxy ( )
virtual

Definition at line 110 of file volumeproxy_d.h.

Member Function Documentation

◆ copyHeaderFrom() [1/2]

template<typename T >
void carto::VolumeProxy< T >::copyHeaderFrom ( const PropertySet other)
inlinevirtual

copy properties from other to this, avoiding forbidden properties like size.

Definition at line 137 of file volumeproxy.h.

References carto::Object::reference().

Referenced by carto::copy(), carto::copyStructure(), and carto::deepcopy().

◆ copyHeaderFrom() [2/2]

template<typename T >
void carto::VolumeProxy< T >::copyHeaderFrom ( const Object other)
virtual

◆ getSize()

template<typename T >
std::vector< int > carto::VolumeProxy< T >::getSize ( ) const
inline

◆ getSizeT()

◆ getSizeX()

◆ getSizeY()

◆ getSizeZ()

◆ getVoxelSize()

template<typename T >
std::vector< float > carto::VolumeProxy< T >::getVoxelSize ( ) const

get the voxel size from the header, with 4 values defaulting to 1.mm if not present

Definition at line 141 of file volumeproxy_d.h.

References carto::VolumeProxy< T >::_size, carto::PropertySet::getProperty(), and carto::Headered::header().

◆ operator=()

Member Data Documentation

◆ _size


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