class CORBA::AliasDef : public CORBA::TypedefDef
This class is derived from the TypedefDef class and represents an alias for a
typedef that is stored in the interface repository. This class provides methods for setting and obtaining the
IDLType of the original
typedef.
For more information on the TypedefDef class, go to
“TypedefDef” on page 109 for more information. For more information on the
IDLType class, go to
“IDLType” on page 96 for more information.
This method returns the IDLType of the original
typedef for which this object is an alias.
void original_type_def(CORBA::IDLType_ptr
val);
This method sets the IDLType of the original
typedef for which this object is an alias.
|
|
|
|
|
The IDLType to set for this alias.
|
class CORBA::ArrayDef : public CORBA::IDLType
This class is derived from the IDLType class and represents an array that is stored in the interface repository. It provides methods for setting and obtaining the type of the elements in the array as well as the length of the array.
This method returns the TypeCode of the array's elements.
This method returns the IDLType of the elements stored in this array.
void element_type_def(CORBA:IDLType_ptr element_type_def);
This method sets the IDLType of the elements stored in the array.
|
|
|
|
|
The IDLType of the elements in the array.
|
void length(CORBA::ULong
length);
class CORBA::AttributeDef : public CORBA::Contained,
public CORBA::Object
This method returns the mode of the attribute. The return value will be either CORBA::AttributeMode ATTR_READONLY for read only attributes or
CORBA::AttributeMode ATTR_NORMAL for read-write ones. Go to
“AttributeMode” on page 83 for more information.
void mode(CORBA::AttributeMode
_val);
This method returns the TypeCode that represents the attribute's type.
void type_def(CORBA::IDLType_ptr
type_def);
This method sets the IDLType for this object.
|
|
|
|
|
The IDLType of this object.
|
The AttributeDescription structure describes an attribute that is stored in the interface repository.
enum CORBA::AttributeMode
class CORBA::ConstantDef : public CORBA::Contained
This method returns the TypeCode representing the object's type.
void type_def(CORBA::IDLType_ptr
type_def);
This method sets the IDLType of the constant.
|
|
|
|
|
The IDLType of this constant.
|
This method returns a pointer to an Any object representing this object's value.
void value(CORBA::Any&
_val);
|
|
|
|
|
An Any object that represents this object's value.
|
The ConstantDescription structure describes a constant that is stored in the interface repository.
class CORBA::Contained : public CORBA::IRObject, public CORBA::Object
The Contained class is used to derive all interface repository objects that are themselves contained within another interface repository object. This class provides methods for:
Include the file corba.h when you use this class.
This method returns the absolute name, which is the name that uniquely identifies this object within its containing Repository. If the object's
defined_in attribute (set when the object is created) references a
Repository, then the absolute name is simply the object's name preceded by the string "::".
Returns a pointer to the Container where this object is defined.
Returns this object's Description. Go to
“Description” on page 92 for more information on the
Description structure.
void name(const char *
val);
void version(CORBA::String_var&
val);
void move(CORBA::Container_ptr
new_container, const char *
new_name, CORBA::String_var&
new_version);
class CORBA::Container : public CORBA::Container, public CORBA::Object
The Container class is used to create a containment hierarchy in the interface repository. A
Container object holds object definitions derived from the
Contained class. All object definitions derived from the
Container class, with the exception of the
Repository class, also inherit from the
Contained class.
The Container provides methods to create types of IDL types defined in
orbtypes.h, including
InterfaceDef,
ModuleDef and
ConstantDef classes, but not the
ValueMemberDef class. The
defined_in attribute of each definition that is created is initialized to point to this object.
The corba.h file should be included when you use this class.
CORBA::AbstractInterfaceDef_ptr create_abstract_interface(
const char* _arg_id,
const char* _arg_name,
const char* _arg_name,
const char* _arg_version,
const CORBA_AbstractInterfaceDefSeq&_arg_base_interfaces)
CORBA::AliasDef_ptr create_alias(const char *
id,
const char *
name,
const CORBA::String_var&
version,
CORBA::IDLType_ptr
original_type);
This method creates an AliasDef object with the specified attributes in this
Container and returns a pointer to the newly created object.
CORBA::ConstantDef_ptr create_constant(const char *
id,
const char *
name,
const CORBA::String_var&
version,
CORBA::IDLType_ptr
type,
const CORBA::Any&
value);
This method creates a ConstantDef object with the specified attributes in this
Container and returns a pointer to the newly created object.
CORBA::EnumDef_ptr create_enum(const char *
id,
const char *
name, const CORBA::String_var&
version,
const CORBA::EnumMemberSeq&
members);
This method creates an EnumDef object with the specified attributes in this
Container and returns a pointer to the newly created object.
CORBA::ExceptionDef_ptr create_exception(const char *
id,
const char *
name,
const CORBA::String_var&
version,
const CORBA::StructMemberSeq&
members);
This method creates an ExceptionDef object with the specified attributes in this
Container and returns a pointer to the newly created object.
CORBA::InterfaceDef_ptr create_interface(const char * id,
const char *name,
const CORBA::String_var& version,
const CORBA::InterfaceDefSeq& base_interfaces);
This method creates an InterfaceDef object with the specified attributes in this
Container and returns a pointer to the newly created object.
CORBA::ModuleDef_ptr create_module(const char *
id,
const char *
name,
const CORBA::String_var&
version);
This method creates a ModuleDef object with the specified attributes in this
Container and returns a pointer to the newly created object.
CORBA::StructDef_ptr create_struct(const char *
id,
const char *
name,
const CORBA::String_var&
version,
const CORBA::StructMemberSeq&
members);
This method creates a StructureDef object with the specified attributes in this
Container and returns a pointer to the newly created object.
CORBA::UnionDef_ptr create_union(const char *
id,
const char *
name,
const CORBA::String_var&
version,
CORBA::IDLType_ptr
discriminator_type,
const CORBA::UnionMemberSeq&
members);
This method creates a UnionDef object with the specified attributes in this
Container and returns a pointer to the newly created object.
CORBA::DescriptionSeq * describe_contents(CORBA::DefinitionKind
limit_type,
CORBA::Boolean
exclude_inherited, CORBA::Long
max_returned_objs);
CORBA::ContainedSeq * lookup_name(const char
*search_name,
CORBA::Long
levels_to_search, CORBA::DefinitionKind
limit_type,
CORBA::Boolean
exclude_inherited);
CORBA::ValueDef_ptr create_value(const char *
id,
const char *
name,
const char
version,
CORBA::boolean
is_custom,
CORBA::boolean
is_abstract,
const CORBA::ValueDef_ptr
_base_value,
CORBA::boolean
is_truncatable,
const CORBA::ValueDefSeq&
abstract_base_values,
const CORBA::InterfaceDefSeq&
supported _interfaces,
const CORBA.InitializerSeq&
initializers)
This method creates a ValueDef object with the specified attributes in this
Container and returns a reference to the newly created object.
CORBA::ValueBoxDef_ptr create_value_box(const char*
id, const char*
name, const char*
version, CORBA::IDLType_ptr
original_type)
This method creates a ValueBoxDef object in this
Container with the specified attributes and returns a reference to the newly created object.
enum CORBA::DefinitionKind
The constants in the DefinitionKind enumeration define the possible types of interface repository objects.
class CORBA::EnumDef : public CORBA::TypedefDef, public CORBA::Object
void members(CORBA::EnumMemberSeq
members);
class ExceptionDef : public CORBA::Contained
void members(CORBA:StructMemberSeq&
members);
This method returns the TypeCode that represents this exception's type.
CORBA::FixedDef public CORBA::IDLType, public CORBA::Object
struct CORBA::FullInterfaceDescription
The FullInterfaceDescription structure describes an interface that is stored in the interface repository.
If this variable is true, specifies an abstract valuetype.
If this variable is true, specifies custom marshalling for the valuetype.
If this variable is set to true, the value can be truncated to its base valuetype safely.
class CORBA::IDLType : public CORBA::IRObject, public CORBA::Object
The IDLType class provides an abstract interface that is inherited by all interface repository definitions that represent IDL types. This class provides a method for returning an object's
Typecode, which identifies the object's type. The
IDLType is unique; the
Typecode is not.
You should include the file corba.h when using this class.
class CORBA::InterfaceDef : public CORBA::Container,
public CORBA::Contained, public CORBA::IDLType
The InterfaceDef class is used to define an ORB object's interface that is stored in the interface repository.
You should include the file corba.h when you use this class.
typedef sequence<RepositoryId> RepositoryIdSeq;
typedef sequence<OperationDescription> OpDescriptionSeq;
typedef sequence<AttributeDescription> AttrDescriptionSeq;
attribute InterfaceDefSeq base_interfaces;
attribute boolean is_abstract;
readonly attribute InterfaceDefSeq
derived_interfaces
boolean is_a(in RepositoryId interface_id);
struct FullInterfaceDescription {
Identifier name;
RepositoryId id;
RepositoryId defined_in;
String_var version;
OpDescriptionSeq operations;
AttrDescriptionSeq attributes;
RepositoryIdSeq base_interfaces;
RepositoryIdSeq derived_interfaces;
TypeCode type;
boolean is_abstract;
};
FullInterfaceDescription describe_interface();
AttributeDef create_attribute(
in RepositoryId id,
in Identifier name,
in String_var version,
in IDLType type,
in CORBA::AttributeMode mode
);
OperationDef create_operation(
in RepositoryId id,
in Identifier name,
in String_var version,
in IDLType result,
in OperationMode mode,
in ParDescriptionSeq params,
in ExceptionDefSeq exceptions,
in ContextIdSeq contexts
);
struct InterfaceDescription {
Identifier name;
RepositoryId id;
RepositoryId defined_in;
String_var version;
RepositoryIdSeq base_interfaces;
boolean is_abstract;
};
};
void base_interfaces(const CORBA::InterfaceDefSeq&
val);
CORBA::AttributeDef_ptr create_attribute(const char *
id, const char *
name, const CORBA::String_var&
version, CORBA::IDLType_ptr
type, CORBA::AttributeMode
mode);
This method returns a pointer to a newly created AttributeDef that is contained in this object. The
id,
name,
version,
type, and
mode are set to the values specified.
CORBA::OperationDef_ptr create_operation(const char *id, const char *
name, CORBA::String_var&
version, CORBA::IDLType_ptr result,
CORBA::OperationMode
mode,
const CORBA::ParDescriptionSeq&
params,
const CORBA::ExceptionDefSeq&
exceptions,
const CORBA::ContextIdSeq&
contexts);
This method creates a new OperationDef that is contained by this object using the specified parameters. The
defined_in attribute of the newly created
OperationDef is set to identify this
InterfaceDef.
This method returns the FullInterfaceDescription which describes this object's interface.
This method returns true if this interface is identical to or inherits from the specified interface directly or indirectly.
class IRObject : CORBA::Object
The IRObject class offers the most generic interface for interface repository objects. The
Container class, IDLType, Contained, and others are derived from this class.
You should include the file corba.h when you use this class.
This method deletes this object from the interface repository. If this object is a Container, this method also deletes all of its contents. If the object is currently contained by another object, it is removed. The
destroy method returns the
Exception(CORBA::BAD_PARAM) when invoked on a
PrimitiveDef or
Repository object. The
Repository class is described in
“Repository” on page 106.
class ModuleDef : CORBA::Container,CORBA::Contained
The ModuleDescription structure describes a module that is stored in the interface repository.
class CORBA::OperationDef : public virtual CORBA::Contained, public CORBA::Object
The OperationDef class contains information about an interface operation that is stored in the interface repository. This class is derived from the
Contained class, which is described in
“Contained” on page 85. The inherited
describe method returns a
OperationDescription structure that provides complete information on the operation.
You should include the file corba.h when you use this class.
void context(const CORBA::ContextIdSeq& val);
void exceptions(const CORBA::ExceptionDefSeq&
val);
This method returns the mode of the operation represented by this OperationDef. The mode may be normal or oneway. Operations that have a normal mode are synchronous and return a value to the client application. Oneway operations do not block and no response is sent from the object implementation to the client.
void mode(CORBA::OperationMode
val);
This method returns a pointer to a list of ParameterDescription structures that describe the parameters to this
OperationDef.
void params(const CORBA::ParDescriptionSeq& val);
This method sets the list of the ParameterDescription structures for this
OperationDef. The order of the structures is significant and should correspond to the order defined in the IDL definition for the operation.
This method returns a pointer to a TypeCode representing the type of the value returned by this
Operation. The
TypeCode is a read-only attribute.
void result_def(CORBA::IDLType_ptr
val);
The OperationDescription structure describes an operation that is stored in the interface repository.
The ParameterDescription structure describes a parameter for an operation that is stored in the interface repository.
class PrimitiveDef : public CORBA::IDLType, public CORBA::Object
The class is used to describe a primitive (such as an int or a
long) that is stored in the interface repository. It provides a method for retrieving what kind of primitive it is.
enum CORBA::PrimitiveKind
The PrimitiveKind enumeration contains the constants that define the primitive types of objects that may be stored in the interface repository.
class Repository : public CORBA::Container, public CORBA::Object
The Repository class provides access to the interface repository and is derived from the
Container class. Go to
“Contained” on page 85 for more information.
You should include the file corba.h when using this class.
This method creates a new ArrayDef and returns a pointer to it.
This method creates a new SequenceDef object and returns a pointer to it.
This method creates a new StringDef object and returns a pointer to it.
This method creates a new WstringDef object and returns a pointer to it.
class SequenceDef : public CORBA::IDLType, public CORBA::Object
void bound(CORBA::ULong
bound)
This method returns the TypeCode of the elements in this sequence.
void element_type_def(CORBA::IDLType_ptr
element_type_def);
class StringDef : public CORBA::IDLType, public CORBA::Object
The class is used to describe Strings stored in the interface repository. This interface provides methods for setting and retrieving the bounds of the strings.
void bound(CORBA::ULong
bound);
class StructDef : public CORBA::TypedefDef, public CORBA::Container, public CORBA::Object
void members(CORBA::StructMemberSeq&
members);
class TypedefDef : public CORBA::Contained, public CORBA::IDLType, public CORBA::Object
The TypeDescription structure contains the information that describes a type for an operation stored in the interface repository.
class UnionDef : public CORBA::TypedefDef, public CORBA::Container, public CORBA::Object
This class is used to represent a Union that is stored in the interface repository. This class provides methods for setting and retrieving the union's list of members and discriminator type.
This method returns the TypeCode of the discriminator of the
Union.
void
discriminator_type_def(CORBA::IDLType_ptr
discriminator_type_def);
This method returns the Union's list of members.
void members(CORBA::UnionMemberSeq&
members);
This method sets the Union's list of members.
The UnionMember struct contains information that describes a
Union that is stored in the interface repository.
class ValueBoxDef public CORBA::Contained, public COBRA::IDLType, public CORBA::Object
This declaration is almost equal to valuetype boxed type <IDLType> but
ValueBoxDef is not the same as simple
ValueTypeDef.
class CORBA::ValueDef public CORBA::Container, public CORBA::Contained, public CORBA::IDLType, public CORBA::Object
This interface describes the IDL value type called a construct. This interface is very close to a class type. It represent a value definition that is stored in the Interface Repository.
This method returns true if the value is an abstract value type.
This method returns true if the value uses custom marshalling.
This method returns true if the value can be truncated from its base value safely.
This method returns true if the value on which it is invoked either is identical to or inherits, directly or indirectly from the interface or value defined by the
value_id parameter. Otherwise it returns
false.
This method returns a FullValueDescription describing the value including its operations and attributes.
CORBA::ValueMemberDef_ptr create_value_member(const Char*
id, const Char*
name, const Char*
version, CORBA::IDLType_ptr
type_def, CORBA::short
access);
This method returns a new ValueMemberDef contained in the ValueDef on which it is invoked.
CORBA::AttributeDef_ptr create_attribute(const Char*
id, const Char*
name,const Char*
version, CORBA::IDLType_ptr
type, CORBA::AttributeMode
mode);
CORBA::OperationDef_ptr create_operation(const Char*
id, const Char*
name, const Char*
version, CORBA::IDLType_ptr
result, CORBA::OperationMode
mode, const CORBA::ParDescriptionSeq&
params, const CORBA::ExceptionDefSeq&
exceptions, const CORBA::ContextIDSeq&
contexts);
This method creates a new Operation for this
valuetype and returns an
OperationDef for it.
If this variable is true, the value is an abstract value type.
If this variable is true, the valuetype is custom marshalled.
If this variable is true, the value type can be truncated to its base value type safely.
class WstringDef : public CORBA::IDLType, public CORBA::Object
void members(CORBA::ULong bound);