RVC::SERIALIZE Class Reference
Interface for RVC objects that support a serialize text object paradigm. More...
#include <rvc/serialze.h>
Classes | |
| class | FILTER_USAGEFOROBJTYPE |
| class | MAKEPARMS |
| Container for parameters to make object. More... | |
Public Member Functions | |
| SERIALIZE (const RVC::SERIALIZE &obj) | |
| SERIALIZE () | |
| virtual | ~SERIALIZE () |
| RVC::OBJTYPE | GetForObjectType () const |
| DISPPARMUSAGE | GetUsage () const |
| UINT16 | GetVersion () const |
| ERRVALUE | Make (RVC::OBJITEM &ObjItem, const MAKEPARMS &MakeParms, const char *Source=0, const CREDENTIALS *Credentials=0) |
| ERRVALUE | Make (const RVC::OBJECT &parent, const RVC::DESCRIPTOR &Descriptor, const MAKEPARMS &MakeParms, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS) |
| RVC::SERIALIZE & | operator= (const RVC::SERIALIZE &rhs) |
Static Public Member Functions | |
| static RVC::OBJTYPESET | GetObjTypeSet () |
| static bool | IsSerialize (RVC::OBJTYPE ObjType) |
Detailed Description
Interface for RVC objects that support a serialize text object paradigm.
This includes methods to get usage and object type information.
RVC Object Types that this class supports: Derived class
Default RVC Object Type for this class: Derived class
Valid parents for this class: Derived class
Constructor & Destructor Documentation
| RVC::SERIALIZE::SERIALIZE | ( | ) |
Default constructor.
| RVC::SERIALIZE::SERIALIZE | ( | const RVC::SERIALIZE & | obj | ) |
Copy Constructor.
| virtual RVC::SERIALIZE::~SERIALIZE | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| RVC::OBJTYPE RVC::SERIALIZE::GetForObjectType | ( | ) | const |
Obtain type of object this serialize object belongs to.
- Returns:
- RVCOBJECT::OBJTYPE
| static RVC::OBJTYPESET RVC::SERIALIZE::GetObjTypeSet | ( | ) | [static] |
Get correct OBJTYPESET for all text serialize OBJTYPE's.
- Returns:
- OBJTYPESET for all text serialize OBJTYPE's
Reimplemented from RVC::TEXTOBJ.
| DISPPARMUSAGE RVC::SERIALIZE::GetUsage | ( | ) | const |
Obtain the usage of the serialize object.
- Returns:
- DISPPARMUSAGE_...
| UINT16 RVC::SERIALIZE::GetVersion | ( | ) | const |
Obtain version number of seralize object.
- Returns:
- Version number
| static bool RVC::SERIALIZE::IsSerialize | ( | RVC::OBJTYPE | ObjType | ) | [static] |
Determine if the object type is a script text object.
| ERRVALUE RVC::SERIALIZE::Make | ( | RVC::OBJITEM & | ObjItem, | |
| const MAKEPARMS & | MakeParms, | |||
| const char * | Source = 0, |
|||
| const CREDENTIALS * | Credentials = 0 | |||
| ) |
Create serialize object.
- Parameters:
-
ObjItem Parent object and DESCRIPTOR of object to create, new location RETURNED Source Source of raster creation, default is GetAppName() Credentials User credentials passed in, NULL for default behavior
| ERRVALUE RVC::SERIALIZE::Make | ( | const RVC::OBJECT & | parent, | |
| const RVC::DESCRIPTOR & | Descriptor, | |||
| const MAKEPARMS & | MakeParms, | |||
| const CREDENTIALS *Credentials | RVC_DEFAULT_CREDENTIALS | |||
| ) |
Create serialize object.
- Parameters:
-
parent Parent object to create metadata under RVC_DEFAULT_CREDENTIALS User credentials passed in, NULL for default behavior
| RVC::SERIALIZE& RVC::SERIALIZE::operator= | ( | const RVC::SERIALIZE & | rhs | ) |
Assignment.
Reimplemented from RVC::TEXTOBJ.
Reimplemented in RVC::DBPARM, RVC::DISPGROUP, RVC::DISPLAYOUT, RVC::DISPPARM, RVC::DISPSIM3D, RVC::DISPWINDOW, RVC::LAYOUTTEMPLATE, and RVC::MOSAICLAYOUT.
The documentation for this class was generated from the following file:
- rvc/serialze.h
