HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
IMG_SaveRastersToFilesParms Class Reference

Parameters for the saveRaster[s]AsFile[s]() methods of IMG_File. More...

#include <IMG_SaveRastersToFilesParms.h>

Public Member Functions

 IMG_SaveRastersToFilesParms (const UT_StringHolder &format=UT_StringHolder(), UT_StringArray *created_files=nullptr, const IMG_FileParms *fparms=nullptr, const UT_StringHolder &linear_planes=UT_StringHolder(), const UT_StringHolder &separator="_", const UT_StringMap< UT_StringHolder > &planeToVarMap=UT_StringMap< UT_StringHolder >())
 
 IMG_SaveRastersToFilesParms (const IMG_FileParms *fparms, const IMG_Format *format)
 
 IMG_SaveRastersToFilesParms (const IMG_SaveRastersToFilesParms &src, const IMG_Format *override_format, const IMG_FileParms *override_parms)
 
void init (const UT_StringHolder &format_name, UT_StringArray *created_files, const IMG_FileParms *fparms, const UT_StringHolder &linear_planes, const UT_StringHolder &separator, const UT_StringMap< UT_StringHolder > &planeToVarMap)
 
const IMG_Formatformat () const
 
const UT_StringHolderformatName () const
 
const IMG_FileParmsfileParms () const
 
UT_StringArraycreatedFiles () const
 
const UT_StringHolderlinearPlanes () const
 
const UT_StringHolderseparator () const
 
const UT_StringMap
< UT_StringHolder > & 
planeToVar () const
 
void setFormat (const IMG_Format *format)
 
void setFileParms (const IMG_FileParms *p)
 

Detailed Description

Parameters for the saveRaster[s]AsFile[s]() methods of IMG_File.

Definition at line 24 of file IMG_SaveRastersToFilesParms.h.

Constructor & Destructor Documentation

IMG_SaveRastersToFilesParms::IMG_SaveRastersToFilesParms ( const UT_StringHolder format = UT_StringHolder(),
UT_StringArray created_files = nullptr,
const IMG_FileParms fparms = nullptr,
const UT_StringHolder linear_planes = UT_StringHolder(),
const UT_StringHolder separator = "_",
const UT_StringMap< UT_StringHolder > &  planeToVarMap = UT_StringMap<UT_StringHolder>() 
)
inline

Definition at line 27 of file IMG_SaveRastersToFilesParms.h.

IMG_SaveRastersToFilesParms::IMG_SaveRastersToFilesParms ( const IMG_FileParms fparms,
const IMG_Format format 
)
inline

Definition at line 39 of file IMG_SaveRastersToFilesParms.h.

IMG_SaveRastersToFilesParms::IMG_SaveRastersToFilesParms ( const IMG_SaveRastersToFilesParms src,
const IMG_Format override_format,
const IMG_FileParms override_parms 
)
inline

Definition at line 47 of file IMG_SaveRastersToFilesParms.h.

Member Function Documentation

UT_StringArray* IMG_SaveRastersToFilesParms::createdFiles ( ) const
inline

Definition at line 68 of file IMG_SaveRastersToFilesParms.h.

const IMG_FileParms* IMG_SaveRastersToFilesParms::fileParms ( ) const
inline

Definition at line 67 of file IMG_SaveRastersToFilesParms.h.

const IMG_Format* IMG_SaveRastersToFilesParms::format ( ) const
inline

Definition at line 65 of file IMG_SaveRastersToFilesParms.h.

const UT_StringHolder& IMG_SaveRastersToFilesParms::formatName ( ) const
inline

Definition at line 66 of file IMG_SaveRastersToFilesParms.h.

void IMG_SaveRastersToFilesParms::init ( const UT_StringHolder format_name,
UT_StringArray created_files,
const IMG_FileParms fparms,
const UT_StringHolder linear_planes,
const UT_StringHolder separator,
const UT_StringMap< UT_StringHolder > &  planeToVarMap 
)
const UT_StringHolder& IMG_SaveRastersToFilesParms::linearPlanes ( ) const
inline

Definition at line 69 of file IMG_SaveRastersToFilesParms.h.

const UT_StringMap<UT_StringHolder>& IMG_SaveRastersToFilesParms::planeToVar ( ) const
inline

Definition at line 71 of file IMG_SaveRastersToFilesParms.h.

const UT_StringHolder& IMG_SaveRastersToFilesParms::separator ( ) const
inline

Definition at line 70 of file IMG_SaveRastersToFilesParms.h.

void IMG_SaveRastersToFilesParms::setFileParms ( const IMG_FileParms p)
inline

Definition at line 74 of file IMG_SaveRastersToFilesParms.h.

void IMG_SaveRastersToFilesParms::setFormat ( const IMG_Format format)
inline

Definition at line 73 of file IMG_SaveRastersToFilesParms.h.


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