public class EnumerationDefinition extends java.lang.Object implements EnumerationDefinition
| Modifier and Type | Field and Description |
|---|---|
protected long |
cObjPtr |
| Constructor and Description |
|---|
EnumerationDefinition() |
EnumerationDefinition(long cObjPtr) |
| Modifier and Type | Method and Description |
|---|---|
org.omg.CORBA.Request |
_create_request(org.omg.CORBA.Context ctx,
java.lang.String operation,
org.omg.CORBA.NVList arg_list,
org.omg.CORBA.NamedValue result) |
org.omg.CORBA.Request |
_create_request(org.omg.CORBA.Context ctx,
java.lang.String operation,
org.omg.CORBA.NVList arg_list,
org.omg.CORBA.NamedValue result,
org.omg.CORBA.ExceptionList exclist,
org.omg.CORBA.ContextList ctxlist) |
org.omg.CORBA.Object |
_duplicate() |
org.omg.CORBA.DomainManager[] |
_get_domain_managers() |
org.omg.CORBA.Object |
_get_interface_def() |
org.omg.CORBA.Policy |
_get_policy(int policy_type) |
int |
_hash(int maximum) |
boolean |
_is_a(java.lang.String repositoryIdentifier) |
boolean |
_is_equivalent(org.omg.CORBA.Object other) |
boolean |
_non_existent() |
void |
_release() |
org.omg.CORBA.Request |
_request(java.lang.String operation) |
org.omg.CORBA.Object |
_set_policy_override(org.omg.CORBA.Policy[] policies,
org.omg.CORBA.SetOverrideType set_add) |
void |
addItem(java.lang.String itemName)
Add a new item to the enumeration.
|
void |
check()
Check the application structure for ASAM-ODS conformity.
|
ApplicationElement |
createElement(BaseElement baseElem)
Create a new application element in the application
structure.
|
EnumerationDefinition |
createEnumerationDefinition(java.lang.String enumName)
Create a new enumeration definition.
|
void |
createInstanceRelations(ApplicationRelation applRel,
InstanceElement[] elemList1,
InstanceElement[] elemList2)
Create the relation between a list of instances.
|
ApplicationRelation |
createRelation()
Create a new relation.
|
boolean |
equals(java.lang.Object obj) |
protected void |
finalize() |
ApplicationElement |
getElementById(T_LONGLONG aeId)
Get the application element with the requested Id.
|
ApplicationElement |
getElementByName(java.lang.String aeName)
Get the application element with the requested name.
|
ApplicationElement[] |
getElements(java.lang.String aePattern)
Get the application elements whose names match the
pattern.
|
ApplicationElement[] |
getElementsByBaseType(java.lang.String aeType)
Get the names of application elements that are derived
from the specified base element.
|
EnumerationDefinition |
getEnumerationDefinition(java.lang.String enumName)
Get the specified enumeration definition.
|
int |
getIndex()
(28007)
Get the index of the enumeration.
|
InstanceElement |
getInstanceByAsamPath(java.lang.String asamPath)
Get the instance element specified by the ASAM path.
|
InstanceElement[] |
getInstancesById(ElemId[] ieIds)
Get the instance elements specified by the element id.
|
int |
getItem(java.lang.String itemName)
Get the value of an item.
|
java.lang.String |
getItemName(int item)
Get the name of an item.
|
int |
getItme(java.lang.String itemName)
Get the value of an item.
|
java.lang.String |
getName()
Get the name of the enumeration.
|
ApplicationRelation[] |
getRelations(ApplicationElement applElem1,
ApplicationElement applElem2)
Returns the relations between two application elements.
|
AoSession |
getSession()
Get the current client session in which the application
structure is created.
|
ApplicationElement[] |
getTopLevelElements(java.lang.String aeType)
Get the top level application elements which are inherted
from the base element that matches the base type.
|
java.lang.String[] |
listElements(java.lang.String aePattern)
Get the names of the application elements that match the
pattern.
|
java.lang.String[] |
listElementsByBaseType(java.lang.String aeType)
Get the names of application elements that are derived
from the given base type.
|
java.lang.String[] |
listEnumerations()
Get the list of all enumeration names.
|
java.lang.String[] |
listItemNames()
List the possible names of the enumeration.
|
java.lang.String[] |
listTopLevelElements(java.lang.String aeType)
Get the names of the top level application elements that
are derived from the given base type.
|
void |
removeElement(ApplicationElement applElem)
Remove an application element from the application
structure.
|
void |
removeEnumerationDefinition(java.lang.String enumName)
Remove the enumeration definition.
|
void |
removeRelation(ApplicationRelation applRel)
This method removes an application relation from the
structure.
|
void |
renameItem(java.lang.String oldItemName,
java.lang.String newItemName)
Rename the item of the enumeration.
|
void |
setName(java.lang.String enumName)
Set the name of the enumeration.
|
public EnumerationDefinition()
public EnumerationDefinition(long cObjPtr)
public boolean equals(java.lang.Object obj)
equals in class java.lang.Objectpublic java.lang.String[] listItemNames()
throws AoException
listItemNames in interface EnumerationDefinitionOperationsAoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVE
AO_TRANSACTION_NOT_ACTIVEpublic int getItme(java.lang.String itemName)
throws AoException
itemName - The name of the item.AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVE
AO_TRANSACTION_NOT_ACTIVE
AO_NOT_FOUNDpublic java.lang.String getItemName(int item)
throws AoException
getItemName in interface EnumerationDefinitionOperationsitem - The value of the item.AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVE
AO_TRANSACTION_NOT_ACTIVE
AO_NOT_FOUNDpublic int getItem(java.lang.String itemName)
throws AoException
getItem in interface EnumerationDefinitionOperationsitemName - The name of the item.AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVE
AO_TRANSACTION_NOT_ACTIVE
AO_NOT_FOUNDpublic void addItem(java.lang.String itemName)
throws AoException
addItem in interface EnumerationDefinitionOperationsitemName - The name of the new item.AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVE
AO_TRANSACTION_NOT_ACTIVE
AO_ACCESS_DENIED
AO_DUPLICATE_NAME
AO_DUPLICATE_VALUEpublic void renameItem(java.lang.String oldItemName,
java.lang.String newItemName)
throws AoException
renameItem in interface EnumerationDefinitionOperationsoldItemName - The existing name of the itrem.newItemName - the new name of the item.AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVE
AO_TRANSACTION_NOT_ACTIVE
AO_NOT_FOUNDpublic java.lang.String getName()
throws AoException
getName in interface EnumerationDefinitionOperationsAoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVE
AO_TRANSACTION_NOT_ACTIVEpublic void setName(java.lang.String enumName)
throws AoException
setName in interface EnumerationDefinitionOperationsenumName - Name of the enumeration.AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVE
AO_TRANSACTION_NOT_ACTIVE
AO_ACCESS_DENIEDpublic int getIndex()
throws AoException
getIndex in interface EnumerationDefinitionOperationsAoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVE
AO_TRANSACTION_NOT_ACTIVEpublic void check()
throws AoException
AoException - with the following possible error codes:
AO_CONNECTION_LOST
AO_DUPLICATE_BASE_ATTRIBUTE
AO_IMPLEMENTATION_PROBLEM
AO_INVALID_RELATION
AO_MISSING_ATTRIBUTE
AO_MISSING_RELATION
AO_MISSING_APPLICATION_ELEMENT
AO_NOT_IMPLEMENTED
AO_NO_PATH_TO_ELEMENT
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVEpublic ApplicationElement createElement(BaseElement baseElem) throws AoException
baseElem - The base element from which the
application element is derived.AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVEpublic ApplicationRelation createRelation() throws AoException
AoException - with the following possible error codes:
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVEpublic ApplicationElement getElementById(T_LONGLONG aeId) throws AoException
aeId - The Id of the requested application element.AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVEpublic ApplicationElement getElementByName(java.lang.String aeName) throws AoException
aeName - The name of the requested application
element.AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVEpublic ApplicationElement[] getElements(java.lang.String aePattern) throws AoException
aePattern - The name or the search pattern for the
requested application elements.AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVEpublic ApplicationElement[] getElementsByBaseType(java.lang.String aeType) throws AoException
aeType - The requested base element type.AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_INVALID_BASETYPE
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVEpublic InstanceElement getInstanceByAsamPath(java.lang.String asamPath) throws AoException
asamPath - The ASAM path of the requested instance
element.AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_INVALID_ASAM_PATH
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVEpublic ApplicationRelation[] getRelations(ApplicationElement applElem1, ApplicationElement applElem2) throws AoException
applElem1 - The first application element.applElem2 - The second application element.AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVEpublic ApplicationElement[] getTopLevelElements(java.lang.String aeType) throws AoException
aeType - The requested base type.AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_INVALID_BASETYPE
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVEpublic java.lang.String[] listElements(java.lang.String aePattern)
throws AoException
aePattern - The name or the search pattern for the
requested base elements.AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVEpublic java.lang.String[] listElementsByBaseType(java.lang.String aeType)
throws AoException
aeType - The requested base type.AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_INVALID_BASETYPE
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVEpublic java.lang.String[] listTopLevelElements(java.lang.String aeType)
throws AoException
aeType - The requested base type.AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_INVALID_BASETYPE
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVEpublic void removeElement(ApplicationElement applElem) throws AoException
applElem - The application element to be removed.AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_HAS_INSTANCES
AO_HAS_REFERENCES
AO_IMPLEMENTATION_PROBLEM
AO_NOT_FOUND
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVEpublic void removeRelation(ApplicationRelation applRel) throws AoException
applRel - The application relation to be removed.AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_HAS_INSTANCES
AO_IMPLEMENTATION_PROBLEM
AO_NOT_FOUND
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVEpublic InstanceElement[] getInstancesById(ElemId[] ieIds) throws AoException
ieIds - The sequence with the element id.AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_INVALID_ASAM_PATH
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVEpublic AoSession getSession() throws AoException
AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVE
AO_TRANSACTION_NOT_ACTIVEpublic EnumerationDefinition createEnumerationDefinition(java.lang.String enumName) throws AoException
enumName - Name of the enumerationAoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVE
AO_TRANSACTION_NOT_ACTIVE
AO_ACCESS_DENIEDpublic void createInstanceRelations(ApplicationRelation applRel, InstanceElement[] elemList1, InstanceElement[] elemList2) throws AoException
applRel - The application relation.elemList1 - The list with the instances of one
application element for which the
relation will be created.elemList2 - The list with the related instances.AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVE
AO_TRANSACTION_NOT_ACTIVE
AO_INVALID_REQUESTpublic EnumerationDefinition getEnumerationDefinition(java.lang.String enumName) throws AoException
enumName - Name of the requested enumeration.AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVE
AO_TRANSACTION_NOT_ACTIVEpublic java.lang.String[] listEnumerations()
throws AoException
AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVE
AO_TRANSACTION_NOT_ACTIVEpublic void removeEnumerationDefinition(java.lang.String enumName)
throws AoException
enumName - Name of the enumeration to remove.AoException - with the following possible error codes:
AO_BAD_PARAMETER
AO_CONNECTION_LOST
AO_IMPLEMENTATION_PROBLEM
AO_NOT_IMPLEMENTED
AO_NO_MEMORY
AO_SESSION_NOT_ACTIVE
AO_TRANSACTION_NOT_ACTIVE
AO_ACCESS_DENIEDprotected void finalize()
throws java.lang.Throwable
finalize in class java.lang.Objectjava.lang.Throwablepublic org.omg.CORBA.Request _create_request(org.omg.CORBA.Context ctx,
java.lang.String operation,
org.omg.CORBA.NVList arg_list,
org.omg.CORBA.NamedValue result)
_create_request in interface org.omg.CORBA.Objectpublic org.omg.CORBA.Request _create_request(org.omg.CORBA.Context ctx,
java.lang.String operation,
org.omg.CORBA.NVList arg_list,
org.omg.CORBA.NamedValue result,
org.omg.CORBA.ExceptionList exclist,
org.omg.CORBA.ContextList ctxlist)
_create_request in interface org.omg.CORBA.Objectpublic org.omg.CORBA.Object _duplicate()
_duplicate in interface org.omg.CORBA.Objectpublic org.omg.CORBA.DomainManager[] _get_domain_managers()
_get_domain_managers in interface org.omg.CORBA.Objectpublic org.omg.CORBA.Object _get_interface_def()
_get_interface_def in interface org.omg.CORBA.Objectpublic org.omg.CORBA.Policy _get_policy(int policy_type)
_get_policy in interface org.omg.CORBA.Objectpublic int _hash(int maximum)
_hash in interface org.omg.CORBA.Objectpublic boolean _is_a(java.lang.String repositoryIdentifier)
_is_a in interface org.omg.CORBA.Objectpublic boolean _is_equivalent(org.omg.CORBA.Object other)
_is_equivalent in interface org.omg.CORBA.Objectpublic boolean _non_existent()
_non_existent in interface org.omg.CORBA.Objectpublic void _release()
_release in interface org.omg.CORBA.Objectpublic org.omg.CORBA.Request _request(java.lang.String operation)
_request in interface org.omg.CORBA.Objectpublic org.omg.CORBA.Object _set_policy_override(org.omg.CORBA.Policy[] policies,
org.omg.CORBA.SetOverrideType set_add)
_set_policy_override in interface org.omg.CORBA.Object