Rocstar  1.0
Rocstar multiphysics simulation application
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Pane::Attribute_friend Class Reference

#include <Pane.h>

Inheritance diagram for Pane::Attribute_friend:
Collaboration diagram for Pane::Attribute_friend:

Public Member Functions

 Attribute_friend (Pane *p, int i)
 
- Public Member Functions inherited from Attribute
void set_size (int nitems, int ngitems=0) throw (COM_exception)
 Set the size of items and ghost items. More...
 
void * allocate (int strd, int cap, bool force) throw (COM_exception)
 Allocate memory for the attribute. More...
 
int deallocate () throw (COM_exception)
 Deallocate memory if it was allocated by allocate(). More...
 
void copy_array (void *buf, int strd, int nitem, int offset=0, int direction=COPY_IN) throw (COM_exception)
 
void append_array (const void *from, int strd, int nitem) throw (COM_exception)
 
const std::string & name () const
 Obtain the name of the attribute. More...
 
std::string fullname () const
 Obtain the full name of the attribute including window name suitable for printing out error messages. More...
 
int id () const
 Obtain the id (or index) of the attribute. More...
 
Attributeparent ()
 Parent attribute used by this object. More...
 
const Attributeparent () const
 
Attributeroot ()
 Root of use-inheritance. More...
 
const Attributeroot () const
 
const void * pointer () const
 Obtain a constant pointer to the physical address. More...
 
void * pointer () throw (COM_exception)
 Obtain a modifiable pointer to the physical address. More...
 
const void * get_addr (int i, int j=0) const throw (COM_exception)
 Obtain the address of the jth component of the ith item, where 0<=i<size_of_items. More...
 
void * get_addr (int i, int j=0) throw (COM_exception)
 
 Attribute ()
 Default constructor. More...
 
 Attribute (Pane *pane, const std::string &name, int id, Shorter_size loc, int type, const int ncomp, const std::string &unit)
 Create an attribute with name n in window w. More...
 
 Attribute (Pane *pane, Attribute *parent, const std::string &name, int id)
 Inherit an attribute from another. More...
 
 ~Attribute ()
 Destructors. More...
 
const Panepane () const
 Obtain a constant pointer to the owner pane of the attribute. More...
 
Panepane ()
 Obtain a modifiable pointer to the owner pane of the attribute. More...
 
const Windowwindow () const
 Obtain a constant pointer to the parent window of the attribute. More...
 
Windowwindow ()
 Obtain a modifiable pointer to the parent window of the attribute. More...
 
Shorter_size location () const
 Obtain the location of the attribute. More...
 
bool is_windowed () const
 Checks whether the attribute is associated with the window. More...
 
bool is_panel () const
 Checks whether the attribute is associated with a pane. More...
 
bool is_elemental () const
 Checks whether the attribute is associated with an element. More...
 
bool is_nodal () const
 Checks whether the attribute is associated with a node. More...
 
COM_Type data_type () const
 Obtain the data type of each component of the attribute. More...
 
const std::string & unit () const
 Obtain the unit of the attribute. More...
 
int size_of_components () const
 Obtain the number of components in the attribute. More...
 
int size_of_items () const
 Obtain the number of items in the attribute. More...
 
int maxsize_of_items () const
 Obtain the maximum allowed number of items in the attribute. More...
 
int size_of_ghost_items () const
 Obtain the number of ghost items in the attribute. More...
 
int maxsize_of_ghost_items () const
 Obtain the maximum allowed number of items in the attribute. More...
 
int size_of_real_items () const
 Obtain the number of real items in the attribute. More...
 
int maxsize_of_real_items () const
 Obtain the maximum allowed number of real items in the attribute. More...
 
bool empty () const
 Check whether the number of items of the attribute is zero. More...
 
int capacity () const
 Obtain the capacity of the array. More...
 
int stride () const
 Obtain the stride of the attribute in base datatype. More...
 
int stride_in_bytes () const
 Obtain the stride of the attribute in bytes. More...
 
int status () const
 Obtain the status of the attribute. More...
 
bool initialized () const
 Returns whether the array for the attribute has been set or allocated. More...
 
bool size_set () const
 Returns whether the size for the attribute has been set. More...
 
bool allocated () const
 Returns whether the array for the attribute has been set or allocated. More...
 
bool is_const () const
 Returns whether the array is set to be read-only. More...
 
bool is_staggered () const
 Check how the attribute values are organized. More...
 

Private Member Functions

 Attribute_friend (Attribute &)
 

Additional Inherited Members

- Public Types inherited from Attribute
enum  Copy_dir { COPY_IN, COPY_OUT }
 
typedef unsigned char Shorter_size
 One byte unsighed int. More...
 
typedef unsigned int Size
 Unsighed int. More...
 
- Static Public Member Functions inherited from Attribute
static int get_sizeof (COM_Type type, int count=1)
 
static bool compatible_types (COM_Type t1, COM_Type t2)
 
static bool is_digit (char c)
 
- Protected Types inherited from Attribute
enum  {
  STATUS_NOT_INITIALIZED =0, STATUS_SET =1, STATUS_SET_CONST =2, STATUS_USE =3,
  STATUS_ALLOCATED =4
}
 
- Protected Member Functions inherited from Attribute
void set_pointer (void *p, int strd, int cap, int offset, bool is_const) throw (COM_exception)
 Set the physical address of the attribute values. More...
 
void inherit (Attribute *a, bool clone, bool withghost, int depth=0) throw (COM_exception)
 Inherit from parent. If depth>0, then the procedure is for the subcomponents. More...
 
 Attribute (Pane *pane, int i)
 Constructor for keywords. The default nitems for keywords is 0. More...
 
- Protected Attributes inherited from Attribute
Pane_pane
 Pointer to its owner pane. More...
 
Attribute_parent
 Parent attribute being used. More...
 
std::string _name
 Name of the attribute. More...
 
int _id
 Id field data. More...
 
Shorter_size _loc
 Location. More...
 
int _ncomp
 Number of components. More...
 
COM_Type _type
 Base data type of the attribute. More...
 
std::string _unit
 Unit of the attribute. More...
 
int _nitems
 Size of total items. Default value is -1. More...
 
int _ngitems
 Size of ghost items. More...
 
int _gap
 Gap between the IDs of real and ghost items. More...
 
Shorter_size _status
 Indicating whether it has been initialized. More...
 
void * _ptr
 Physical address of the attribute. More...
 
int _strd
 Stride. More...
 
int _nbytes_strd
 Number of bytes of the stride. More...
 
int _cap
 Capacity. More...
 
- Static Protected Attributes inherited from Attribute
static const char * _keywords [COM_NUM_KEYWORDS]
 List of keywords. More...
 
static const char _keylocs [COM_NUM_KEYWORDS]
 Default locations. More...
 
static const COM_Type _keytypes [COM_NUM_KEYWORDS]
 Default data types. More...
 
static const int _keysizes [COM_NUM_KEYWORDS]
 Default sizes. More...
 

Detailed Description

Definition at line 51 of file Pane.h.

Constructor & Destructor Documentation

Attribute_friend ( Attribute )
explicitprivate
Attribute_friend ( Pane p,
int  i 
)
inline

Definition at line 54 of file Pane.h.

54 : Attribute(p, i) {}
Attribute()
Default constructor.
Definition: Attribute.h:60
blockLoc i
Definition: read.cpp:79

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