public interface PropertyList extends TransientObject
Modifier and Type | Interface and Description |
---|---|
static class |
PropertyList.DoubleMatrixData
This class holds the data returned from
getDoubleMatrix(java.lang.String) |
static class |
PropertyList.IntegerMatrixData
This class holds the data returned from
getIntegerMatrix(java.lang.String) |
static class |
PropertyList.ListMode
Indicates whether the properties in the list are named.
|
static class |
PropertyList.PropertyType
Represents the property types.
|
Modifier and Type | Method and Description |
---|---|
PropertyList |
getArray(int propertyIndex)
Gets the value for the given index.
|
PropertyList |
getArray(String propertyName)
Gets the value for the given property name.
|
int |
getBits(int propertyIndex)
Gets the bits value for the given index.
|
int |
getBits(String propertyName)
Gets the bits value for the given property name.
|
double |
getDouble(int propertyIndex)
Gets the double value for the given index.
|
double |
getDouble(String propertyName)
Gets the double value for the given property name.
|
PropertyList.DoubleMatrixData |
getDoubleMatrix(int propertyIndex)
Gets the double matrix for the given index.
|
PropertyList.DoubleMatrixData |
getDoubleMatrix(String propertyName)
Gets the double matrix for the given property name.
|
double[] |
getDoubleVector(int propertyIndex)
Gets the double vector for the given index.
|
double[] |
getDoubleVector(String propertyName)
Gets the double vector for the given property name.
|
int |
getEnum(int propertyIndex)
Gets the value for the given index.
|
int |
getEnum(String propertyName)
Gets the value for the given property name.
|
String |
getEnumAsString(int propertyIndex)
Gets the value for the given index.
|
String |
getEnumAsString(String propertyName)
Gets the value for the given property name.
|
String[] |
getEnumMembers(int propertyIndex)
Gets the enum members for the given property index.
|
String[] |
getEnumMembers(String propertyName)
Gets the enum members for the given property of type enum.
|
String |
getFile(int propertyIndex)
Gets the value for the given index.
|
String |
getFile(String propertyName)
Gets the value for the given property name.
|
int |
getInteger(int propertyIndex)
Gets the integer value for the given index.
|
int |
getInteger(String propertyName)
Gets the integer value for the given property name.
|
PropertyList.IntegerMatrixData |
getIntegerMatrix(int propertyIndex)
Gets the integer matrix for the given index.
|
PropertyList.IntegerMatrixData |
getIntegerMatrix(String propertyName)
Gets the integer matrix for the given property name.
|
int[] |
getIntegerVector(int propertyIndex)
Gets the integer vector for the given index.
|
int[] |
getIntegerVector(String propertyName)
Gets the integer vector for the given property name.
|
boolean |
getLogical(int propertyIndex)
Gets the logical value for the given index.
|
boolean |
getLogical(String propertyName)
Gets the logical value for the given property name.
|
Point3d |
getPoint(int propertyIndex)
Gets the point value for the given index.
|
Point3d |
getPoint(String propertyName)
Gets the point value for the given property name.
|
String[] |
getPropertyNames()
Returns a list of all the property names
License requirements: None. |
PropertyList.PropertyType |
getPropertyType(int propertyIndex)
Returns the property type for the Indexed property list.
|
PropertyList.PropertyType |
getPropertyType(String propertyName)
Returns the property type for given property name
License requirements: None. |
String |
getString(int propertyIndex)
Gets the string value for the given index.
|
String |
getString(String propertyName)
Gets the string value for the given property name.
|
String[] |
getStrings(int propertyIndex)
Gets the strings value for the given index.
|
String[] |
getStrings(String propertyName)
Gets the strings value for the given property name.
|
TaggedObject |
getTaggedObject(int propertyIndex)
Gets the tagged object for the given index.
|
TaggedObject |
getTaggedObject(String propertyName)
Gets the tagged object for the given property name.
|
TaggedObject[] |
getTaggedObjectVector(int propertyIndex)
Gets the tagged object vector for the given index.
|
TaggedObject[] |
getTaggedObjectVector(String propertyName)
Gets the tagged object vector for the given property name.
|
UIBlock |
getUIBlock(int propertyIndex)
Gets the UI Block for the given index.
|
UIBlock |
getUIBlock(String propertyName)
Gets the UI Block for the given property name.
|
Vector3d |
getVector(int propertyIndex)
Gets the vector value for the given index.
|
Vector3d |
getVector(String propertyName)
Gets the vector value for the given property name.
|
int |
length()
Returns the length of the list
License requirements: None. |
PropertyList.ListMode |
mode()
Returns the mode of the list.
|
void |
setBits(String propertyName,
int bitsSc)
Sets the bits value for the given property name.
|
void |
setDouble(String propertyName,
double value)
Sets the double value for the given property name.
|
void |
setDoubleMatrix(String propertyName,
int nRows,
int nColumns,
double[] matrixValue)
Sets the double matrix for the given property name.
|
void |
setDoubleVector(String propertyName,
double[] doubleVector)
Sets the double vector for the given property name.
|
void |
setEnum(String propertyName,
int value)
Sets the value for the given property name.
|
void |
setEnumAsString(String propertyName,
String value)
Sets the value for the given property name.
|
void |
setEnumMembers(String propertyName,
String[] stringArray)
Sets the enum members for the given property of type enum.
|
void |
setFile(String propertyName,
String value)
Sets the value for the given property name.
|
void |
setInteger(String propertyName,
int value)
Sets the integer value for the given property name.
|
void |
setIntegerMatrix(String propertyName,
int nRows,
int nColumns,
int[] matrixValue)
Sets the integer matrix for the given property name.
|
void |
setIntegerVector(String propertyName,
int[] intVector)
Sets the integer vector for the given property name.
|
void |
setLogical(String propertyName,
boolean value)
Sets the logical value for the given property name.
|
void |
setPoint(String propertyName,
Point3d pointSc)
Sets the point value for the given property name.
|
void |
setSelectionFilter(String propertyName,
Selection.SelectionAction maskAction,
Selection.MaskTriple[] maskTriples)
Sets the filter for the given property name.
|
void |
setString(String propertyName,
String value)
Sets the string value for the given property name.
|
void |
setStrings(String propertyName,
String[] stringArray)
Sets the strings value for the given property name.
|
void |
setTaggedObject(String propertyName,
TaggedObject taggedSc)
Sets the tagged object for the given property name.
|
void |
setTaggedObjectVector(String propertyName,
TaggedObject[] tagVector)
Sets the tagged object vector for the given property name.
|
void |
setVector(String propertyName,
Vector3d vector)
Sets the vector value for the given property name.
|
_value, dispose, printTestData, printTestData
PropertyList.ListMode mode() throws NXException, RemoteException
NXException
RemoteException
int length() throws NXException, RemoteException
NXException
RemoteException
String[] getPropertyNames() throws NXException, RemoteException
NXException
RemoteException
PropertyList.PropertyType getPropertyType(String propertyName) throws NXException, RemoteException
propertyName
- Name of the propertyNXException
RemoteException
PropertyList.PropertyType getPropertyType(int propertyIndex) throws NXException, RemoteException
propertyIndex
- IndexNXException
RemoteException
void setInteger(String propertyName, int value) throws NXException, RemoteException
propertyName
- Name of the propertyvalue
- Value to set for given property nameNXException
RemoteException
int getInteger(String propertyName) throws NXException, RemoteException
propertyName
- Name of the propertyNXException
RemoteException
int getInteger(int propertyIndex) throws NXException, RemoteException
propertyIndex
- IndexNXException
RemoteException
void setLogical(String propertyName, boolean value) throws NXException, RemoteException
propertyName
- Name of the propertyvalue
- Value to set for given property name.NXException
RemoteException
boolean getLogical(String propertyName) throws NXException, RemoteException
propertyName
- Name of the propertyNXException
RemoteException
boolean getLogical(int propertyIndex) throws NXException, RemoteException
propertyIndex
- IndexNXException
RemoteException
void setDouble(String propertyName, double value) throws NXException, RemoteException
propertyName
- Name of the propertyvalue
- Value to set for given property name.NXException
RemoteException
double getDouble(String propertyName) throws NXException, RemoteException
propertyName
- Name of the propertyNXException
RemoteException
double getDouble(int propertyIndex) throws NXException, RemoteException
propertyIndex
- IndexNXException
RemoteException
void setString(String propertyName, String value) throws NXException, RemoteException
propertyName
- Name of the propertyvalue
- Value to set for given property name.NXException
RemoteException
String getString(String propertyName) throws NXException, RemoteException
propertyName
- Name of the propertyNXException
RemoteException
String getString(int propertyIndex) throws NXException, RemoteException
propertyIndex
- IndexNXException
RemoteException
void setEnumAsString(String propertyName, String value) throws NXException, RemoteException
propertyName
- Name of the propertyvalue
- Value to set for given property name.NXException
RemoteException
String getEnumAsString(String propertyName) throws NXException, RemoteException
propertyName
- Name of the propertyNXException
RemoteException
String getEnumAsString(int propertyIndex) throws NXException, RemoteException
propertyIndex
- indexNXException
RemoteException
void setEnum(String propertyName, int value) throws NXException, RemoteException
propertyName
- Name of the propertyvalue
- Value to set for given property name.NXException
RemoteException
int getEnum(String propertyName) throws NXException, RemoteException
propertyName
- Name of the propertyNXException
RemoteException
int getEnum(int propertyIndex) throws NXException, RemoteException
propertyIndex
- IndexNXException
RemoteException
void setEnumMembers(String propertyName, String[] stringArray) throws NXException, RemoteException
propertyName
- Name of the propertystringArray
- Value to set for given property name.NXException
RemoteException
String[] getEnumMembers(String propertyName) throws NXException, RemoteException
propertyName
- Name of the propertyNXException
RemoteException
String[] getEnumMembers(int propertyIndex) throws NXException, RemoteException
propertyIndex
- IndexNXException
RemoteException
void setStrings(String propertyName, String[] stringArray) throws NXException, RemoteException
propertyName
- Name of the propertystringArray
- Value to set for given property name.NXException
RemoteException
String[] getStrings(String propertyName) throws NXException, RemoteException
propertyName
- Name of the propertyNXException
RemoteException
String[] getStrings(int propertyIndex) throws NXException, RemoteException
propertyIndex
- IndexNXException
RemoteException
UIBlock getUIBlock(String propertyName) throws NXException, RemoteException
propertyName
- Name of the propertyNXException
RemoteException
UIBlock getUIBlock(int propertyIndex) throws NXException, RemoteException
propertyIndex
- IndexNXException
RemoteException
void setPoint(String propertyName, Point3d pointSc) throws NXException, RemoteException
propertyName
- Name of the propertypointSc
- Value to set for given property name.NXException
RemoteException
Point3d getPoint(String propertyName) throws NXException, RemoteException
propertyName
- Name of the propertyNXException
RemoteException
Point3d getPoint(int propertyIndex) throws NXException, RemoteException
propertyIndex
- IndexNXException
RemoteException
void setVector(String propertyName, Vector3d vector) throws NXException, RemoteException
propertyName
- Name of the propertyvector
- Value to set for given property name.NXException
RemoteException
Vector3d getVector(String propertyName) throws NXException, RemoteException
propertyName
- Name of the propertyNXException
RemoteException
Vector3d getVector(int propertyIndex) throws NXException, RemoteException
propertyIndex
- IndexNXException
RemoteException
void setBits(String propertyName, int bitsSc) throws NXException, RemoteException
propertyName
- Name of the propertybitsSc
- Value to set for given property name.NXException
RemoteException
int getBits(String propertyName) throws NXException, RemoteException
propertyName
- Name of the propertyNXException
RemoteException
int getBits(int propertyIndex) throws NXException, RemoteException
propertyIndex
- indexNXException
RemoteException
void setTaggedObject(String propertyName, TaggedObject taggedSc) throws NXException, RemoteException
propertyName
- Name of the propertytaggedSc
- Value to set for given property name.NXException
RemoteException
TaggedObject getTaggedObject(String propertyName) throws NXException, RemoteException
propertyName
- Name of the propertyNXException
RemoteException
TaggedObject getTaggedObject(int propertyIndex) throws NXException, RemoteException
propertyIndex
- IndexNXException
RemoteException
int[] getIntegerVector(String propertyName) throws NXException, RemoteException
propertyName
- Name of the propertyNXException
RemoteException
void setIntegerVector(String propertyName, int[] intVector) throws NXException, RemoteException
propertyName
- Name of the propertyintVector
- Value to set for given property name.NXException
RemoteException
int[] getIntegerVector(int propertyIndex) throws NXException, RemoteException
propertyIndex
- IndexNXException
RemoteException
double[] getDoubleVector(String propertyName) throws NXException, RemoteException
propertyName
- Name of the propertyNXException
RemoteException
void setDoubleVector(String propertyName, double[] doubleVector) throws NXException, RemoteException
propertyName
- Name of the propertydoubleVector
- Value to set for given property name.NXException
RemoteException
double[] getDoubleVector(int propertyIndex) throws NXException, RemoteException
propertyIndex
- IndexNXException
RemoteException
TaggedObject[] getTaggedObjectVector(String propertyName) throws NXException, RemoteException
propertyName
- Name of the propertyNXException
RemoteException
void setTaggedObjectVector(String propertyName, TaggedObject[] tagVector) throws NXException, RemoteException
propertyName
- Name of the propertytagVector
- Value to set for given property name.NXException
RemoteException
TaggedObject[] getTaggedObjectVector(int propertyIndex) throws NXException, RemoteException
propertyIndex
- IndexNXException
RemoteException
PropertyList.IntegerMatrixData getIntegerMatrix(String propertyName) throws NXException, RemoteException
propertyName
- Name of the propertyNXException
RemoteException
void setIntegerMatrix(String propertyName, int nRows, int nColumns, int[] matrixValue) throws NXException, RemoteException
propertyName
- Name of the propertynRows
- Number of Rows in the 2D matrixnColumns
- Number of Columns in the 2D matrixmatrixValue
- Value to set for given property name.NXException
RemoteException
PropertyList.IntegerMatrixData getIntegerMatrix(int propertyIndex) throws NXException, RemoteException
propertyIndex
- IndexNXException
RemoteException
PropertyList.DoubleMatrixData getDoubleMatrix(String propertyName) throws NXException, RemoteException
propertyName
- Name of the propertyNXException
RemoteException
void setDoubleMatrix(String propertyName, int nRows, int nColumns, double[] matrixValue) throws NXException, RemoteException
propertyName
- Name of the propertynRows
- Number of Rows in the 2D matrixnColumns
- Number of Columns in the 2D matrixmatrixValue
- Value to set for given property name.NXException
RemoteException
PropertyList.DoubleMatrixData getDoubleMatrix(int propertyIndex) throws NXException, RemoteException
propertyIndex
- IndexNXException
RemoteException
String getFile(String propertyName) throws NXException, RemoteException
propertyName
- Name of the propertyNXException
RemoteException
void setFile(String propertyName, String value) throws NXException, RemoteException
propertyName
- Name of the propertyvalue
- Value to set for given property name.NXException
RemoteException
String getFile(int propertyIndex) throws NXException, RemoteException
propertyIndex
- IndexNXException
RemoteException
PropertyList getArray(String propertyName) throws NXException, RemoteException
propertyName
- Name of the propertyNXException
RemoteException
PropertyList getArray(int propertyIndex) throws NXException, RemoteException
propertyIndex
- IndexNXException
RemoteException
void setSelectionFilter(String propertyName, Selection.SelectionAction maskAction, Selection.MaskTriple[] maskTriples) throws NXException, RemoteException
propertyName
- Name of the propertymaskAction
- Mask actionmaskTriples
- Mask triplesNXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.