ome-files  0.5.0
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
ome::files::tiff::Field< Tag > Class Template Reference

Field representing a tag value. More...

#include <ome/files/tiff/Field.h>

+ Inheritance diagram for ome::files::tiff::Field< Tag >:
+ Collaboration diagram for ome::files::tiff::Field< Tag >:

Public Types

typedef Tag tag_category
 The tag type (C++ enum type).
 
typedef ::ome::files::detail::tiff::TagProperties< tag_category >::value_type value_type
 The tag value type (C++ type).
 

Public Member Functions

virtual ~Field ()
 Destructor.
 
void get (value_type &value) const
 Get the value for this field. More...
 
void set (const value_type &value)
 Set the value for this field. More...
 
Fieldoperator= (const Field &field)
 Assign a field value. More...
 
 operator value_type ()
 Cast operator for getting the value of this field.
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
template<>
void get (value_type &value) const
 Get the value for this field. More...
 
template<>
void set (const value_type &value)
 Set the value for this field. More...
 
- Public Member Functions inherited from ome::files::tiff::FieldBase
virtual ~FieldBase ()
 Destructor.
 
Type type () const
 Get field data type. More...
 
bool passCount () const
 Get field count requirement. More...
 
int readCount () const
 Get field read count requirement. More...
 
int writeCount () const
 Get field write count requirement. More...
 
tag_type tagNumber () const
 Get field tag number. More...
 
std::string name () const
 Get field tag name. More...
 
std::shared_ptr< IFDgetIFD () const
 Get the directory this field belongs to. More...
 

Protected Member Functions

 Field (std::shared_ptr< IFD > ifd, tag_category tag)
 Constructor. More...
 
- Protected Member Functions inherited from ome::files::tiff::FieldBase
 FieldBase (std::shared_ptr< IFD > ifd, tag_type tag)
 Constructor. More...
 

Protected Attributes

tag_category tag
 The tag identifying this field.
 
- Protected Attributes inherited from ome::files::tiff::FieldBase
std::shared_ptr< Implimpl
 Private implementation details.
 

Friends

class IFD
 Field uses internal IFD state.
 

Detailed Description

template<typename Tag>
class ome::files::tiff::Field< Tag >

Field representing a tag value.

Forward declaration of Field<Tag>.

Constructor & Destructor Documentation

◆ Field()

template<typename Tag>
ome::files::tiff::Field< Tag >::Field ( std::shared_ptr< IFD ifd,
tag_category  tag 
)
inlineprotected

Constructor.

Parameters
ifdthe directory the field belongs to.
tagthe tag identifying this field.

Member Function Documentation

◆ get() [1/26]

template<typename Tag>
void ome::files::tiff::Field< Tag >::get ( value_type value) const

Get the value for this field.

Parameters
valuethe variable in which the field value will be stored.

Referenced by ome::files::tiff::ValueProxy< V >::operator=(), and ome::files::tiff::Value< V >::operator=().

+ Here is the caller graph for this function:

◆ get() [2/26]

template<>
void ome::files::tiff::Field< StringTag1 >::get ( value_type value) const

◆ get() [3/26]

template<>
void ome::files::tiff::Field< StringTagArray1 >::get ( value_type value) const

Get the value for this field.

Parameters
valuethe variable in which the field value will be stored.

References ome::files::tiff::FieldBase::getIFD(), ome::files::tiff::FieldBase::impl, ome::files::tiff::FieldBase::passCount(), ome::files::tiff::FieldBase::type(), and ome::files::tiff::TYPE_ASCII.

◆ get() [4/26]

template<>
void ome::files::tiff::Field< UInt16Tag1 >::get ( value_type value) const

◆ get() [5/26]

template<>
void ome::files::tiff::Field< UInt16TagArray1 >::get ( value_type value) const

Get the value for this field.

Parameters
valuethe variable in which the field value will be stored.

References ome::files::tiff::FieldBase::getIFD(), ome::files::tiff::FieldBase::impl, ome::files::tiff::FieldBase::readCount(), ome::files::tiff::FieldBase::type(), and ome::files::tiff::TYPE_SHORT.

◆ get() [6/26]

template<>
void ome::files::tiff::Field< UInt16Orientation1 >::get ( value_type value) const

Get the value for this field.

Parameters
valuethe variable in which the field value will be stored.

References ome::files::tiff::FieldBase::getIFD(), ome::files::tiff::FieldBase::impl, ome::files::tiff::FieldBase::passCount(), ome::files::tiff::FieldBase::readCount(), and ome::files::tiff::FieldBase::type().

◆ get() [7/26]

template<>
void ome::files::tiff::Field< UInt16PhotometricInterpretation1 >::get ( value_type value) const

Get the value for this field.

Parameters
valuethe variable in which the field value will be stored.

References ome::files::tiff::FieldBase::getIFD(), ome::files::tiff::FieldBase::impl, ome::files::tiff::FieldBase::passCount(), ome::files::tiff::FieldBase::readCount(), and ome::files::tiff::FieldBase::type().

◆ get() [8/26]

template<>
void ome::files::tiff::Field< UInt16PlanarConfiguration1 >::get ( value_type value) const

Get the value for this field.

Parameters
valuethe variable in which the field value will be stored.

References ome::files::tiff::FieldBase::getIFD(), ome::files::tiff::FieldBase::impl, ome::files::tiff::FieldBase::passCount(), ome::files::tiff::FieldBase::readCount(), and ome::files::tiff::FieldBase::type().

◆ get() [9/26]

template<>
void ome::files::tiff::Field< UInt16Predictor1 >::get ( value_type value) const

Get the value for this field.

Parameters
valuethe variable in which the field value will be stored.

References ome::files::tiff::FieldBase::getIFD(), ome::files::tiff::FieldBase::impl, ome::files::tiff::FieldBase::passCount(), ome::files::tiff::FieldBase::readCount(), and ome::files::tiff::FieldBase::type().

◆ get() [10/26]

template<>
void ome::files::tiff::Field< UInt16Compression1 >::get ( value_type value) const

Get the value for this field.

Parameters
valuethe variable in which the field value will be stored.

References ome::files::tiff::FieldBase::getIFD(), ome::files::tiff::FieldBase::impl, ome::files::tiff::FieldBase::passCount(), ome::files::tiff::FieldBase::readCount(), and ome::files::tiff::FieldBase::type().

◆ get() [11/26]

template<>
void ome::files::tiff::Field< UInt16FillOrder1 >::get ( value_type value) const

Get the value for this field.

Parameters
valuethe variable in which the field value will be stored.

References ome::files::tiff::FieldBase::getIFD(), ome::files::tiff::FieldBase::impl, ome::files::tiff::FieldBase::passCount(), ome::files::tiff::FieldBase::readCount(), and ome::files::tiff::FieldBase::type().

◆ get() [12/26]

template<>
void ome::files::tiff::Field< UInt16SampleFormat1 >::get ( value_type value) const

Get the value for this field.

Parameters
valuethe variable in which the field value will be stored.

References ome::files::tiff::FieldBase::getIFD(), ome::files::tiff::FieldBase::impl, ome::files::tiff::FieldBase::passCount(), ome::files::tiff::FieldBase::readCount(), and ome::files::tiff::FieldBase::type().

◆ get() [13/26]

template<>
void ome::files::tiff::Field< UInt16Threshholding1 >::get ( value_type value) const

Get the value for this field.

Parameters
valuethe variable in which the field value will be stored.

References ome::files::tiff::FieldBase::getIFD(), ome::files::tiff::FieldBase::impl, ome::files::tiff::FieldBase::passCount(), ome::files::tiff::FieldBase::readCount(), and ome::files::tiff::FieldBase::type().

◆ get() [14/26]

template<>
void ome::files::tiff::Field< UInt16YCbCrPosition1 >::get ( value_type value) const

Get the value for this field.

Parameters
valuethe variable in which the field value will be stored.

References ome::files::tiff::FieldBase::getIFD(), ome::files::tiff::FieldBase::impl, ome::files::tiff::FieldBase::passCount(), ome::files::tiff::FieldBase::readCount(), and ome::files::tiff::FieldBase::type().

◆ get() [15/26]

template<>
void ome::files::tiff::Field< UInt16Tag2 >::get ( value_type value) const

◆ get() [16/26]

template<>
void ome::files::tiff::Field< UInt16Tag6 >::get ( value_type value) const

◆ get() [17/26]

template<>
void ome::files::tiff::Field< UInt32Tag1 >::get ( value_type value) const

◆ get() [18/26]

template<>
void ome::files::tiff::Field< FloatTag1 >::get ( value_type value) const

◆ get() [19/26]

template<>
void ome::files::tiff::Field< FloatTag2 >::get ( value_type value) const

◆ get() [20/26]

template<>
void ome::files::tiff::Field< FloatTag3 >::get ( value_type value) const

◆ get() [21/26]

template<>
void ome::files::tiff::Field< FloatTag6 >::get ( value_type value) const

◆ get() [22/26]

template<>
void ome::files::tiff::Field< UInt16ExtraSamplesArray1 >::get ( value_type value) const

Get the value for this field.

Parameters
valuethe variable in which the field value will be stored.

References ome::files::tiff::FieldBase::getIFD(), ome::files::tiff::FieldBase::impl, ome::files::tiff::FieldBase::readCount(), ome::files::tiff::FieldBase::type(), and ome::files::tiff::TYPE_SHORT.

◆ get() [23/26]

template<>
void ome::files::tiff::Field< UInt16TagArray3 >::get ( value_type value) const

Get the value for this field.

Parameters
valuethe variable in which the field value will be stored.

References ome::files::tiff::FieldBase::getIFD(), ome::files::tiff::FieldBase::impl, ome::files::tiff::FieldBase::readCount(), ome::files::tiff::FieldBase::type(), and ome::files::tiff::TYPE_SHORT.

◆ get() [24/26]

template<>
void ome::files::tiff::Field< UInt32TagArray1 >::get ( value_type value) const

Get the value for this field.

Parameters
valuethe variable in which the field value will be stored.

References ome::files::tiff::FieldBase::getIFD(), ome::files::tiff::FieldBase::impl, ome::files::tiff::FieldBase::readCount(), ome::files::tiff::FieldBase::type(), and ome::files::tiff::TYPE_LONG.

◆ get() [25/26]

template<>
void ome::files::tiff::Field< UInt64TagArray1 >::get ( value_type value) const

◆ get() [26/26]

template<>
void ome::files::tiff::Field< RawDataTag1 >::get ( value_type value) const

◆ operator=()

template<typename Tag>
Field& ome::files::tiff::Field< Tag >::operator= ( const Field< Tag > &  field)
inline

Assign a field value.

Parameters
fieldthe field to assign from.
Returns
the Field.

◆ set() [1/26]

template<typename Tag>
void ome::files::tiff::Field< Tag >::set ( const value_type value)

Set the value for this field.

Parameters
valuethe value to set.

◆ set() [2/26]

template<>
void ome::files::tiff::Field< StringTag1 >::set ( const value_type value)

◆ set() [3/26]

template<>
void ome::files::tiff::Field< StringTagArray1 >::set ( const value_type value)

◆ set() [4/26]

template<>
void ome::files::tiff::Field< UInt16TagArray1 >::set ( const value_type value)

◆ set() [5/26]

template<>
void ome::files::tiff::Field< UInt16Tag1 >::set ( const value_type value)

◆ set() [6/26]

template<>
void ome::files::tiff::Field< UInt16Orientation1 >::set ( const value_type value)

◆ set() [7/26]

template<>
void ome::files::tiff::Field< UInt16PhotometricInterpretation1 >::set ( const value_type value)

◆ set() [8/26]

template<>
void ome::files::tiff::Field< UInt16PlanarConfiguration1 >::set ( const value_type value)

◆ set() [9/26]

template<>
void ome::files::tiff::Field< UInt16Predictor1 >::set ( const value_type value)

◆ set() [10/26]

template<>
void ome::files::tiff::Field< UInt16Compression1 >::set ( const value_type value)

◆ set() [11/26]

template<>
void ome::files::tiff::Field< UInt16FillOrder1 >::set ( const value_type value)

◆ set() [12/26]

template<>
void ome::files::tiff::Field< UInt16SampleFormat1 >::set ( const value_type value)

◆ set() [13/26]

template<>
void ome::files::tiff::Field< UInt16Threshholding1 >::set ( const value_type value)

◆ set() [14/26]

template<>
void ome::files::tiff::Field< UInt16YCbCrPosition1 >::set ( const value_type value)

◆ set() [15/26]

template<>
void ome::files::tiff::Field< UInt16Tag2 >::set ( const value_type value)

◆ set() [16/26]

template<>
void ome::files::tiff::Field< UInt16Tag6 >::set ( const value_type value)

◆ set() [17/26]

template<>
void ome::files::tiff::Field< UInt32Tag1 >::set ( const value_type value)

◆ set() [18/26]

template<>
void ome::files::tiff::Field< FloatTag1 >::set ( const value_type value)

◆ set() [19/26]

template<>
void ome::files::tiff::Field< FloatTag2 >::set ( const value_type value)

◆ set() [20/26]

template<>
void ome::files::tiff::Field< FloatTag3 >::set ( const value_type value)

◆ set() [21/26]

template<>
void ome::files::tiff::Field< FloatTag6 >::set ( const value_type value)

◆ set() [22/26]

template<>
void ome::files::tiff::Field< UInt16ExtraSamplesArray1 >::set ( const value_type value)

◆ set() [23/26]

template<>
void ome::files::tiff::Field< UInt16TagArray3 >::set ( const value_type value)

◆ set() [24/26]

template<>
void ome::files::tiff::Field< UInt32TagArray1 >::set ( const value_type value)

◆ set() [25/26]

template<>
void ome::files::tiff::Field< UInt64TagArray1 >::set ( const value_type value)

◆ set() [26/26]

template<>
void ome::files::tiff::Field< RawDataTag1 >::set ( const value_type value)

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