public interface CharacteristicList extends TransientObject
Modifier and Type | Interface and Description |
---|---|
static class |
CharacteristicList.CharacteristicInformation
Contains the type and name of a characteristic
|
Modifier and Type | Method and Description |
---|---|
void |
deleteCharacteristic(String name,
NXObject.AttributeType type)
Removes a characteristic from the characteristic list.
|
CharacteristicList.CharacteristicInformation[] |
getCharacteristicTitlesByType(NXObject.AttributeType type)
Returns the titles of all characteristics that have the specified type.
|
int |
getIntegerCharacteristic(String name)
Gets the value of an integer characteristic.
|
double |
getRealCharacteristic(String name)
Gets the value of a real characteristic.
|
String |
getStringCharacteristic(String name)
Gets the value of a string characteristic
License requirements: routing_base ("Routing Basic") . |
void |
setCharacteristic(String name,
double value)
Sets the value of an real characteristic associated with the input name.
|
void |
setCharacteristic(String name,
int value)
Sets the value of an integer characteristic associated with the input name.
|
void |
setCharacteristic(String name,
String value)
Sets the value of an string characteristic.
|
void |
setCharacteristic(String name,
String value,
NXObject.AttributeType type)
Sets the value of a string or reference characteristic.
|
_value, dispose, printTestData, printTestData
int getIntegerCharacteristic(String name) throws NXException, RemoteException
name
- The name of the characteristic.NXException
RemoteException
void setCharacteristic(String name, int value) throws NXException, RemoteException
name
- The name of the characteristicvalue
- The integer value of the characteristicNXException
RemoteException
double getRealCharacteristic(String name) throws NXException, RemoteException
name
- The name of the characteristicNXException
RemoteException
void setCharacteristic(String name, double value) throws NXException, RemoteException
name
- The name of the characteristicvalue
- The real value of the characteristicNXException
RemoteException
String getStringCharacteristic(String name) throws NXException, RemoteException
name
- The name of the characteristicNXException
RemoteException
void setCharacteristic(String name, String value) throws NXException, RemoteException
name
- The name of the characteristicvalue
- The string value of the characteristicNXException
RemoteException
void setCharacteristic(String name, String value, NXObject.AttributeType type) throws NXException, RemoteException
name
- The name of the characteristicvalue
- The string value of the characteristictype
- The type of the characteristic, either string or reference type. NXObject.AttributeType.ANY
is not valid. NXObject.AttributeType
for more information.NXException
RemoteException
CharacteristicList.CharacteristicInformation[] getCharacteristicTitlesByType(NXObject.AttributeType type) throws NXException, RemoteException
type
- The characteristic type. NXObject.AttributeType.ANY
returns the titles of all characteristics in the list. NXObject.AttributeType
for more information.NXException
RemoteException
void deleteCharacteristic(String name, NXObject.AttributeType type) throws NXException, RemoteException
name
- The name of the characteristictype
- The type of the characteristic. NXObject.AttributeType.ANY
is not valid. NXObject.AttributeType
for more information.NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.