DateBuilder Class¶
-
class
NXOpen.
DateBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
The DateBuilder class allows a date and/or time to be input or output via the DateItem builder.
The FromDateItem and ToDateItem builders allow a From and To date to be input and output. The class does not verify that the From date is earlier than the To date.
The DateBuilder is also used to create a
NXOpen.DateItemBuilder
object that is contained in the DateItemBuilderList.New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
DateItem | Returns a NXOpen.DateItemBuilder object used for simple date and time storage. |
DateItemList | Returns a list of NXOpen.DateItemBuilder objects used to store a list of dates and times. |
FromDateItem | Returns a NXOpen.DateItemBuilder object used for simple date and time storage. |
Tag | Returns the Tag for this object. |
ToDateItem | Returns a NXOpen.DateItemBuilder object used for simple date and time storage. |
Methods¶
Method | Description |
---|---|
CreateDateItemBuilder | Create a NXOpen.DateItemBuilder object that can be stored in the DateItemList. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
DateItem¶
-
DateBuilder.
DateItem
¶ Returns a
NXOpen.DateItemBuilder
object used for simple date and time storage.-------------------------------------
Getter Method
Signature
DateItem
Returns: Return type: NXOpen.DateItemBuilder
New in version NX8.0.0.
License requirements: None.
DateItemList¶
-
DateBuilder.
DateItemList
¶ Returns a list of
NXOpen.DateItemBuilder
objects used to store a list of dates and times.-------------------------------------
Getter Method
Signature
DateItemList
Returns: Return type: NXOpen.DateItemBuilderList
New in version NX8.0.0.
License requirements: None.
FromDateItem¶
-
DateBuilder.
FromDateItem
¶ Returns a
NXOpen.DateItemBuilder
object used for simple date and time storage.This is the From date in a From-To range.
-------------------------------------
Getter Method
Signature
FromDateItem
Returns: Return type: NXOpen.DateItemBuilder
New in version NX8.0.0.
License requirements: None.
ToDateItem¶
-
DateBuilder.
ToDateItem
¶ Returns a
NXOpen.DateItemBuilder
object used for simple date and time storage.This is the To date in a From-To range.
-------------------------------------
Getter Method
Signature
ToDateItem
Returns: Return type: NXOpen.DateItemBuilder
New in version NX8.0.0.
License requirements: None.
Method Detail¶
CreateDateItemBuilder¶
-
DateBuilder.
CreateDateItemBuilder
¶ Create a
NXOpen.DateItemBuilder
object that can be stored in the DateItemList.Signature
CreateDateItemBuilder()
Returns: New DateItemBuilder object Return type: NXOpen.DateItemBuilder
New in version NX8.0.0.
License requirements: None.
Validate¶
-
DateBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.