aboutsummaryrefslogtreecommitdiffhomepage
path: root/tensorflow/g3doc/api_docs/cc/ClassStatus.md
blob: d5ef48b14d4b4f9eab7eb7647dad21f6aa09b298 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
#Class tensorflow::Status





##Member Summary

* [tensorflow::Status::Status](#tensorflow_Status_Status)
  * Create a success status.
* [tensorflow::Status::~Status](#tensorflow_Status_Status)
* [tensorflow::Status::Status](#tensorflow_Status_Status)
  * Create a status with the specified error code and msg as a human-readable string containing more detailed information.
* [tensorflow::Status::Status](#tensorflow_Status_Status)
  * Copy the specified status.
* [void tensorflow::Status::operator=](#void_tensorflow_Status_operator_)
* [bool tensorflow::Status::ok](#bool_tensorflow_Status_ok)
  * Returns true iff the status indicates success.
* [tensorflow::error::Code tensorflow::Status::code](#tensorflow_error_Code_tensorflow_Status_code)
* [const string& tensorflow::Status::error_message](#const_string_amp_tensorflow_Status_error_message)
* [bool tensorflow::Status::operator==](#bool_tensorflow_Status_operator_)
* [bool tensorflow::Status::operator!=](#bool_tensorflow_Status_operator_)
* [void tensorflow::Status::Update](#void_tensorflow_Status_Update)
  * If "ok()", stores "new_status" into *this. If "!ok()", preserves the current status, but may augment with additional information about "new_status".
* [string tensorflow::Status::ToString](#string_tensorflow_Status_ToString)
  * Return a string representation of this status suitable for printing. Returns the string "OK" for success.
* [static Status tensorflow::Status::OK](#static_Status_tensorflow_Status_OK)

##Member Details

#### tensorflow::Status::Status() {#tensorflow_Status_Status}

Create a success status.



#### tensorflow::Status::~Status() {#tensorflow_Status_Status}





#### tensorflow::Status::Status(tensorflow::error::Code code, tensorflow::StringPiece msg) {#tensorflow_Status_Status}

Create a status with the specified error code and msg as a human-readable string containing more detailed information.



#### tensorflow::Status::Status(const Status &s) {#tensorflow_Status_Status}

Copy the specified status.



#### void tensorflow::Status::operator=(const Status &s) {#void_tensorflow_Status_operator_}





#### bool tensorflow::Status::ok() const {#bool_tensorflow_Status_ok}

Returns true iff the status indicates success.



#### tensorflow::error::Code tensorflow::Status::code() const {#tensorflow_error_Code_tensorflow_Status_code}





#### const string& tensorflow::Status::error_message() const {#const_string_amp_tensorflow_Status_error_message}





#### bool tensorflow::Status::operator==(const Status &x) const {#bool_tensorflow_Status_operator_}





#### bool tensorflow::Status::operator!=(const Status &x) const {#bool_tensorflow_Status_operator_}





#### void tensorflow::Status::Update(const Status &new_status) {#void_tensorflow_Status_Update}

If "ok()", stores "new_status" into *this. If "!ok()", preserves the current status, but may augment with additional information about "new_status".

Convenient way of keeping track of the first error encountered. Instead of: if (overall_status.ok()) overall_status = new_status Use: overall_status.Update(new_status);

#### string tensorflow::Status::ToString() const {#string_tensorflow_Status_ToString}

Return a string representation of this status suitable for printing. Returns the string "OK" for success.



#### static Status tensorflow::Status::OK() {#static_Status_tensorflow_Status_OK}