This class stores a date and time. More...
Public Member Functions | |
| NXOpen::DateItemBuilder::DayOfMonth | Day () |
| Returns the day Created in NX8.0.0. More... | |
| NXOpen::DateItemBuilder::MonthOfYear | Month () |
| Returns the month Created in NX8.0.0. More... | |
| void | SetDay (NXOpen::DateItemBuilder::DayOfMonth day) |
| Sets the day Created in NX8.0.0. More... | |
| void | SetMonth (NXOpen::DateItemBuilder::MonthOfYear month) |
| Sets the month Created in NX8.0.0. More... | |
| void | SetTime (const NXString &time) |
| Sets the time. More... | |
| void | SetTime (const char *time) |
| Sets the time. More... | |
| void | SetYear (const NXString &year) |
| Sets the year. More... | |
| void | SetYear (const char *year) |
| Sets the year. More... | |
| NXString | Time () |
| Returns the time. More... | |
| virtual bool | Validate () |
| Validate whether the inputs to the component are sufficient for commit to be called. More... | |
| NXString | Year () |
| Returns the year. More... | |
 Public Member Functions inherited from NXOpen::TaggedObject | |
| tag_t | Tag () const |
| Returns the tag of this object. More... | |
Detailed Description
This class stores a date and time.
The class does verify that the year string and time string are in a valid format. The first date supported is 2-Jan-1900 00:00:00 UTC and the last date supported is 31st-Dec-9999 00:00:00 UTC. Though note that the time input is in local time and converted to UTC internally.
NOTE: The class does NOT verify that the combination of day, month, year and time is valid.
To create a new instance of this class, use NXOpen::DateBuilder::CreateDateItemBuilder
Created in NX8.0.0.
Member Enumeration Documentation
Days of the month.
Member Function Documentation
| NXOpen::DateItemBuilder::DayOfMonth NXOpen::DateItemBuilder::Day | ( | ) |
Returns the day
Created in NX8.0.0.
License requirements : None
| NXOpen::DateItemBuilder::MonthOfYear NXOpen::DateItemBuilder::Month | ( | ) |
Returns the month
Created in NX8.0.0.
License requirements : None
| void NXOpen::DateItemBuilder::SetDay | ( | NXOpen::DateItemBuilder::DayOfMonth | day | ) |
Sets the day
Created in NX8.0.0.
License requirements : None
- Parameters
-
day day
| void NXOpen::DateItemBuilder::SetMonth | ( | NXOpen::DateItemBuilder::MonthOfYear | month | ) |
Sets the month
Created in NX8.0.0.
License requirements : None
- Parameters
-
month month
| void NXOpen::DateItemBuilder::SetTime | ( | const NXString & | time | ) |
Sets the time.
The time string is a 24-hour clock time in the format HH:MM:SS or HH:MM. The string can also be empty.
Created in NX8.0.0.
License requirements : None
- Parameters
-
time time
| void NXOpen::DateItemBuilder::SetTime | ( | const char * | time | ) |
Sets the time.
The time string is a 24-hour clock time in the format HH:MM:SS or HH:MM. The string can also be empty.
Created in NX8.0.0.
License requirements : None
- Parameters
-
time time
| void NXOpen::DateItemBuilder::SetYear | ( | const NXString & | year | ) |
Sets the year.
The year string is four characters long and represents an integer within the range minimum year and maximum year (inclusive). The year can also be an empty string.
Created in NX8.0.0.
License requirements : None
- Parameters
-
year year
| void NXOpen::DateItemBuilder::SetYear | ( | const char * | year | ) |
Sets the year.
The year string is four characters long and represents an integer within the range minimum year and maximum year (inclusive). The year can also be an empty string.
Created in NX8.0.0.
License requirements : None
- Parameters
-
year year
| NXString NXOpen::DateItemBuilder::Time | ( | ) |
Returns the time.
The time string is a 24-hour clock time in the format HH:MM:SS or HH:MM. The string can also be empty.
Created in NX8.0.0.
License requirements : None
|
virtual |
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.
- Returns
- Was self validation successful
Created in NX3.0.1.
License requirements : None
Implements NXOpen::GeometricUtilities::IComponentBuilder.
| NXString NXOpen::DateItemBuilder::Year | ( | ) |
Returns the year.
The year string is four characters long and represents an integer within the range minimum year and maximum year (inclusive). The year can also be an empty string.
Created in NX8.0.0.
License requirements : None
The documentation for this class was generated from the following file:
- DateItemBuilder.hxx