VTK  9.4.20250201
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkXArrayAccessor Class Reference

#include <vtkXArrayAccessor.h>

Inheritance diagram for vtkXArrayAccessor:
[legend]
Collaboration diagram for vtkXArrayAccessor:
[legend]

Public Types

typedef vtkNetCDFAccessor Superclass
 
- Public Types inherited from vtkNetCDFAccessor
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkXArrayAccessorNewInstance () const
 
int close (int ncid) override
 
int open (const char *path, int omode, int *ncidp) override
 
const char * strerror (int ncerr1) override
 
int inq_attlen (int ncid, int varid, const char *name, size_t *lenp) override
 
int inq_dimlen (int ncid, int dimid, size_t *lenp) override
 
int inq_dimname (int ncid, int dimid, char *name) override
 
int inq_nvars (int ncid, int *nvarsp) override
 
int inq_ndims (int ncid, int *ndimsp) override
 
int inq_vardimid (int ncid, int varid, int *dimidsp) override
 
int inq_varid (int ncid, const char *name, int *varidp) override
 
int inq_varname (int ncid, int varid, char *name) override
 
int inq_varndims (int ncid, int varid, int *ndimsp) override
 
int inq_vartype (int ncid, int varid, int *typep) override
 
int get_att_text (int ncid, int varid, const char *name, char *value) override
 
int get_att_double (int ncid, int varid, const char *name, double *value) override
 
int get_att_float (int ncid, int varid, const char *name, float *value) override
 
bool GetCoordinates (int ncFD, int varId, std::vector< std::string > &coordName) override
 
bool NeedsFileName () override
 
int get_vars (int ncid, int varid, const size_t *startp, const size_t *countp, const ptrdiff_t *stridep, int vtkType, vtkIdType numberOfComponents, vtkIdType numberOfTuples, vtkDataArray *dataArray) override
 
int get_vars (int ncid, int varid, const size_t *startp, const size_t *countp, const ptrdiff_t *stridep, void *ip) override
 
int get_vars_double (int ncid, int varid, const size_t *startp, const size_t *countp, const ptrdiff_t *stridep, double *ip) override
 
int get_var_double (int ncid, int varid, double *ip) override
 
void SetVarDims (size_t varIndex, const std::vector< size_t > &dims)
 Set dimensions for a variable.
 
void SetVarCoords (size_t varIndex, const std::vector< size_t > &coords)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void SetDim (const std::vector< std::string > &v)
 Set dimensions and their length.
 
void SetDimLen (const std::vector< size_t > &v)
 Set dimensions and their length.
 
void SetVar (const std::vector< std::string > &v, const std::vector< int > &is_coord)
 Set variables, variable attributes and types for the variable arrays.
 
void SetVarValue (size_t varIndex, void *value)
 Set variables, variable attributes and types for the variable arrays.
 
void SetAtt (size_t varIndex, std::string attributeName, const vtkVariant &var)
 Set variables, variable attributes and types for the variable arrays.
 
void SetVarType (size_t varIndex, int nctype)
 Set variables, variable attributes and types for the variable arrays.
 
bool IsCOARDSCoordinate (std::string)
 Check if this coordinate has one dim with the same name as the coordinate.
 
- Public Member Functions inherited from vtkNetCDFAccessor
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkNetCDFAccessorNewInstance () const
 
virtual int close (int ncid)
 
virtual int open (const char *path, int omode, int *ncidp)
 
virtual const char * strerror (int ncerr1)
 
virtual int inq_attlen (int ncid, int varid, const char *name, size_t *lenp)
 
virtual int inq_dimlen (int ncid, int dimid, size_t *lenp)
 
virtual int inq_dimname (int ncid, int dimid, char *name)
 
virtual int inq_nvars (int ncid, int *nvarsp)
 
virtual int inq_ndims (int ncid, int *ndimsp)
 
virtual int inq_vardimid (int ncid, int varid, int *dimidsp)
 
virtual int inq_varid (int ncid, const char *name, int *varidp)
 
virtual int inq_varname (int ncid, int varid, char *name)
 
virtual int inq_varndims (int ncid, int varid, int *ndimsp)
 
virtual int inq_vartype (int ncid, int varid, int *typep)
 
virtual int get_att_text (int ncid, int varid, const char *name, char *value)
 
virtual int get_att_double (int ncid, int varid, const char *name, double *value)
 
virtual int get_att_float (int ncid, int varid, const char *name, float *value)
 
virtual int get_vars (int ncid, int varid, const size_t *startp, const size_t *countp, const ptrdiff_t *stridep, int vtkType, vtkIdType numberOfComponents, vtkIdType numberOfTuples, vtkDataArray *dataArray)
 
virtual int get_vars (int ncid, int varid, const size_t *startp, const size_t *countp, const ptrdiff_t *stridep, void *ip)
 
virtual int get_vars_double (int ncid, int varid, const size_t *startp, const size_t *countp, const ptrdiff_t *stridep, double *ip)
 
virtual int get_var_double (int ncid, int varid, double *ip)
 
virtual bool GetCoordinates (int ncFD, int varId, std::vector< std::string > &coordName)
 
virtual bool NeedsFileName ()
 
bool ReadTextAttribute (int ncFD, int varId, const char *name, std::string &result)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXArrayAccessorSafeDownCast (vtkObjectBase *o)
 
static vtkXArrayAccessorNew ()
 
- Static Public Member Functions inherited from vtkNetCDFAccessor
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkNetCDFAccessorSafeDownCast (vtkObjectBase *o)
 
static vtkNetCDFAccessorNew ()
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
void PrintVarValue (const char *name, int varid)
 
void PrintVarValue (const char *name, int varid, const size_t *startp, const size_t *countp)
 
bool IsContiguous (int varid, const size_t *startp, const size_t *countp)
 
void GetContiguousStartSize (int varid, const size_t *startp, const size_t *countp, char *&arrayStart, vtkIdType &arraySize)
 
void Copy (int varid, const size_t *startp, const size_t *countp, char *dst)
 
std::vector< size_t > GetDimIncrement (int varid)
 
bool DecrementAndUpdate (size_t varid, std::vector< size_t > &count, const size_t *startp, const size_t *count_p, const std::vector< size_t > &dimIncrement, char *&src)
 
 vtkXArrayAccessor ()=default
 
 ~vtkXArrayAccessor () override=default
 
- Protected Member Functions inherited from vtkNetCDFAccessor
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkNetCDFAccessor ()=default
 
 ~vtkNetCDFAccessor () override=default
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Definition at line 18 of file vtkXArrayAccessor.h.

Member Typedef Documentation

◆ Superclass

Definition at line 21 of file vtkXArrayAccessor.h.

Constructor & Destructor Documentation

◆ vtkXArrayAccessor()

vtkXArrayAccessor::vtkXArrayAccessor ( )
protecteddefault

◆ ~vtkXArrayAccessor()

vtkXArrayAccessor::~vtkXArrayAccessor ( )
overrideprotecteddefault

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkXArrayAccessor::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkXArrayAccessor::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkNetCDFAccessor.

◆ SafeDownCast()

static vtkXArrayAccessor * vtkXArrayAccessor::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkXArrayAccessor::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkNetCDFAccessor.

◆ NewInstance()

vtkXArrayAccessor * vtkXArrayAccessor::NewInstance ( ) const

◆ New()

static vtkXArrayAccessor * vtkXArrayAccessor::New ( )
static

◆ close()

int vtkXArrayAccessor::close ( int  ncid)
overridevirtual

Reimplemented from vtkNetCDFAccessor.

◆ open()

int vtkXArrayAccessor::open ( const char *  path,
int  omode,
int *  ncidp 
)
overridevirtual

Reimplemented from vtkNetCDFAccessor.

◆ strerror()

const char * vtkXArrayAccessor::strerror ( int  ncerr1)
overridevirtual

Reimplemented from vtkNetCDFAccessor.

◆ inq_attlen()

int vtkXArrayAccessor::inq_attlen ( int  ncid,
int  varid,
const char *  name,
size_t *  lenp 
)
overridevirtual

Reimplemented from vtkNetCDFAccessor.

◆ inq_dimlen()

int vtkXArrayAccessor::inq_dimlen ( int  ncid,
int  dimid,
size_t *  lenp 
)
overridevirtual

Reimplemented from vtkNetCDFAccessor.

◆ inq_dimname()

int vtkXArrayAccessor::inq_dimname ( int  ncid,
int  dimid,
char *  name 
)
overridevirtual

Reimplemented from vtkNetCDFAccessor.

◆ inq_nvars()

int vtkXArrayAccessor::inq_nvars ( int  ncid,
int *  nvarsp 
)
overridevirtual

Reimplemented from vtkNetCDFAccessor.

◆ inq_ndims()

int vtkXArrayAccessor::inq_ndims ( int  ncid,
int *  ndimsp 
)
overridevirtual

Reimplemented from vtkNetCDFAccessor.

◆ inq_vardimid()

int vtkXArrayAccessor::inq_vardimid ( int  ncid,
int  varid,
int *  dimidsp 
)
overridevirtual

Reimplemented from vtkNetCDFAccessor.

◆ inq_varid()

int vtkXArrayAccessor::inq_varid ( int  ncid,
const char *  name,
int *  varidp 
)
overridevirtual

Reimplemented from vtkNetCDFAccessor.

◆ inq_varname()

int vtkXArrayAccessor::inq_varname ( int  ncid,
int  varid,
char *  name 
)
overridevirtual

Reimplemented from vtkNetCDFAccessor.

◆ inq_varndims()

int vtkXArrayAccessor::inq_varndims ( int  ncid,
int  varid,
int *  ndimsp 
)
overridevirtual

Reimplemented from vtkNetCDFAccessor.

◆ inq_vartype()

int vtkXArrayAccessor::inq_vartype ( int  ncid,
int  varid,
int *  typep 
)
overridevirtual

Reimplemented from vtkNetCDFAccessor.

◆ get_att_text()

int vtkXArrayAccessor::get_att_text ( int  ncid,
int  varid,
const char *  name,
char *  value 
)
overridevirtual

Reimplemented from vtkNetCDFAccessor.

◆ get_att_double()

int vtkXArrayAccessor::get_att_double ( int  ncid,
int  varid,
const char *  name,
double *  value 
)
overridevirtual

Reimplemented from vtkNetCDFAccessor.

◆ get_att_float()

int vtkXArrayAccessor::get_att_float ( int  ncid,
int  varid,
const char *  name,
float *  value 
)
overridevirtual

Reimplemented from vtkNetCDFAccessor.

◆ GetCoordinates()

bool vtkXArrayAccessor::GetCoordinates ( int  ncFD,
int  varId,
std::vector< std::string > &  coordName 
)
overridevirtual

Reimplemented from vtkNetCDFAccessor.

◆ NeedsFileName()

bool vtkXArrayAccessor::NeedsFileName ( )
overridevirtual

Reimplemented from vtkNetCDFAccessor.

◆ get_vars() [1/2]

int vtkXArrayAccessor::get_vars ( int  ncid,
int  varid,
const size_t *  startp,
const size_t *  countp,
const ptrdiff_t *  stridep,
int  vtkType,
vtkIdType  numberOfComponents,
vtkIdType  numberOfTuples,
vtkDataArray dataArray 
)
overridevirtual

Reimplemented from vtkNetCDFAccessor.

◆ get_vars() [2/2]

int vtkXArrayAccessor::get_vars ( int  ncid,
int  varid,
const size_t *  startp,
const size_t *  countp,
const ptrdiff_t *  stridep,
void *  ip 
)
overridevirtual

Reimplemented from vtkNetCDFAccessor.

◆ get_vars_double()

int vtkXArrayAccessor::get_vars_double ( int  ncid,
int  varid,
const size_t *  startp,
const size_t *  countp,
const ptrdiff_t *  stridep,
double *  ip 
)
overridevirtual

Reimplemented from vtkNetCDFAccessor.

◆ get_var_double()

int vtkXArrayAccessor::get_var_double ( int  ncid,
int  varid,
double *  ip 
)
overridevirtual

Reimplemented from vtkNetCDFAccessor.

◆ SetDim()

void vtkXArrayAccessor::SetDim ( const std::vector< std::string > &  v)

Set dimensions and their length.

◆ SetDimLen()

void vtkXArrayAccessor::SetDimLen ( const std::vector< size_t > &  v)

Set dimensions and their length.

◆ SetVar()

void vtkXArrayAccessor::SetVar ( const std::vector< std::string > &  v,
const std::vector< int > &  is_coord 
)

Set variables, variable attributes and types for the variable arrays.

◆ SetVarValue()

void vtkXArrayAccessor::SetVarValue ( size_t  varIndex,
void *  value 
)

Set variables, variable attributes and types for the variable arrays.

◆ SetAtt()

void vtkXArrayAccessor::SetAtt ( size_t  varIndex,
std::string  attributeName,
const vtkVariant var 
)

Set variables, variable attributes and types for the variable arrays.

◆ SetVarType()

void vtkXArrayAccessor::SetVarType ( size_t  varIndex,
int  nctype 
)

Set variables, variable attributes and types for the variable arrays.

◆ IsCOARDSCoordinate()

bool vtkXArrayAccessor::IsCOARDSCoordinate ( std::string  )

Check if this coordinate has one dim with the same name as the coordinate.

◆ SetVarDims()

void vtkXArrayAccessor::SetVarDims ( size_t  varIndex,
const std::vector< size_t > &  dims 
)

Set dimensions for a variable.

◆ SetVarCoords()

void vtkXArrayAccessor::SetVarCoords ( size_t  varIndex,
const std::vector< size_t > &  coords 
)

◆ PrintSelf()

void vtkXArrayAccessor::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkNetCDFAccessor.

◆ PrintVarValue() [1/2]

void vtkXArrayAccessor::PrintVarValue ( const char *  name,
int  varid 
)
protected

◆ PrintVarValue() [2/2]

void vtkXArrayAccessor::PrintVarValue ( const char *  name,
int  varid,
const size_t *  startp,
const size_t *  countp 
)
protected

◆ IsContiguous()

bool vtkXArrayAccessor::IsContiguous ( int  varid,
const size_t *  startp,
const size_t *  countp 
)
protected

◆ GetContiguousStartSize()

void vtkXArrayAccessor::GetContiguousStartSize ( int  varid,
const size_t *  startp,
const size_t *  countp,
char *&  arrayStart,
vtkIdType arraySize 
)
protected

◆ Copy()

void vtkXArrayAccessor::Copy ( int  varid,
const size_t *  startp,
const size_t *  countp,
char *  dst 
)
protected

◆ GetDimIncrement()

std::vector< size_t > vtkXArrayAccessor::GetDimIncrement ( int  varid)
protected

◆ DecrementAndUpdate()

bool vtkXArrayAccessor::DecrementAndUpdate ( size_t  varid,
std::vector< size_t > &  count,
const size_t *  startp,
const size_t *  count_p,
const std::vector< size_t > &  dimIncrement,
char *&  src 
)
protected

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