Dictionary Class Reference
 
 
 
Dictionary Class Reference

#include <xsi_dictionary.h>


Class Description

The dictionary object contains application definitions such as Family objects. See siFamily for a list of available families.

Tip:
CRef::Set is the C++ API equivalent of Dictionary.GetObject
Warning:
Not implemented.
Inheritance diagram for Dictionary:
SIObject CBase

List of all members.

Public Member Functions

  Dictionary ()
  ~Dictionary ()
  Dictionary (const CRef &in_ref)
  Dictionary (const Dictionary &in_obj)
bool  IsA (siClassID in_ClassID) const
siClassID  GetClassID () const
Dictionary operator= (const Dictionary &in_obj)
Dictionary operator= (const CRef &in_ref)

Constructor & Destructor Documentation

Default constructor.

~Dictionary ( )

Default destructor.

Dictionary ( const CRef in_ref )

Constructor.

Parameters:
in_ref constant reference object.
Dictionary ( const Dictionary in_obj )

Copy constructor.

Parameters:
in_obj constant class object.

Member Function Documentation

bool IsA ( siClassID  in_ClassID ) const [virtual]

Returns true if a given class type is compatible with this API class.

Parameters:
in_ClassID class type.
Returns:
true if the class is compatible, false otherwise.

Reimplemented from SIObject.

siClassID GetClassID ( ) const [virtual]

Returns the type of the API class.

Returns:
The class type.

Reimplemented from SIObject.

Dictionary& operator= ( const Dictionary in_obj )

Creates an object from another object. The newly created object is set to empty if the input object is not compatible.

Parameters:
in_obj constant class object.
Returns:
The new Dictionary object.
Dictionary& operator= ( const CRef in_ref )

Creates an object from a reference object. The newly created object is set to empty if the input reference object is not compatible.

Parameters:
in_ref constant class object.
Returns:
The new Dictionary object.

Reimplemented from SIObject.


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